PropertyHandler (Diffusion)

Deprecated.
since 6.4
The Diffusion Publisher API is deprecated and will be removed in a future release.
```
@Deprecated
public interface PropertyHandler
```
A Property Handler provides an interface to a set of properties.
Such properties are typically loaded from a properties file.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`getBooleanProperty(String key)` Deprecated. Gets the value of a boolean property.
`int`	`getBytesProperty(String key)` Deprecated. Converts a size into bytes.
`int`	`getBytesProperty(String key, int defaultValue)` Deprecated. Converts a size into bytes.
`double`	`getDoubleProperty(String key)` Deprecated. Get a double property.
`int`	`getIntegerProperty(String key)` Deprecated. Get an integer property.
`int`	`getIntegerProperty(String key, int defaultValue)` Deprecated. Get an integer property if it exists otherwise return a default value.
`List<String>`	`getListProperty(String key)` Deprecated. Gets the value of a list property.
`long`	`getLongProperty(String key)` Deprecated. Get a long property.
`long`	`getLongProperty(String key, long defaultValue)` Deprecated. Get an long property if it exists otherwise return a default value.
`String`	`getMandatoryProperty(String key)` Deprecated. Get a mandatory property.
`long`	`getMillisProperty(String key)` Deprecated. Converts a time into milliseconds.
`long`	`getMillisProperty(String key, long defaultValue)` Deprecated. Converts a time into milliseconds.
`String`	`getProperty(String key)` Deprecated. Get a property.
`String`	`getProperty(String key, String defaultValue)` Deprecated. Get a property if it exists otherwise return a default value.
`String`	`getProperty(String key, String defaultValue, String... allowedValues)` Deprecated. Get a property if it exists and validate it against a set of allowed values.
`Set<String>`	`getSetProperty(String key)` Deprecated. Gets the value of a set property.
`boolean`	`hasProperties()` Deprecated. Test to see if there are any properties.
`boolean`	`propertyExists(String key)` Deprecated. Indicates whether a value for a particular property exists.
`void`	`setProperty(String key, String value)` Deprecated. Sets a property value.

- Method Detail
  - propertyExists
```
boolean propertyExists(String key)
```
    Deprecated.
    
    Indicates whether a value for a particular property exists.
    
    Parameters:
    
    key - the property key.
    
    Returns:
    
    true if the property value exists and is not zero length or whitespace, false if the property does not exist or is zero length or whitespace.
  - getProperty
```
String getProperty(String key)
```
    Deprecated.
    
    Get a property.
    
    Parameters:
    
    key - the property key.
    
    Returns:
    
    the property value or null if the property was not found or is zero length or whitespace.
  - getProperty
```
String getProperty(String key,
                   String defaultValue)
```
    Deprecated.
    
    Get a property if it exists otherwise return a default value.
    
    Parameters:
    
    key - the property key.
    
    defaultValue - the default value to return if the property is not declared.
    
    Returns:
    
    the property value or the default value if the property is not declared.
  - getProperty
```
String getProperty(String key,
                   String defaultValue,
                   String... allowedValues)
            throws PropertyException
```
    Deprecated.
    
    Get a property if it exists and validate it against a set of allowed values.
    If the property does not exist then a default value is returned.
    
    Parameters:
    
    key - the property key.
    
    defaultValue - the default value to return if the property is not declared.
    
    allowedValues - a list of permitted values. If this list is not supplied then any value would be permitted. The case of the values is not significant and thus any of the values is permitted in any case.
    
    Returns:
    
    the property value or the default value if the property is not declared. Note that even though case is ignored in validation the property values is returned 'as is' and the caller may want to homogenise the case of the returned value before checking it.
    
    Throws:
    
    PropertyException - if the property existed but was not equal to one of the allowed values.
  - getMandatoryProperty
```
String getMandatoryProperty(String key)
                     throws PropertyException
```
    Deprecated.
    
    Get a mandatory property.
    
    Parameters:
    
    key - the property key.
    
    Returns:
    
    the property value.
    
    Throws:
    
    PropertyException - is the property is not declared.
  - setProperty
```
void setProperty(String key,
                 String value)
```
    Deprecated.
    
    Sets a property value.
    
    Parameters:
    
    key - the property key
    
    value - the property value
  - getIntegerProperty
```
int getIntegerProperty(String key)
                throws PropertyException
```
    Deprecated.
    
    Get an integer property.
    
    Parameters:
    
    key - the property key.
    
    Returns:
    
    the property value.
    
    Throws:
    
    PropertyException - if the property does not exist, is zero length or whitespace, or is not a valid integer value.
  - getIntegerProperty
```
int getIntegerProperty(String key,
                       int defaultValue)
                throws PropertyException
```
    Deprecated.
    
    Get an integer property if it exists otherwise return a default value.
    
    Parameters:
    
    key - the property key.
    
    defaultValue - the value to return if the property does not exist.
    
    Returns:
    
    the property value or the default value if the property did not exist.
    
    Throws:
    
    PropertyException - if the property did exist but was not a valid integer value.
  - getLongProperty
