ConfigurationDataHelper (org.eclipse.scada 0.4.0 API)

java.lang.Object
- org.eclipse.scada.ca.ConfigurationDataHelper

public class ConfigurationDataHelper
extends Object

Constructor Summary

Constructors
Constructor and Description

ConfigurationDataHelper(Map<String,String> parameters)

Constructors
Constructor and Description
`ConfigurationDataHelper(Map<String,String> parameters)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,Map<String,String>>`	`getAggregated(Pattern pattern)` Scan by prefix and aggregate by the remainder
`Boolean`	`getBoolean(String name)` Get a boolean from the data or `null` if the parameter is not set or not a boolean
`boolean`	`getBoolean(String name, boolean defaultValue)` Get a boolean from the data or the default value if the parameter is not set or not a boolean
`boolean`	`getBooleanChecked(String name, String errorMessage)`
`Map<String,String>`	`getData()` The actual configuration data
`Double`	`getDouble(String name)` Get an integer from the data or `null` if the parameter is not set or not an integer
`double`	`getDouble(String name, double defaultValue)` Get an integer from the data or the default value if the parameter is not set or not an integer
`double`	`getDoubleChecked(String name, String errorMessage)` Get an integer from the configuration data
`<E extends Enum<E>> E`	`getEnum(String name, Class<E> enumType)`
`<E extends Enum<E>> E`	`getEnum(String name, Class<E> enumType, E defaultValue)`
`<E extends Enum<E>> E`	`getEnumChecked(String name, Class<E> enumType, String errorMessage)`
`Integer`	`getInteger(String name)` Get an integer from the data or `null` if the parameter is not set or not an integer
`int`	`getInteger(String name, int defaultValue)` Get an integer from the data or the default value if the parameter is not set or not an integer
`int`	`getIntegerChecked(String name, String errorMessage)` Get an integer from the configuration data
`Long`	`getLong(String name)` Get a long from the data or `null` if the parameter is not set or not a long
`long`	`getLong(String name, long defaultValue)` Get a long from the data or the default value if the parameter is not set or not a long
`long`	`getLongChecked(String name, String errorMessage)` Get a long from the configuration data
`Map<String,String>`	`getPrefixed(String prefix)` Extracts attributes that start with a prefix and return the matching entries only with the key truncated by the prefix.
`ConfigurationDataHelper`	`getPrefixedHelper(String prefix)` Create a configuration data helper containing only the parameters having the provided prefix, including their prefix removed.
`Properties`	`getPrefixedProperties(String prefix)` Convenience method to get prefixed attributes as `Properties` object
`String`	`getString(String name)` Get a string from the configuration
`String`	`getString(String name, String defaultValue)`
`String`	`getStringChecked(String name, String errorMessage)` Get a string from the configuration data
`String`	`getStringNonEmpty(String name)` Get a non-empty string from the configuration.
`String`	`getStringNonEmptyChecked(String name, String errorMessage)` Get a non-null, non-empty string from the configuration data
`String`	`getStringOfChecked(String name, Collection<String> whitelisted)` Get a whitelisted string from the configuration data
`String`	`getStringOfChecked(String name, String defaultValue, Collection<String> whitelisted)` Get a whitelisted string from the configuration data
`Set<String>`	`getStringSet(String prefix)` Get all values of the keys that start with a specific prefix
`TimeZone`	`getTimeZone(String name, TimeZone defaultValue)` Return the time zone Note: The method internally calls `TimeZone.getTimeZone(String)` in order to convert the configured string to the actual time zone.
`Variant`	`getVariant(String name)` Get an variant from the data or `null` if the parameter is not set or not an variant
`Variant`	`getVariant(String name, Variant defaultValue)` Get an variant from the data or the default value if the parameter is not set or not an variant
`Variant`	`getVariantChecked(String name, String errorMessage)`
`static <E extends Enum<E>> E`	`makeEnum(Class<E> enumType, E defaultValue, String stringValue, boolean ignoreMissing)`
`protected static <E extends Enum<E>> String`	`makeEnumError(Class<E> enumType, String stringValue)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ConfigurationDataHelper
```
public ConfigurationDataHelper(Map<String,String> parameters)
```
- Method Detail
  - getData
```
public Map<String,String> getData()
```
    The actual configuration data
    
    Returns:
    
    the configuration data
  - getInteger
```
public Integer getInteger(String name)
```
    Get an integer from the data or null if the parameter is not set or not an integer
    
    Parameters:
    
    name - the name of the parameter
    
    Returns:
    
    the integer or null
  - getInteger
```
public int getInteger(String name,
                      int defaultValue)
```
    Get an integer from the data or the default value if the parameter is not set or not an integer
    
    Parameters:
    
    name - the name of the parameter
    
    defaultValue - the default value
    
    Returns:
    
    the integer or the default value
  - getIntegerChecked
```
public int getIntegerChecked(String name,
                             String errorMessage)
                      throws IllegalArgumentException,
                             NumberFormatException
