Package org.apache.commons.configuration
Class DataConfiguration
java.lang.Object
org.apache.commons.configuration.event.EventSource
org.apache.commons.configuration.AbstractConfiguration
org.apache.commons.configuration.DataConfiguration
- All Implemented Interfaces:
Serializable
,Configuration
Decorator providing additional getters for any Configuration. This extended
Configuration supports more types:
URL
Locale
Date
Calendar
Color
InetAddress
-
invalid reference
javax.mail.internet.InternetAddress
Enum
(Java 5 enumeration types)
Example
Configuration file config.properties:title.color = #0000FF remote.host = 192.168.0.53 default.locales = fr,en,de email.contact = ebourg@apache.org, oheger@apache.orgUsage:
DataConfiguration config = new DataConfiguration(new PropertiesConfiguration("config.properties")); // retrieve a property using a specialized getter Color color = config.getColor("title.color"); // retrieve a property using a generic getter InetAddress host = (InetAddress) config.get(InetAddress.class, "remote.host"); Locale[] locales = (Locale[]) config.getArray(Locale.class, "default.locales"); List contacts = config.getList(InternetAddress.class, "email.contact");
Dates
Date objects are expected to be formatted with the pattern yyyy-MM-dd HH:mm:ss. This default format can be changed by specifying another format in the getters, or by putting a date format in the configuration under the key org.apache.commons.configuration.format.date.- Since:
- 1.1
- Version:
- $Id: DataConfiguration.java 1234985 2012-01-23 21:09:09Z oheger $
- Author:
- Emmanuel Bourg
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Configuration
Stores the wrapped configuration.static final String
The key of the property storing the user defined date format.static final String
The default format for dates.Fields inherited from class org.apache.commons.configuration.AbstractConfiguration
END_TOKEN, EVENT_ADD_PROPERTY, EVENT_CLEAR, EVENT_CLEAR_PROPERTY, EVENT_READ_PROPERTY, EVENT_SET_PROPERTY, START_TOKEN
-
Constructor Summary
ConstructorsConstructorDescriptionDataConfiguration
(Configuration configuration) Creates a new instance ofDataConfiguration
and sets the wrapped configuration. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addProperty
(String key, Object value) Add a property to the configuration.protected void
addPropertyDirect
(String key, Object obj) Adds a key/value pair to the Configuration.void
clearProperty
(String key) Removes the specified property from this configuration.boolean
containsKey
(String key) Check if the configuration contains the specified key.<T> T
Get an object of the specified type associated with the given configuration key.<T> T
Get an object of the specified type associated with the given configuration key.Get an array of typed objects associated with the given configuration key.Get an array of typed objects associated with the given configuration key.getBigDecimalArray
(String key) Get an array of BigDecimals associated with the given configuration key.getBigDecimalArray
(String key, BigDecimal[] defaultValue) Get an array of BigDecimals associated with the given configuration key.getBigDecimalList
(String key) Get a list of BigDecimals associated with the given configuration key.getBigDecimalList
(String key, List<BigDecimal> defaultValue) Get a list of BigDecimals associated with the given configuration key.getBigIntegerArray
(String key) Get an array of BigIntegers associated with the given configuration key.getBigIntegerArray
(String key, BigInteger[] defaultValue) Get an array of BigIntegers associated with the given configuration key.getBigIntegerList
(String key) Get a list of BigIntegers associated with the given configuration key.getBigIntegerList
(String key, List<BigInteger> defaultValue) Get a list of BigIntegers associated with the given configuration key.boolean[]
getBooleanArray
(String key) Get an array of boolean primitives associated with the given configuration key.boolean[]
getBooleanArray
(String key, boolean[] defaultValue) Get an array of boolean primitives associated with the given configuration key.getBooleanList
(String key) Get a list of Boolean objects associated with the given configuration key.getBooleanList
(String key, List<Boolean> defaultValue) Get a list of Boolean objects associated with the given configuration key.byte[]
getByteArray
(String key) Get an array of byte primitives associated with the given configuration key.byte[]
getByteArray
(String key, byte[] defaultValue) Get an array of byte primitives associated with the given configuration key.getByteList
(String key) Get a list of Byte objects associated with the given configuration key.getByteList
(String key, List<Byte> defaultValue) Get a list of Byte objects associated with the given configuration key.getCalendar
(String key) Get a Calendar associated with the given configuration key.getCalendar
(String key, String format) Get a Calendar associated with the given configuration key.getCalendar
(String key, Calendar defaultValue) Get a Calendar associated with the given configuration key.getCalendar
(String key, Calendar defaultValue, String format) Get a Calendar associated with the given configuration key.Calendar[]
getCalendarArray
(String key) Get an array of Calendars associated with the given configuration key.Calendar[]
getCalendarArray
(String key, String format) Get an array of Calendars associated with the given configuration key.Calendar[]
getCalendarArray
(String key, Calendar[] defaultValue) Get an array of Calendars associated with the given configuration key.Calendar[]
getCalendarArray
(String key, Calendar[] defaultValue, String format) Get an array of Calendars associated with the given configuration key.getCalendarList
(String key) Get a list of Calendars associated with the given configuration key.getCalendarList
(String key, String format) Get a list of Calendars associated with the given configuration key.getCalendarList
(String key, List<Calendar> defaultValue) Get a list of Calendars associated with the given configuration key.getCalendarList
(String key, List<Calendar> defaultValue, String format) Get a list of Calendars associated with the given configuration key.Get a Color associated with the given configuration key.Get a Color associated with the given configuration key.Color[]
getColorArray
(String key) Get an array of Colors associated with the given configuration key.Color[]
getColorArray
(String key, Color[] defaultValue) Get an array of Colors associated with the given configuration key.getColorList
(String key) Get a list of Colors associated with the given configuration key.getColorList
(String key, List<Color> defaultValue) Get a list of Colors associated with the given configuration key.Return the configuration decorated by this DataConfiguration.Get a Date associated with the given configuration key.Get a Date associated with the given configuration key.Get a Date associated with the given configuration key.Get a Date associated with the given configuration key.Date[]
getDateArray
(String key) Get an array of Dates associated with the given configuration key.Date[]
getDateArray
(String key, String format) Get an array of Dates associated with the given configuration key.Date[]
getDateArray
(String key, Date[] defaultValue) Get an array of Dates associated with the given configuration key.Date[]
getDateArray
(String key, Date[] defaultValue, String format) Get an array of Dates associated with the given configuration key.getDateList
(String key) getDateList
(String key, String format) Get a list of Dates associated with the given configuration key.getDateList
(String key, List<Date> defaultValue) Get a list of Dates associated with the given configuration key.getDateList
(String key, List<Date> defaultValue, String format) Get a list of Dates associated with the given configuration key.double[]
getDoubleArray
(String key) Get an array of double primitives associated with the given configuration key.double[]
getDoubleArray
(String key, double[] defaultValue) Get an array of double primitives associated with the given configuration key.getDoubleList
(String key) Get a list of Double objects associated with the given configuration key.getDoubleList
(String key, List<Double> defaultValue) Get a list of Double objects associated with the given configuration key.float[]
getFloatArray
(String key) Get an array of float primitives associated with the given configuration key.float[]
getFloatArray
(String key, float[] defaultValue) Get an array of float primitives associated with the given configuration key.getFloatList
(String key) Get a list of Float objects associated with the given configuration key.getFloatList
(String key, List<Float> defaultValue) Get a list of Float objects associated with the given configuration key.int[]
getIntArray
(String key) Get an array of int primitives associated with the given configuration key.int[]
getIntArray
(String key, int[] defaultValue) Get an array of int primitives associated with the given configuration key.getIntegerList
(String key) Get a list of Integer objects associated with the given configuration key.getIntegerList
(String key, List<Integer> defaultValue) Get a list of Integer objects associated with the given configuration key.getKeys()
Get the list of the keys contained in the configuration.<T> List
<T> Get a list of typed objects associated with the given configuration key.<T> List
<T> Get a list of typed objects associated with the given configuration key.Get a Locale associated with the given configuration key.Get a Locale associated with the given configuration key.Locale[]
getLocaleArray
(String key) Get an array of Locales associated with the given configuration key.Locale[]
getLocaleArray
(String key, Locale[] defaultValue) Get an array of Locales associated with the given configuration key.getLocaleList
(String key) Get a list of Locales associated with the given configuration key.getLocaleList
(String key, List<Locale> defaultValue) Get a list of Locales associated with the given configuration key.long[]
getLongArray
(String key) Get an array of long primitives associated with the given configuration key.long[]
getLongArray
(String key, long[] defaultValue) Get an array of long primitives associated with the given configuration key.getLongList
(String key) Get a list of Long objects associated with the given configuration key.getLongList
(String key, List<Long> defaultValue) Get a list of Long objects associated with the given configuration key.getProperty
(String key) Gets a property from the configuration.short[]
getShortArray
(String key) Get an array of short primitives associated with the given configuration key.short[]
getShortArray
(String key, short[] defaultValue) Get an array of short primitives associated with the given configuration key.getShortList
(String key) Get a list of Short objects associated with the given configuration key.getShortList
(String key, List<Short> defaultValue) Get a list of Short objects associated with the given configuration key.Get an URL associated with the given configuration key.Get an URL associated with the given configuration key.URL[]
getURLArray
(String key) Get an array of URLs associated with the given configuration key.URL[]
getURLArray
(String key, URL[] defaultValue) Get an array of URLs associated with the given configuration key.getURLList
(String key) Get a list of URLs associated with the given configuration key.getURLList
(String key, List<URL> defaultValue) Get a list of URLs associated with the given configuration key.boolean
isEmpty()
Check if the configuration is empty.void
setProperty
(String key, Object value) Set a property, this will replace any previously set values.Methods inherited from class org.apache.commons.configuration.AbstractConfiguration
addErrorLogListener, append, clear, clearPropertyDirect, copy, createInterpolator, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getDefaultListDelimiter, getDelimiter, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getInterpolator, getKeys, getList, getList, getListDelimiter, getLogger, getLong, getLong, getLong, getProperties, getProperties, getShort, getShort, getShort, getString, getString, getStringArray, getSubstitutor, interpolate, interpolate, interpolatedConfiguration, interpolateHelper, isDelimiterParsingDisabled, isScalarValue, isThrowExceptionOnMissing, resolveContainerStore, setDefaultListDelimiter, setDelimiter, setDelimiterParsingDisabled, setListDelimiter, setLogger, setThrowExceptionOnMissing, subset
Methods inherited from class org.apache.commons.configuration.event.EventSource
addConfigurationListener, addErrorListener, clearConfigurationListeners, clearErrorListeners, clone, createErrorEvent, createEvent, fireError, fireEvent, getConfigurationListeners, getErrorListeners, isDetailEvents, removeConfigurationListener, removeErrorListener, setDetailEvents
-
Field Details
-
DATE_FORMAT_KEY
The key of the property storing the user defined date format.- See Also:
-
DEFAULT_DATE_FORMAT
The default format for dates.- See Also:
-
configuration
Stores the wrapped configuration.
-
-
Constructor Details
-
DataConfiguration
Creates a new instance ofDataConfiguration
and sets the wrapped configuration.- Parameters:
configuration
- the wrapped configuration
-
-
Method Details
-
getConfiguration
Return the configuration decorated by this DataConfiguration.- Returns:
- the wrapped configuration
-
getProperty
Description copied from interface:Configuration
Gets a property from the configuration. This is the most basic get method for retrieving values of properties. In a typical implementation of theConfiguration
interface the other get methods (that return specific data types) will internally make use of this method. On this level variable substitution is not yet performed. The returned object is an internal representation of the property value for the passed in key. It is owned by theConfiguration
object. So a caller should not modify this object. It cannot be guaranteed that this object will stay constant over time (i.e. further update operations on the configuration may change its internal state).- Specified by:
getProperty
in interfaceConfiguration
- Parameters:
key
- property to retrieve- Returns:
- the value to which this configuration maps the specified key, or null if the configuration contains no mapping for this key.
-
addPropertyDirect
Description copied from class:AbstractConfiguration
Adds a key/value pair to the Configuration. Override this method to provide write access to underlying Configuration store.- Specified by:
addPropertyDirect
in classAbstractConfiguration
- Parameters:
key
- key to use for mappingobj
- object to store
-
addProperty
Description copied from interface:Configuration
Add a property to the configuration. If it already exists then the value stated here will be added to the configuration entry. For example, if the property:resource.loader = file
is already present in the configuration and you calladdProperty("resource.loader", "classpath")
Then you will end up with a List like the following:["file", "classpath"]
- Specified by:
addProperty
in interfaceConfiguration
- Overrides:
addProperty
in classAbstractConfiguration
- Parameters:
key
- The key to add the property to.value
- The value to add.
-
isEmpty
Description copied from interface:Configuration
Check if the configuration is empty.- Specified by:
isEmpty
in interfaceConfiguration
- Returns:
true
if the configuration contains no property,false
otherwise.
-
containsKey
Description copied from interface:Configuration
Check if the configuration contains the specified key.- Specified by:
containsKey
in interfaceConfiguration
- Parameters:
key
- the key whose presence in this configuration is to be tested- Returns:
true
if the configuration contains a value for this key,false
otherwise
-
clearProperty
Description copied from class:AbstractConfiguration
Removes the specified property from this configuration. This implementation performs some preparations and then delegates toclearPropertyDirect()
, which will do the real work.- Specified by:
clearProperty
in interfaceConfiguration
- Overrides:
clearProperty
in classAbstractConfiguration
- Parameters:
key
- the key to be removed
-
setProperty
Description copied from interface:Configuration
Set a property, this will replace any previously set values. Set values is implicitly a call to clearProperty(key), addProperty(key, value).- Specified by:
setProperty
in interfaceConfiguration
- Overrides:
setProperty
in classAbstractConfiguration
- Parameters:
key
- The key of the property to changevalue
- The new value
-
getKeys
Description copied from interface:Configuration
Get the list of the keys contained in the configuration. The returned iterator can be used to obtain all defined keys. Note that the exact behavior of the iterator'sremove()
method is specific to a concrete implementation. It may remove the corresponding property from the configuration, but this is not guaranteed. In any case it is no replacement for callingConfiguration.clearProperty(String)
for this property. So it is highly recommended to avoid using the iterator'sremove()
method.- Specified by:
getKeys
in interfaceConfiguration
- Returns:
- An Iterator.
-
get
Get an object of the specified type associated with the given configuration key. If the key doesn't map to an existing object, the method returns null unlessAbstractConfiguration.isThrowExceptionOnMissing()
is set to true.- Type Parameters:
T
- the target type of the value- Parameters:
cls
- the target class of the valuekey
- the key of the value- Returns:
- the value of the requested type for the key
- Throws:
NoSuchElementException
- if the key doesn't map to an existing object and throwExceptionOnMissing=trueConversionException
- if the value is not compatible with the requested type- Since:
- 1.5
-
get
Get an object of the specified type associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.- Type Parameters:
T
- the target type of the value- Parameters:
cls
- the target class of the valuekey
- the key of the valuedefaultValue
- the default value- Returns:
- the value of the requested type for the key
- Throws:
ConversionException
- if the value is not compatible with the requested type- Since:
- 1.5
-
getList
Get a list of typed objects associated with the given configuration key. If the key doesn't map to an existing object, an empty list is returned.- Type Parameters:
T
- the type expected for the elements of the list- Parameters:
cls
- the class expected for the elements of the listkey
- The configuration key.- Returns:
- The associated list if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not compatible with a list of the specified class.- Since:
- 1.5
-
getList
Get a list of typed objects associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.- Type Parameters:
T
- the type expected for the elements of the list- Parameters:
cls
- the class expected for the elements of the listkey
- the configuration key.defaultValue
- the default value.- Returns:
- The associated List.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not compatible with a list of the specified class.- Since:
- 1.5
-
getArray
Get an array of typed objects associated with the given configuration key. If the key doesn't map to an existing object, an empty list is returned.- Parameters:
cls
- the type expected for the elements of the arraykey
- The configuration key.- Returns:
- The associated array if the key is found, and the value compatible with the type specified.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not compatible with a list of the specified class.- Since:
- 1.5
-
getArray
Get an array of typed objects associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.- Parameters:
cls
- the type expected for the elements of the arraykey
- the configuration key.defaultValue
- the default value- Returns:
- The associated array if the key is found, and the value compatible with the type specified.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not compatible with an array of the specified class.IllegalArgumentException
- if the default value is not an array of the specified type- Since:
- 1.5
-
getBooleanList
Get a list of Boolean objects associated with the given configuration key. If the key doesn't map to an existing object an empty list is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated Boolean list if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of booleans.
-
getBooleanList
Get a list of Boolean objects associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.- Returns:
- The associated List of Booleans.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of booleans.
-
getBooleanArray
Get an array of boolean primitives associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated boolean array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of booleans.
-
getBooleanArray
Get an array of boolean primitives associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.- Returns:
- The associated boolean array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of booleans.
-
getByteList
Get a list of Byte objects associated with the given configuration key. If the key doesn't map to an existing object an empty list is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated Byte list if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of bytes.
-
getByteList
Get a list of Byte objects associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.- Returns:
- The associated List of Bytes.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of bytes.
-
getByteArray
Get an array of byte primitives associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated byte array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of bytes.
-
getByteArray
Get an array of byte primitives associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.defaultValue
- the default value, which will be returned if the property is not found- Returns:
- The associated byte array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of bytes.
-
getShortList
Get a list of Short objects associated with the given configuration key. If the key doesn't map to an existing object an empty list is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated Short list if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of shorts.
-
getShortList
Get a list of Short objects associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.- Returns:
- The associated List of Shorts.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of shorts.
-
getShortArray
Get an array of short primitives associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated short array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of shorts.
-
getShortArray
Get an array of short primitives associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.defaultValue
- the default value, which will be returned if the property is not found- Returns:
- The associated short array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of shorts.
-
getIntegerList
Get a list of Integer objects associated with the given configuration key. If the key doesn't map to an existing object an empty list is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated Integer list if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of integers.
-
getIntegerList
Get a list of Integer objects associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.- Returns:
- The associated List of Integers.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of integers.
-
getIntArray
Get an array of int primitives associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated int array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of integers.
-
getIntArray
Get an array of int primitives associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.defaultValue
- the default value, which will be returned if the property is not found- Returns:
- The associated int array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of integers.
-
getLongList
Get a list of Long objects associated with the given configuration key. If the key doesn't map to an existing object an empty list is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated Long list if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of longs.
-
getLongList
Get a list of Long objects associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.- Returns:
- The associated List of Longs.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of longs.
-
getLongArray
Get an array of long primitives associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated long array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of longs.
-
getLongArray
Get an array of long primitives associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.defaultValue
- the default value, which will be returned if the property is not found- Returns:
- The associated long array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of longs.
-
getFloatList
Get a list of Float objects associated with the given configuration key. If the key doesn't map to an existing object an empty list is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated Float list if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of floats.
-
getFloatList
Get a list of Float objects associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.- Returns:
- The associated List of Floats.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of floats.
-
getFloatArray
Get an array of float primitives associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated float array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of floats.
-
getFloatArray
Get an array of float primitives associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.defaultValue
- the default value, which will be returned if the property is not found- Returns:
- The associated float array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of floats.
-
getDoubleList
Get a list of Double objects associated with the given configuration key. If the key doesn't map to an existing object an empty list is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated Double list if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of doubles.
-
getDoubleList
Get a list of Double objects associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.- Returns:
- The associated List of Doubles.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of doubles.
-
getDoubleArray
Get an array of double primitives associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated double array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of doubles.
-
getDoubleArray
Get an array of double primitives associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.defaultValue
- the default value, which will be returned if the property is not found- Returns:
- The associated double array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of doubles.
-
getBigIntegerList
Get a list of BigIntegers associated with the given configuration key. If the key doesn't map to an existing object an empty list is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated BigInteger list if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of BigIntegers.
-
getBigIntegerList
Get a list of BigIntegers associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.- Returns:
- The associated List of BigIntegers.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of BigIntegers.
-
getBigIntegerArray
Get an array of BigIntegers associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated BigInteger array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of BigIntegers.
-
getBigIntegerArray
Get an array of BigIntegers associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.defaultValue
- the default value, which will be returned if the property is not found- Returns:
- The associated BigInteger array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of BigIntegers.
-
getBigDecimalList
Get a list of BigDecimals associated with the given configuration key. If the key doesn't map to an existing object an empty list is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated BigDecimal list if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of BigDecimals.
-
getBigDecimalList
Get a list of BigDecimals associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.- Returns:
- The associated List of BigDecimals.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of BigDecimals.
-
getBigDecimalArray
Get an array of BigDecimals associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated BigDecimal array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of BigDecimals.
-
getBigDecimalArray
Get an array of BigDecimals associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.defaultValue
- the default value, which will be returned if the property is not found- Returns:
- The associated BigDecimal array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of BigDecimals.
-
getURL
Get an URL associated with the given configuration key.- Parameters:
key
- The configuration key.- Returns:
- The associated URL.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not an URL.
-
getURL
Get an URL associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.- Returns:
- The associated URL.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not an URL.
-
getURLList
Get a list of URLs associated with the given configuration key. If the key doesn't map to an existing object an empty list is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated URL list if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of URLs.
-
getURLList
Get a list of URLs associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.- Returns:
- The associated List of URLs.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of URLs.
-
getURLArray
Get an array of URLs associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated URL array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of URLs.
-
getURLArray
Get an array of URLs associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.defaultValue
- the default value, which will be returned if the property is not found- Returns:
- The associated URL array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of URLs.
-
getDate
Get a Date associated with the given configuration key. If the property is a String, it will be parsed with the format defined by the user in theDATE_FORMAT_KEY
property, or if it's not defined with theDEFAULT_DATE_FORMAT
pattern.- Parameters:
key
- The configuration key.- Returns:
- The associated Date.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a Date.
-
getDate
Get a Date associated with the given configuration key. If the property is a String, it will be parsed with the specified format pattern.- Parameters:
key
- The configuration key.format
- The non-localizedDateFormat
pattern.- Returns:
- The associated Date
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a Date.
-
getDate
Get a Date associated with the given configuration key. If the property is a String, it will be parsed with the format defined by the user in theDATE_FORMAT_KEY
property, or if it's not defined with theDEFAULT_DATE_FORMAT
pattern. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.- Returns:
- The associated Date.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a Date.
-
getDate
Get a Date associated with the given configuration key. If the property is a String, it will be parsed with the specified format pattern. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.format
- The non-localizedDateFormat
pattern.- Returns:
- The associated Date.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a Date.
-
getDateList
-
getDateList
Get a list of Dates associated with the given configuration key. If the property is a list of Strings, they will be parsed with the specified format pattern. If the key doesn't map to an existing object an empty list is returned.- Parameters:
key
- The configuration key.format
- The non-localizedDateFormat
pattern.- Returns:
- The associated Date list if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of Dates.
-
getDateList
Get a list of Dates associated with the given configuration key. If the property is a list of Strings, they will be parsed with the format defined by the user in theDATE_FORMAT_KEY
property, or if it's not defined with theDEFAULT_DATE_FORMAT
pattern. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.- Returns:
- The associated Date list if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of Dates.
-
getDateList
Get a list of Dates associated with the given configuration key. If the property is a list of Strings, they will be parsed with the specified format pattern. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.format
- The non-localizedDateFormat
pattern.- Returns:
- The associated Date list if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of Dates.
-
getDateArray
Get an array of Dates associated with the given configuration key. If the property is a list of Strings, they will be parsed with the format defined by the user in theDATE_FORMAT_KEY
property, or if it's not defined with theDEFAULT_DATE_FORMAT
pattern. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated Date array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of Dates.
-
getDateArray
Get an array of Dates associated with the given configuration key. If the property is a list of Strings, they will be parsed with the specified format pattern. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.format
- The non-localizedDateFormat
pattern.- Returns:
- The associated Date array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of Dates.
-
getDateArray
Get an array of Dates associated with the given configuration key. If the property is a list of Strings, they will be parsed with the format defined by the user in theDATE_FORMAT_KEY
property, or if it's not defined with theDEFAULT_DATE_FORMAT
pattern. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.defaultValue
- the default value, which will be returned if the property is not found- Returns:
- The associated Date array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of Dates.
-
getDateArray
Get an array of Dates associated with the given configuration key. If the property is a list of Strings, they will be parsed with the specified format pattern. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.format
- The non-localizedDateFormat
pattern.- Returns:
- The associated Date array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of Dates.
-
getCalendar
Get a Calendar associated with the given configuration key. If the property is a String, it will be parsed with the format defined by the user in theDATE_FORMAT_KEY
property, or if it's not defined with theDEFAULT_DATE_FORMAT
pattern.- Parameters:
key
- The configuration key.- Returns:
- The associated Calendar.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a Calendar.
-
getCalendar
Get a Calendar associated with the given configuration key. If the property is a String, it will be parsed with the specified format pattern.- Parameters:
key
- The configuration key.format
- The non-localizedDateFormat
pattern.- Returns:
- The associated Calendar
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a Calendar.
-
getCalendar
Get a Calendar associated with the given configuration key. If the property is a String, it will be parsed with the format defined by the user in theDATE_FORMAT_KEY
property, or if it's not defined with theDEFAULT_DATE_FORMAT
pattern. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.- Returns:
- The associated Calendar.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a Calendar.
-
getCalendar
Get a Calendar associated with the given configuration key. If the property is a String, it will be parsed with the specified format pattern. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.format
- The non-localizedDateFormat
pattern.- Returns:
- The associated Calendar.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a Calendar.
-
getCalendarList
Get a list of Calendars associated with the given configuration key. If the property is a list of Strings, they will be parsed with the format defined by the user in theDATE_FORMAT_KEY
property, or if it's not defined with theDEFAULT_DATE_FORMAT
pattern. If the key doesn't map to an existing object an empty list is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated Calendar list if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of Calendars.
-
getCalendarList
Get a list of Calendars associated with the given configuration key. If the property is a list of Strings, they will be parsed with the specified format pattern. If the key doesn't map to an existing object an empty list is returned.- Parameters:
key
- The configuration key.format
- The non-localizedDateFormat
pattern.- Returns:
- The associated Calendar list if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of Calendars.
-
getCalendarList
Get a list of Calendars associated with the given configuration key. If the property is a list of Strings, they will be parsed with the format defined by the user in theDATE_FORMAT_KEY
property, or if it's not defined with theDEFAULT_DATE_FORMAT
pattern. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.- Returns:
- The associated Calendar list if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of Calendars.
-
getCalendarList
Get a list of Calendars associated with the given configuration key. If the property is a list of Strings, they will be parsed with the specified format pattern. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.format
- The non-localizedDateFormat
pattern.- Returns:
- The associated Calendar list if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of Calendars.
-
getCalendarArray
Get an array of Calendars associated with the given configuration key. If the property is a list of Strings, they will be parsed with the format defined by the user in theDATE_FORMAT_KEY
property, or if it's not defined with theDEFAULT_DATE_FORMAT
pattern. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated Calendar array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of Calendars.
-
getCalendarArray
Get an array of Calendars associated with the given configuration key. If the property is a list of Strings, they will be parsed with the specified format pattern. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.format
- The non-localizedDateFormat
pattern.- Returns:
- The associated Calendar array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of Calendars.
-
getCalendarArray
Get an array of Calendars associated with the given configuration key. If the property is a list of Strings, they will be parsed with the format defined by the user in theDATE_FORMAT_KEY
property, or if it's not defined with theDEFAULT_DATE_FORMAT
pattern. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.defaultValue
- the default value, which will be returned if the property is not found- Returns:
- The associated Calendar array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of Calendars.
-
getCalendarArray
Get an array of Calendars associated with the given configuration key. If the property is a list of Strings, they will be parsed with the specified format pattern. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.format
- The non-localizedDateFormat
pattern.- Returns:
- The associated Calendar array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of Calendars.
-
getLocale
Get a Locale associated with the given configuration key.- Parameters:
key
- The configuration key.- Returns:
- The associated Locale.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a Locale.
-
getLocale
Get a Locale associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.- Returns:
- The associated Locale.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a Locale.
-
getLocaleList
Get a list of Locales associated with the given configuration key. If the key doesn't map to an existing object an empty list is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated Locale list if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of Locales.
-
getLocaleList
Get a list of Locales associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.- Returns:
- The associated List of Locales.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of Locales.
-
getLocaleArray
Get an array of Locales associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated Locale array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of Locales.
-
getLocaleArray
Get an array of Locales associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.defaultValue
- the default value, which will be returned if the property is not found- Returns:
- The associated Locale array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of Locales.
-
getColor
Get a Color associated with the given configuration key.- Parameters:
key
- The configuration key.- Returns:
- The associated Color.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a Color.
-
getColor
Get a Color associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.- Returns:
- The associated Color.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a Color.
-
getColorList
Get a list of Colors associated with the given configuration key. If the key doesn't map to an existing object an empty list is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated Color list if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of Colors.
-
getColorList
Get a list of Colors associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.- Parameters:
key
- The configuration key.defaultValue
- The default value.- Returns:
- The associated List of Colors.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of Colors.
-
getColorArray
Get an array of Colors associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.- Returns:
- The associated Color array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of Colors.
-
getColorArray
Get an array of Colors associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned.- Parameters:
key
- The configuration key.defaultValue
- the default value, which will be returned if the property is not found- Returns:
- The associated Color array if the key is found.
- Throws:
ConversionException
- is thrown if the key maps to an object that is not a list of Colors.
-