org.eclipse.scada.ca

Class ConfigurationDataHelper

java.lang.Object

org.eclipse.scada.ca.ConfigurationDataHelper

public class ConfigurationDataHelper
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ConfigurationDataHelper(java.util.Map<java.lang.String,java.lang.String> parameters)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	getBoolean(java.lang.String name) Get a boolean from the data or null if the parameter is not set or not a boolean
boolean	getBoolean(java.lang.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(java.lang.String name, java.lang.String errorMessage)
java.util.Map<java.lang.String,java.lang.String>	getData() The actual configuration data
java.lang.Double	getDouble(java.lang.String name) Get an integer from the data or null if the parameter is not set or not an integer
double	getDouble(java.lang.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(java.lang.String name, java.lang.String errorMessage) Get an integer from the configuration data
<E extends java.lang.Enum<E>> E	getEnum(java.lang.String name, java.lang.Class<E> enumType)
<E extends java.lang.Enum<E>> E	getEnum(java.lang.String name, java.lang.Class<E> enumType, E defaultValue)
<E extends java.lang.Enum<E>> E	getEnumChecked(java.lang.String name, java.lang.Class<E> enumType, java.lang.String errorMessage)
java.lang.Integer	getInteger(java.lang.String name) Get an integer from the data or null if the parameter is not set or not an integer
int	getInteger(java.lang.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(java.lang.String name, java.lang.String errorMessage) Get an integer from the configuration data
java.lang.Long	getLong(java.lang.String name) Get a long from the data or null if the parameter is not set or not a long
long	getLong(java.lang.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(java.lang.String name, java.lang.String errorMessage) Get a long from the configuration data
java.util.Map<java.lang.String,java.lang.String>	getPrefixed(java.lang.String prefix) Extracts attributes that start with a prefix and return the matching entries only with the key truncated by the prefix.
java.util.Properties	getPrefixedProperties(java.lang.String prefix) Convenience method to get prefixed attributes as Properties object
java.lang.String	getString(java.lang.String name) Get a string from the configuration
java.lang.String	getString(java.lang.String name, java.lang.String defaultValue)
java.lang.String	getStringChecked(java.lang.String name, java.lang.String errorMessage) Get a string from the configuration data
java.lang.String	getStringNonEmpty(java.lang.String name) Get a non-empty string from the configuration.
java.lang.String	getStringOfChecked(java.lang.String name, java.util.Collection<java.lang.String> whitelisted) Get a whitelisted string from the configuration data
java.lang.String	getStringOfChecked(java.lang.String name, java.lang.String defaultValue, java.util.Collection<java.lang.String> whitelisted) Get a whitelisted string from the configuration data
java.util.Set<java.lang.String>	getStringSet(java.lang.String prefix) Get all values of the keys that start with a specific prefix
static <E extends java.lang.Enum<E>> E	makeEnum(java.lang.Class<E> enumType, E defaultValue, java.lang.String stringValue, boolean ignoreMissing)
protected static <E extends java.lang.Enum<E>> java.lang.String	makeEnumError(java.lang.Class<E> enumType, java.lang.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(java.util.Map<java.lang.String,java.lang.String> parameters)

Method Detail

getData

public java.util.Map<java.lang.String,java.lang.String> getData()

The actual configuration data

Returns:

the configuration data

getInteger

public java.lang.Integer getInteger(java.lang.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(java.lang.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(java.lang.String name,
                    java.lang.String errorMessage)
                      throws java.lang.IllegalArgumentException,
                             java.lang.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:

java.lang.NumberFormatException

java.lang.IllegalArgumentException

getLong

public java.lang.Long getLong(java.lang.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(java.lang.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(java.lang.String name,
                  java.lang.String errorMessage)
                    throws java.lang.IllegalArgumentException,
                           java.lang.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:

java.lang.NumberFormatException

java.lang.IllegalArgumentException

getStringNonEmpty

public java.lang.String getStringNonEmpty(java.lang.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 java.lang.String getString(java.lang.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 java.lang.String getString(java.lang.String name,
                         java.lang.String defaultValue)

getStringChecked

public java.lang.String getStringChecked(java.lang.String name,
                                java.lang.String errorMessage)
                                  throws java.lang.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:

java.lang.IllegalArgumentException - if the string is not set

getStringOfChecked

public java.lang.String getStringOfChecked(java.lang.String name,
                                  java.util.Collection<java.lang.String> whitelisted)
                                    throws java.lang.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:

java.lang.IllegalArgumentException - if the string is not set

getStringOfChecked

public java.lang.String getStringOfChecked(java.lang.String name,
                                  java.lang.String defaultValue,
                                  java.util.Collection<java.lang.String> whitelisted)
                                    throws java.lang.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:

java.lang.IllegalArgumentException - if the string is not set

getStringSet

public java.util.Set<java.lang.String> getStringSet(java.lang.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 java.lang.Double getDouble(java.lang.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(java.lang.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(java.lang.String name,
                      java.lang.String errorMessage)
                        throws java.lang.IllegalArgumentException,
                               java.lang.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:

java.lang.NumberFormatException

java.lang.IllegalArgumentException

getBooleanChecked

public boolean getBooleanChecked(java.lang.String name,
                        java.lang.String errorMessage)

getBoolean

public java.lang.Boolean getBoolean(java.lang.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(java.lang.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

getPrefixed

public java.util.Map<java.lang.String,java.lang.String> getPrefixed(java.lang.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

getPrefixedProperties

public java.util.Properties getPrefixedProperties(java.lang.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

getEnumChecked

public <E extends java.lang.Enum<E>> E getEnumChecked(java.lang.String name,
                                             java.lang.Class<E> enumType,
                                             java.lang.String errorMessage)

getEnum

public <E extends java.lang.Enum<E>> E getEnum(java.lang.String name,
                                      java.lang.Class<E> enumType)

getEnum

public <E extends java.lang.Enum<E>> E getEnum(java.lang.String name,
                                      java.lang.Class<E> enumType,
                                      E defaultValue)

makeEnum

public static <E extends java.lang.Enum<E>> E makeEnum(java.lang.Class<E> enumType,
                                       E defaultValue,
                                       java.lang.String stringValue,
                                       boolean ignoreMissing)

makeEnumError

protected static <E extends java.lang.Enum<E>> java.lang.String makeEnumError(java.lang.Class<E> enumType,
                                                           java.lang.String stringValue)