```
    Get an integer from the configuration data
    If the parameter is not set a IllegalArgumentException will be thrown. If the data can not be parsed to an integer a NumberFormatException will be thrown.
    
    Parameters:
    
    name - the name of the parameter to get
    
    errorMessage - the error message if the string is not set
    
    Returns:
    
    the value as integer
    
    Throws:
    
    NumberFormatException
    
    IllegalArgumentException
  - getLong
```
public Long getLong(String name)
```
    Get a long from the data or null if the parameter is not set or not a long
    
    Parameters:
    
    name - the name of the parameter
    
    Returns:
    
    the long or null
  - getLong
```
public long getLong(String name,
                    long defaultValue)
```
    Get a long from the data or the default value if the parameter is not set or not a long
    
    Parameters:
    
    name - the name of the parameter
    
    defaultValue - the default value
    
    Returns:
    
    the long or the default value
  - getLongChecked
```
public long getLongChecked(String name,
                           String errorMessage)
                    throws IllegalArgumentException,
                           NumberFormatException
```
    Get a long from the configuration data
    If the parameter is not set a IllegalArgumentException will be thrown. If the data can not be parsed to a long a NumberFormatException will be thrown.
    
    Parameters:
    
    name - the name of the parameter to get
    
    errorMessage - the error message if the string is not set
    
    Returns:
    
    the value as long
    
    Throws:
    
    NumberFormatException
    
    IllegalArgumentException
  - getStringNonEmpty
```
public String getStringNonEmpty(String name)
```
    Get a non-empty string from the configuration.
    
    Parameters:
    
    name - the name of the parameters to get
    
    Returns:
    
    returns null if the parameter is not set or is an empty string. Otherwise the string itself will be returned.
  - getString
```
public String getString(String name)
```
    Get a string from the configuration
    
    Parameters:
    
    name - the name of the string to get
    
    Returns:
    
    the string data or null if the string was not set
  - getString
```
public String getString(String name,
                        String defaultValue)
```
  - getStringChecked
```
public String getStringChecked(String name,
                               String errorMessage)
                        throws IllegalArgumentException
```
    Get a string from the configuration data
    
    Parameters:
    
    name - the name of the parameter to get
    
    errorMessage - the error message if the string is not set
    
    Returns:
    
    the string data
    
    Throws:
    
    IllegalArgumentException - if the string is not set
  - getStringNonEmptyChecked
```
public String getStringNonEmptyChecked(String name,
                                       String errorMessage)
                                throws IllegalArgumentException
```
    Get a non-null, non-empty string from the configuration data
    
    Parameters:
    
    name - the name of the parameter to get
    
    errorMessage - the error message if the string is not set or empty
    
    Returns:
    
    a not-null, non-empty string
    
    Throws:
    
    IllegalArgumentException - if the string is not set or is empty
  - getStringOfChecked
```
public String getStringOfChecked(String name,
                                 Collection<String> whitelisted)
                          throws IllegalArgumentException
```
    Get a whitelisted string from the configuration data
    
    Parameters:
    
    name - the name of the parameter to get
    
    whitelist - the list of allowed values
    
    Returns:
    
    the string data
    
    Throws:
    
    IllegalArgumentException - if the string is not set
  - getStringOfChecked
```
public String getStringOfChecked(String name,
                                 String defaultValue,
                                 Collection<String> whitelisted)
                          throws IllegalArgumentException
```
    Get a whitelisted string from the configuration data
    
    Parameters:
    
    name - the name of the parameter to get
    
    defaultValue - the default value
    
    whitelist - the list of allowed values
    
    Returns:
    
    the string data
    
    Throws:
    
    IllegalArgumentException - if the string is not set
  - getStringSet
```
public Set<String> getStringSet(String prefix)
```
    Get all values of the keys that start with a specific prefix
    
    Parameters:
    
    prefix - the prefix
    
    Returns:
    
    the set of values, never null
  - getDouble
```
public Double getDouble(String name)
```
    Get an integer from the data or null if the parameter is not set or not an integer
    
    Parameters:
    
    name - the name of the parameter
    
    Returns:
    
    the integer or null
  - getDouble
```
public double getDouble(String name,
                        double defaultValue)
```
    Get an integer from the data or the default value if the parameter is not set or not an integer
    
    Parameters:
    
    name - the name of the parameter
    
    defaultValue - the default value
    
    Returns:
    
    the integer or the default value
  - getDoubleChecked
```
public double getDoubleChecked(String name,
                               String errorMessage)
                        throws IllegalArgumentException,
                               NumberFormatException
```
    Get an integer from the configuration data
    If the parameter is not set a IllegalArgumentException will be thrown. If the data can not be parsed to an integer a NumberFormatException will be thrown.
    
    Parameters:
    
    name - the name of the parameter to get
    
    errorMessage - the error message if the string is not set
    
    Returns:
    
    the value as integer
    
    Throws:
    
    NumberFormatException
    
    IllegalArgumentException
  - getBooleanChecked
```
public boolean getBooleanChecked(String name,
                                 String errorMessage)