```
long getLongProperty(String key)
              throws PropertyException
```
    Deprecated.
    
    Get a long property.
    
    Parameters:
    
    key - the property key.
    
    Returns:
    
    the property value.
    
    Throws:
    
    PropertyException - if the property does not exist, is zero length or whitespace, or is not a valid long value.
  - getDoubleProperty
```
double getDoubleProperty(String key)
                  throws PropertyException
```
    Deprecated.
    
    Get a double property.
    
    Parameters:
    
    key - the property key.
    
    Returns:
    
    the property value.
    
    Throws:
    
    PropertyException - if the property does not exist, is zero length or whitespace, or is not a valid double value.
  - getLongProperty
```
long getLongProperty(String key,
                     long defaultValue)
              throws PropertyException
```
    Deprecated.
    
    Get an long property if it exists otherwise return a default value.
    
    Parameters:
    
    key - the property key.
    
    defaultValue - the value to return if the property does not exist.
    
    Returns:
    
    the property value or the default value if the property did not exist.
    
    Throws:
    
    PropertyException - if the property did exist but was not a valid long value.
  - getListProperty
```
List<String> getListProperty(String key)
```
    Deprecated.
    
    Gets the value of a list property.
    A list property is interpreted as a list of values separated by '&' characters.
    If you wish to eliminate duplicates from a list then use getSetProperty(String).
    
    Parameters:
    
    key - the property key.
    
    Returns:
    
    the list of property values. If the property did not exist or was zero length or whitespace then an empty list will be returned.
  - getSetProperty
```
Set<String> getSetProperty(String key)
```
    Deprecated.
    
    Gets the value of a set property.
    A set property is interpreted as a list of values separated by '&' characters. This differs from a list property in that because a set is returned, duplicates are removed. The set order is the same as the list within the properties.
    
    Parameters:
    
    key - the property key.
    
    Returns:
    
    the set of property values. If the property did not exist or was zero length or whitespace then an empty set will be returned.
  - getBooleanProperty
```
boolean getBooleanProperty(String key)
```
    Deprecated.
    
    Gets the value of a boolean property.
    
    Parameters:
    
    key - the property key.
    
    Returns:
    
    true if the property value is 'true' (in any case) or false if the property does not exist or is set to any other value.
  - getBytesProperty
```
int getBytesProperty(String key)
              throws PropertyException
```
    Deprecated.
    
    Converts a size into bytes. Append the letter k or K to indicate kilobytes, or m or M to indicate megabytes. Examples: 6291456 6144k 6m
    
    Parameters:
    
    key - the property key.
    
    Returns:
    
    the number representation in bytes
    
    Throws:
    
    PropertyException - if the named property can not be converted into a bytes value
  - getBytesProperty
```
int getBytesProperty(String key,
                     int defaultValue)
              throws PropertyException
```
    Deprecated.
    
    Converts a size into bytes. Append the letter k or K to indicate kilobytes, or m or M to indicate megabytes. Examples: 6291456 6144k 6m
    
    Parameters:
    
    key - the property key.
    
    defaultValue - the value to return if the property does not exist
    
    Returns:
    
    the number representation in bytes, or the number can't be parsed
    
    Throws:
    
    PropertyException - if the specified property value can not be converted into a bytes value
  - getMillisProperty
```
long getMillisProperty(String key)
                throws PropertyException
```
    Deprecated.
    
    Converts a time into milliseconds. Append the letter h or H to indicate hours, or m or M to indicate minutes or s or S to indicate seconds
    
    Parameters:
    
    key - the property key.
    
    Returns:
    
    the time representation in milliseconds
    
    Throws:
    
    PropertyException - if the specified property can not be converted into a milliseconds value
  - getMillisProperty
```
long getMillisProperty(String key,
                       long defaultValue)
                throws PropertyException
```
    Deprecated.
    
    Converts a time into milliseconds. Append the letter h or H to indicate hours, or m or M to indicate minutes or s or S to indicate seconds
    
    Parameters:
    
    key - the property key.
    
    defaultValue - the value to return if the property does not exist
    
    Returns:
    
    the time representation in milliseconds, or the default value if the number can't be parsed
    
    Throws:
    
    PropertyException - if the specified property can not be converted into a milliseconds value
  - hasProperties
```
boolean hasProperties()
```
    Deprecated.
    
    Test to see if there are any properties.
    
    Returns:
    
    true, if the properties has entries

Interface PropertyHandler

Method Summary

Method Detail

propertyExists

getProperty

getProperty

getProperty

getMandatoryProperty

setProperty

getIntegerProperty

getIntegerProperty

getLongProperty

getDoubleProperty

getLongProperty

getListProperty

getSetProperty

getBooleanProperty

getBytesProperty

getBytesProperty

getMillisProperty

getMillisProperty

hasProperties