DuccProperties (Apache UIMA DUCC: uima-ducc-common 2.2.1 API)

java.lang.Object
- java.util.Dictionary<K,V>
- - java.util.Hashtable<Object,Object>
  - - java.util.Properties
    - - org.apache.uima.ducc.common.utils.DuccProperties

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>
```
public class DuccProperties
extends Properties
```
See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String AGENT_BROKER_URL

static String AGENT_ENDPOINT

static String AGENT_LOG_DIR

protected boolean resolvePlaceholders
- Fields inherited from class java.util.Properties
  defaults

Fields
Modifier and Type	Field and Description
`static String`	`AGENT_BROKER_URL`
`static String`	`AGENT_ENDPOINT`
`static String`	`AGENT_LOG_DIR`
`protected boolean`	`resolvePlaceholders`

Constructor Summary

Constructors
Constructor and Description
`DuccProperties()` Null constructor now requried because we have a non-null constructor below.
`DuccProperties(Properties p)` Convert a run-of-the-mill properties object into a handsome DuccProperties

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`getBooleanProperty(String k, boolean dflt)`
`double`	`getDoubleProperty(String k)` Get the property, trim junk off the end, and try to convert to double.
`double`	`getDoubleProperty(String k, double dflt)` Get the property, trim junk off the end, and try to convert to double.
`int`	`getIntProperty(String k)` Get the property, trim junk off the end, and try to convert to int.
`int`	`getIntProperty(String k, int dflt)` Get the property, trim junk off the end, and try to convert to int.
`long`	`getLongProperty(String k)` Get the property, trim junk off the end, and try to convert to int.
`double`	`getLongProperty(String k, double dflt)` Get the property, trim junk off the end, and try to convert to double.
`long`	`getLongProperty(String k, long dflt)` Get the property, trim junk off the end, and try to convert to int.
`String`	`getProperty(String k)`
`String`	`getStringProperty(String k)` Get the property, trim junk off the end and return it.
`String`	`getStringProperty(String k, String dflt)` Get the property, trim junk off the end and return it.
`void`	`ignorePlaceholders()` Disable place-holder resolution when already done and any unresolved entries have been left as-is for later substitution, e.g.
`void`	`load()`
`void`	`load(String agentPropertyFile)`

Methods inherited from class java.util.Properties
getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable
clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - AGENT_LOG_DIR
```
public static final String AGENT_LOG_DIR
```
    See Also:
    Constant Field Values
  - AGENT_BROKER_URL
```
public static final String AGENT_BROKER_URL
```
    See Also:
    Constant Field Values
  - AGENT_ENDPOINT
```
public static final String AGENT_ENDPOINT
```
    See Also:
    Constant Field Values
  - resolvePlaceholders
```
protected boolean resolvePlaceholders
```
- Constructor Detail
  - DuccProperties
```
public DuccProperties()
```
    Null constructor now requried because we have a non-null constructor below.
  - DuccProperties
```
public DuccProperties(Properties p)
```
    Convert a run-of-the-mill properties object into a handsome DuccProperties
- Method Detail
  - load
```
public void load()
          throws Exception
```
    Throws:
    
    Exception
  - getIntProperty
```
public int getIntProperty(String k)
```
    Get the property, trim junk off the end, and try to convert to int.
    
    Parameters:
    The - name of the property to look for.
    
    Throws:
    
    MissingPropertyException - if the property does not exist.
    
    NumberFormattingException - if the property cannot be converted to a number.
  - getIntProperty
```
public int getIntProperty(String k,
                 int dflt)
```
    Get the property, trim junk off the end, and try to convert to int. If the property cannot be found, return the default instead.
    
    Parameters:
    The - name of the property to look for.
    
    Throws:
    
    MissingPropertyException - if the property does not exist.
    
    NumberFormattingException - if the property cannot be converted to a number.
  - getLongProperty
```
public long getLongProperty(String k)
```
    Get the property, trim junk off the end, and try to convert to int.
    
    Parameters:
    The - name of the property to look for.
    
    Throws:
    
    MissingPropertyException - if the property does not exist.
    
    NumberFormattingException - if the property cannot be converted to a number.
  - getLongProperty
```
public long getLongProperty(String k,
                   long dflt)
```
    Get the property, trim junk off the end, and try to convert to int. If the property cannot be found, return the default instead.
    
    Parameters:
    The - name of the property to look for.
    
    Throws:
    
    MissingPropertyException - if the property does not exist.
    
    NumberFormattingException - if the property cannot be converted to a number.
  - getDoubleProperty
```
public double getDoubleProperty(String k)
```
    Get the property, trim junk off the end, and try to convert to double.
    
    Parameters:
    The - name of the property to look for.
    
    Throws:
    
    MissingPropertyException - if the property does not exist.
    
    NumberFormattingException - if the property cannot be converted to a number.
  - getDoubleProperty
```
public double getDoubleProperty(String k,
                       double dflt)
```
    Get the property, trim junk off the end, and try to convert to double. If the property cannot be found, return the default instead.
    
    Parameters:
    The - name of the property to look for.
    
    Throws:
    
    MissingPropertyException - if the property does not exist.
    
    NumberFormattingException - if the property cannot be converted to a number.
  - getLongProperty
```
public double getLongProperty(String k,
                     double dflt)
```
    Get the property, trim junk off the end, and try to convert to double. If the property cannot be found, return the default instead.
    
    Parameters:
    The - name of the property to look for.
    
    Throws:
    
    MissingPropertyException - if the property does not exist.
    
    NumberFormattingException - if the property cannot be converted to a number.
  - getStringProperty
```
public String getStringProperty(String k)
```
    Get the property, trim junk off the end and return it. If you want the junk, just use getProperty().
    
    Parameters:
    The - name of the property to look for.
    
    Throws:
    
    MissingPropertyException - if the property does not exist.
  - getStringProperty
```
public String getStringProperty(String k,
                       String dflt)
```
    Get the property, trim junk off the end and return it. If the default is not found, then return the provided default. If you want the junk, just use getProperty().
    
    Parameters:
    The - name of the property to look for.
    
    Throws:
    
    MissingPropertyException - if the property does not exist.
  - getBooleanProperty
```
public boolean getBooleanProperty(String k,
                         boolean dflt)
```
  - getProperty
```
public String getProperty(String k)
```
    Overrides:
    
    getProperty in class Properties
  - load
```
public void load(String agentPropertyFile)
          throws Exception
```
    Throws:
    
    Exception
  - ignorePlaceholders
```
public void ignorePlaceholders()
```
    Disable place-holder resolution when already done and any unresolved entries have been left as-is for later substitution, e.g. DUCC_SERVICE_INSTANCE, DUCC_OS_ARCH

Class DuccProperties

Field Summary

Fields inherited from class java.util.Properties

Constructor Summary

Method Summary

Methods inherited from class java.util.Properties

Methods inherited from class java.util.Hashtable

Methods inherited from class java.lang.Object

Field Detail

AGENT_LOG_DIR

AGENT_BROKER_URL

AGENT_ENDPOINT

resolvePlaceholders

Constructor Detail

DuccProperties

DuccProperties

Method Detail

load

getIntProperty

getIntProperty

getLongProperty

getLongProperty

getDoubleProperty

getDoubleProperty

getLongProperty

getStringProperty

getStringProperty

getBooleanProperty

getProperty

load

ignorePlaceholders