```
  - getBoolean
```
public Boolean getBoolean(String name)
```
    Get a boolean from the data or null if the parameter is not set or not a boolean
    
    Parameters:
    
    name - the name of the parameter
    
    Returns:
    
    the boolean or null
  - getBoolean
```
public boolean getBoolean(String name,
                          boolean defaultValue)
```
    Get a boolean from the data or the default value if the parameter is not set or not a boolean
    
    Parameters:
    
    name - the name of the parameter
    
    defaultValue - the default value
    
    Returns:
    
    the boolean or the default value
  - getVariant
```
public Variant getVariant(String name)
```
    Get an variant from the data or null if the parameter is not set or not an variant
    
    Parameters:
    
    name - the name of the parameter
    
    Returns:
    
    the variant or null
  - getVariant
```
public Variant getVariant(String name,
                          Variant defaultValue)
```
    Get an variant from the data or the default value if the parameter is not set or not an variant
    
    Parameters:
    
    name - the name of the parameter
    
    defaultValue - the default value
    
    Returns:
    
    the variant or the default value
  - getVariantChecked
```
public Variant getVariantChecked(String name,
                                 String errorMessage)
                          throws IllegalArgumentException
```
    Throws:
    
    IllegalArgumentException
  - getPrefixed
```
public Map<String,String> getPrefixed(String prefix)
```
    Extracts attributes that start with a prefix and return the matching entries only with the key truncated by the prefix.
    If you want your prefix to be "prefix." you must also add the dot.
    
    Parameters:
    
    prefix - the prefix to use
    
    Returns:
    
    the result map
  - getPrefixedHelper
```
public ConfigurationDataHelper getPrefixedHelper(String prefix)
```
    Create a configuration data helper containing only the parameters having the provided prefix, including their prefix removed.
    
    Parameters:
    
    prefix - the prefix
    
    Returns:
    
    the new set of data
    
    See Also:
    
    getPrefixed(String)
  - getPrefixedProperties
```
public Properties getPrefixedProperties(String prefix)
```
    Convenience method to get prefixed attributes as Properties object
    Actually calls getPrefixed(String)
    
    Parameters:
    
    prefix - the prefix to use
    
    Returns:
    
    the result properties
  - getAggregated
```
public Map<String,Map<String,String>> getAggregated(Pattern pattern)
```
    Scan by prefix and aggregate by the remainder
    
    This will aggregate from:
    
    a=b c=d entry.group1=foo entry.group1.a=value1 entry.group1.b=value2 entry.group2.a=value3 entry.group2.c=value4
    
    Using the pattern "entry\\.(?)\\.(?)". To:
    
    group1 = { a=value1 b=value2 } group2 = { a=value3 c=value4 }
    
    Note: Key that do not match at all won't get transfered into the result maps.
    
    Parameters:
    
    data - the data to scan
    
    pattern - a pattern that identifies the group part and the key part from the original key. The pattern must have two named groups: "group" and "key".
    
    Returns:
    
    A map of maps: group to map(key to value)
  - getEnumChecked
```
public <E extends Enum<E>> E getEnumChecked(String name,
                                            Class<E> enumType,
                                            String errorMessage)
```
  - getEnum
```
public <E extends Enum<E>> E getEnum(String name,
                                     Class<E> enumType)
```
  - getEnum
```
public <E extends Enum<E>> E getEnum(String name,
                                     Class<E> enumType,
                                     E defaultValue)
```
  - makeEnum
```
public static <E extends Enum<E>> E makeEnum(Class<E> enumType,
                                             E defaultValue,
                                             String stringValue,
                                             boolean ignoreMissing)
```
  - makeEnumError
```
protected static <E extends Enum<E>> String makeEnumError(Class<E> enumType,
                                                          String stringValue)
```
  - getTimeZone
```
public TimeZone getTimeZone(String name,
                            TimeZone defaultValue)
```
    Return the time zone
    Note: The method internally calls TimeZone.getTimeZone(String) in order to convert the configured string to the actual time zone.
    
    Parameters:
    
    name - the name of the parameter
    
    defaultValue - the default value
    
    Returns:
    
    the configured time zone, or the default value if none was configured

Class ConfigurationDataHelper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConfigurationDataHelper

Method Detail

getData

getInteger

getInteger

getIntegerChecked

getLong

getLong

getLongChecked

getStringNonEmpty

getString

getString

getStringChecked

getStringNonEmptyChecked

getStringOfChecked

getStringOfChecked

getStringSet

getDouble

getDouble

getDoubleChecked

getBooleanChecked

getBoolean

getBoolean

getVariant

getVariant

getVariantChecked

getPrefixed

getPrefixedHelper

getPrefixedProperties

getAggregated

getEnumChecked

getEnum

getEnum

makeEnum

makeEnumError

getTimeZone