org.apache.commons.configuration2

Class DataConfiguration

java.lang.Object

org.apache.commons.configuration2.event.BaseEventSource

org.apache.commons.configuration2.AbstractConfiguration

org.apache.commons.configuration2.DataConfiguration

All Implemented Interfaces:

Configuration, EventSource, ImmutableConfiguration, SynchronizerSupport

public class DataConfiguration
extends AbstractConfiguration

Decorator providing additional getters for any Configuration. This extended Configuration supports more types:

• URL
• Locale
• Date
• Calendar
• Color
• InetAddress
• javax.mail.internet.InternetAddress (requires Javamail in the classpath)
• Enum (Java 5 enumeration types)

Lists and arrays are available for all types.
Note that this class is only a thin wrapper over functionality already provided by AbstractConfiguration. Basically, the generic get(), and getCollection() methods are used to actually perform data conversions.

Example

Configuration file config.properties:

 title.color = #0000FF
 remote.host = 192.168.0.53
 default.locales = fr,en,de
 email.contact = ebourg@apache.org, tester@test.org
 

Usage:

 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. Alternatively, the date format can also be specified via the ConversionHandler used by a configuration instance:

 DefaultConversionHandler handler = new DefaultConversionHandler();
 handler.setDateFormat("mm/dd/yyyy");
 config.setConversionHandler(handler);
 

Since:

1.1

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATE_FORMAT_KEY The key of the property storing the user defined date format.
static String	DEFAULT_DATE_FORMAT The default format for dates.

Constructor Summary

Constructors

Constructor and Description
DataConfiguration(Configuration configuration) Creates a new instance of DataConfiguration and sets the wrapped configuration.

Method Summary

Modifier and Type	Method and Description
protected void	addPropertyDirect(String key, Object value) Adds a key/value pair to the Configuration.
protected void	addPropertyInternal(String key, Object obj) Actually adds a property to this configuration.
protected void	clearPropertyDirect(String key) Removes the specified property from this configuration.
protected boolean	containsKeyInternal(String key) Actually checks whether the specified key is contained in this configuration.
BigDecimal[]	getBigDecimalArray(String key) Get an array of BigDecimals associated with the given configuration key.
BigDecimal[]	getBigDecimalArray(String key, BigDecimal... defaultValue) Get an array of BigDecimals associated with the given configuration key.
List<BigDecimal>	getBigDecimalList(String key) Get a list of BigDecimals associated with the given configuration key.
List<BigDecimal>	getBigDecimalList(String key, List<BigDecimal> defaultValue) Get a list of BigDecimals associated with the given configuration key.
BigInteger[]	getBigIntegerArray(String key) Get an array of BigIntegers associated with the given configuration key.
BigInteger[]	getBigIntegerArray(String key, BigInteger... defaultValue) Get an array of BigIntegers associated with the given configuration key.
List<BigInteger>	getBigIntegerList(String key) Get a list of BigIntegers associated with the given configuration key.
List<BigInteger>	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.
List<Boolean>	getBooleanList(String key) Get a list of Boolean objects associated with the given configuration key.
List<Boolean>	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.
List<Byte>	getByteList(String key) Get a list of Byte objects associated with the given configuration key.
List<Byte>	getByteList(String key, List<Byte> defaultValue) Get a list of Byte objects associated with the given configuration key.
Calendar	getCalendar(String key) Get a Calendar associated with the given configuration key.
Calendar	getCalendar(String key, Calendar defaultValue) Get a Calendar associated with the given configuration key.
Calendar	getCalendar(String key, Calendar defaultValue, String format) Get a Calendar associated with the given configuration key.
Calendar	getCalendar(String key, 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, 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.
Calendar[]	getCalendarArray(String key, String format) Get an array of Calendars associated with the given configuration key.
List<Calendar>	getCalendarList(String key) Get a list of Calendars associated with the given configuration key.
List<Calendar>	getCalendarList(String key, List<Calendar> defaultValue) Get a list of Calendars associated with the given configuration key.
List<Calendar>	getCalendarList(String key, List<Calendar> defaultValue, String format) Get a list of Calendars associated with the given configuration key.
List<Calendar>	getCalendarList(String key, String format) Get a list of Calendars associated with the given configuration key.
Color	getColor(String key) Get a Color associated with the given configuration key.
Color	getColor(String key, Color defaultValue) 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.
List<Color>	getColorList(String key) Get a list of Colors associated with the given configuration key.
List<Color>	getColorList(String key, List<Color> defaultValue) Get a list of Colors associated with the given configuration key.
Configuration	getConfiguration() Return the configuration decorated by this DataConfiguration.
ConversionHandler	getConversionHandler() Returns the ConversionHandler used by this instance.
Date	getDate(String key) Get a Date associated with the given configuration key.
Date	getDate(String key, Date defaultValue) Get a Date associated with the given configuration key.
Date	getDate(String key, Date defaultValue, String format) Get a Date associated with the given configuration key.
Date	getDate(String key, String format) 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, 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.
Date[]	getDateArray(String key, String format) Get an array of Dates associated with the given configuration key.
List<Date>	getDateList(String key)
List<Date>	getDateList(String key, List<Date> defaultValue) Get a list of Dates associated with the given configuration key.
List<Date>	getDateList(String key, List<Date> defaultValue, String format) Get a list of Dates associated with the given configuration key.
List<Date>	getDateList(String key, 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.
List<Double>	getDoubleList(String key) Get a list of Double objects associated with the given configuration key.
List<Double>	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.
List<Float>	getFloatList(String key) Get a list of Float objects associated with the given configuration key.
List<Float>	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.
List<Integer>	getIntegerList(String key) Get a list of Integer objects associated with the given configuration key.
List<Integer>	getIntegerList(String key, List<Integer> defaultValue) Get a list of Integer objects associated with the given configuration key.
protected Iterator<String>	getKeysInternal() Actually creates an iterator for iterating over the keys in this configuration.
Locale	getLocale(String key) Get a Locale associated with the given configuration key.
Locale	getLocale(String key, Locale defaultValue) 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.
List<Locale>	getLocaleList(String key) Get a list of Locales associated with the given configuration key.
List<Locale>	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.
List<Long>	getLongList(String key) Get a list of Long objects associated with the given configuration key.
List<Long>	getLongList(String key, List<Long> defaultValue) Get a list of Long objects associated with the given configuration key.
protected Object	getPropertyInternal(String key) Actually obtains the value of the specified property.
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.
List<Short>	getShortList(String key) Get a list of Short objects associated with the given configuration key.
List<Short>	getShortList(String key, List<Short> defaultValue) Get a list of Short objects associated with the given configuration key.
URI	getURI(String key) Get an URI associated with the given configuration key.
URI	getURI(String key, URI defaultValue) Get an URI associated with the given configuration key.
URI[]	getURIArray(String key) Get an array of URIs associated with the given configuration key.
URI[]	getURIArray(String key, URI... defaultValue) Get an array of URIs associated with the given configuration key.
List<URI>	getURIList(String key) Get a list of URIs associated with the given configuration key.
List<URI>	getURIList(String key, List<URI> defaultValue) Get a list of URIs associated with the given configuration key.
URL	getURL(String key) Get an URL associated with the given configuration key.
URL	getURL(String key, URL defaultValue) 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.
List<URL>	getURLList(String key) Get a list of URLs associated with the given configuration key.
List<URL>	getURLList(String key, List<URL> defaultValue) Get a list of URLs associated with the given configuration key.
protected boolean	isEmptyInternal() Actually checks whether this configuration contains data.
protected void	setPropertyInternal(String key, Object value) Actually sets the value of a property.

Methods inherited from class org.apache.commons.configuration2.AbstractConfiguration

addErrorLogListener, addProperty, append, beginRead, beginWrite, clear, clearInternal, clearProperty, cloneInterpolator, containsKey, copy, endRead, endWrite, get, get, getArray, getArray, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getCollection, getCollection, getConfigurationDecoder, getDouble, getDouble, getDouble, getEncodedString, getEncodedString, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getInterpolator, getKeys, getKeys, getKeysInternal, getList, getList, getList, getList, getListDelimiterHandler, getLogger, getLong, getLong, getLong, getProperties, getProperties, getProperty, getShort, getShort, getShort, getString, getString, getStringArray, getSynchronizer, immutableSubset, initLogger, installInterpolator, interpolate, interpolate, interpolatedConfiguration, isEmpty, isScalarValue, isThrowExceptionOnMissing, lock, setConfigurationDecoder, setConversionHandler, setDefaultLookups, setInterpolator, setListDelimiterHandler, setLogger, setParentInterpolator, setPrefixLookups, setProperty, setSynchronizer, setThrowExceptionOnMissing, size, sizeInternal, subset, unlock

Methods inherited from class org.apache.commons.configuration2.event.BaseEventSource

addEventListener, clearErrorListeners, clearEventListeners, clone, copyEventListeners, createErrorEvent, createEvent, fireError, fireEvent, getEventListenerRegistrations, getEventListeners, isDetailEvents, removeEventListener, setDetailEvents

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DATE_FORMAT_KEY

public static final String DATE_FORMAT_KEY

The key of the property storing the user defined date format.

See Also:

Constant Field Values

DEFAULT_DATE_FORMAT

public static final String DEFAULT_DATE_FORMAT

The default format for dates.

See Also:

Constant Field Values

Constructor Detail

DataConfiguration

public DataConfiguration(Configuration configuration)

Creates a new instance of DataConfiguration and sets the wrapped configuration.

Parameters:

configuration - the wrapped configuration

Method Detail

getConfiguration

public Configuration getConfiguration()

Return the configuration decorated by this DataConfiguration.

Returns:

the wrapped configuration

getConversionHandler

public ConversionHandler getConversionHandler()

Returns the ConversionHandler used by this instance. This implementation returns the special conversion handler used by this configuration instance.

Overrides:

getConversionHandler in class AbstractConfiguration

Returns:

the ConversionHandler

getPropertyInternal

protected Object getPropertyInternal(String key)

Description copied from class: AbstractConfiguration

Actually obtains the value of the specified property. This method is called by getProperty(). Concrete subclasses must define it to fetch the value of the desired property.

Specified by:

getPropertyInternal in class AbstractConfiguration

Parameters:

key - the key of the property in question

Returns:

the (raw) value of this property

addPropertyInternal

protected void addPropertyInternal(String key,
                                   Object obj)

Description copied from class: AbstractConfiguration

Actually adds a property to this configuration. This method is called by addProperty(). It performs list splitting if necessary and delegates to AbstractConfiguration.addPropertyDirect(String, Object) for every single property value.

Overrides:

addPropertyInternal in class AbstractConfiguration

Parameters:

key - the key of the property to be added

obj - the new property value

addPropertyDirect

protected void addPropertyDirect(String key,
                                 Object value)

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 class AbstractConfiguration

Parameters:

key - key to use for mapping

value - object to store

isEmptyInternal

protected boolean isEmptyInternal()

Description copied from class: AbstractConfiguration

Actually checks whether this configuration contains data. This method is called by isEmpty(). It has to be defined by concrete subclasses.

Specified by:

isEmptyInternal in class AbstractConfiguration

Returns:

true if this configuration contains no data, false otherwise

containsKeyInternal

protected boolean containsKeyInternal(String key)

Description copied from class: AbstractConfiguration

Actually checks whether the specified key is contained in this configuration. This method is called by containsKey(). It has to be defined by concrete subclasses.

Specified by:

containsKeyInternal in class AbstractConfiguration

Parameters:

key - the key in question

Returns:

true if this key is contained in this configuration, false otherwise

clearPropertyDirect

protected void clearPropertyDirect(String key)

Description copied from class: AbstractConfiguration

Removes the specified property from this configuration. This method is called by clearProperty() after it has done some preparations. It must be overridden in sub classes.

Specified by:

clearPropertyDirect in class AbstractConfiguration

Parameters:

key - the key to be removed

setPropertyInternal

protected void setPropertyInternal(String key,
                                   Object value)

Description copied from class: AbstractConfiguration

Actually sets the value of a property. This method is called by setProperty(). It provides a default implementation of this functionality by clearing the specified key and delegating to addProperty(). Subclasses should override this method if they can provide a more efficient algorithm for setting a property value.

Overrides:

setPropertyInternal in class AbstractConfiguration

Parameters:

key - the property key

value - the new property value

getKeysInternal

protected Iterator<String> getKeysInternal()

Description copied from class: AbstractConfiguration

Actually creates an iterator for iterating over the keys in this configuration. This method is called by getKeys(), it has to be defined by concrete subclasses.

Specified by:

getKeysInternal in class AbstractConfiguration

Returns:

an Iterator with all property keys in this configuration

getBooleanList

public List<Boolean> getBooleanList(String key)

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

public List<Boolean> getBooleanList(String key,
                                    List<Boolean> defaultValue)

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

public boolean[] getBooleanArray(String key)

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

public boolean[] getBooleanArray(String key,
                                 boolean... defaultValue)

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

public List<Byte> getByteList(String key)

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

public List<Byte> getByteList(String key,
                              List<Byte> defaultValue)

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

public byte[] getByteArray(String key)

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

public byte[] getByteArray(String key,
                           byte... defaultValue)

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

public List<Short> getShortList(String key)

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

public List<Short> getShortList(String key,
                                List<Short> defaultValue)

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

public short[] getShortArray(String key)

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

public short[] getShortArray(String key,
                             short... defaultValue)

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

public List<Integer> getIntegerList(String key)

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

public List<Integer> getIntegerList(String key,
                                    List<Integer> defaultValue)

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

public int[] getIntArray(String key)

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

public int[] getIntArray(String key,
                         int... defaultValue)

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

public List<Long> getLongList(String key)

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

public List<Long> getLongList(String key,
                              List<Long> defaultValue)

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

public long[] getLongArray(String key)

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

public long[] getLongArray(String key,
                           long... defaultValue)

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

public List<Float> getFloatList(String key)

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

public List<Float> getFloatList(String key,
                                List<Float> defaultValue)

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

public float[] getFloatArray(String key)

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

public float[] getFloatArray(String key,
                             float... defaultValue)

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

public List<Double> getDoubleList(String key)

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

public List<Double> getDoubleList(String key,
                                  List<Double> defaultValue)

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

public double[] getDoubleArray(String key)

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

public double[] getDoubleArray(String key,
                               double... defaultValue)

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

public List<BigInteger> getBigIntegerList(String key)

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

public List<BigInteger> getBigIntegerList(String key,
                                          List<BigInteger> defaultValue)

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

public BigInteger[] getBigIntegerArray(String key)

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

public BigInteger[] getBigIntegerArray(String key,
                                       BigInteger... defaultValue)

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

public List<BigDecimal> getBigDecimalList(String key)

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

public List<BigDecimal> getBigDecimalList(String key,
                                          List<BigDecimal> defaultValue)

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

public BigDecimal[] getBigDecimalArray(String key)

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

public BigDecimal[] getBigDecimalArray(String key,
                                       BigDecimal... defaultValue)

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.

getURI

public URI getURI(String key)

Get an URI associated with the given configuration key.

Parameters:

key - The configuration key.

Returns:

The associated URI.

Throws:

ConversionException - is thrown if the key maps to an object that is not an URI.

getURI

public URI getURI(String key,
                  URI defaultValue)

Get an URI 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 URI.

Throws:

ConversionException - is thrown if the key maps to an object that is not an URI.

getURIArray

public URI[] getURIArray(String key)

Get an array of URIs 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 URI array if the key is found.

Throws:

ConversionException - is thrown if the key maps to an object that is not a list of URIs.

getURIArray

public URI[] getURIArray(String key,
                         URI... defaultValue)

Get an array of URIs 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 URI array if the key is found.

Throws:

ConversionException - is thrown if the key maps to an object that is not a list of URIs.

getURIList

public List<URI> getURIList(String key)

Get a list of URIs 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 URI list if the key is found.

Throws:

ConversionException - is thrown if the key maps to an object that is not a list of URIs.

getURIList

public List<URI> getURIList(String key,
                            List<URI> defaultValue)

Get a list of URIs 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 URIs.

Throws:

ConversionException - is thrown if the key maps to an object that is not a list of URIs.

getURL

public URL getURL(String key)

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

public URL getURL(String key,
                  URL defaultValue)

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

public List<URL> getURLList(String key)

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

public List<URL> getURLList(String key,
                            List<URL> defaultValue)

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

public URL[] getURLArray(String key)

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

public URL[] getURLArray(String key,
                         URL... defaultValue)

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

public Date getDate(String key)

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 the DATE_FORMAT_KEY property, or if it's not defined with the DEFAULT_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

public Date getDate(String key,
                    String format)

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-localized DateFormat pattern.

Returns:

The associated Date

Throws:

ConversionException - is thrown if the key maps to an object that is not a Date.

getDate

public Date getDate(String key,
                    Date defaultValue)

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 the DATE_FORMAT_KEY property, or if it's not defined with the DEFAULT_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

public Date getDate(String key,
                    Date defaultValue,
                    String format)

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-localized DateFormat pattern.

Returns:

The associated Date.

Throws:

ConversionException - is thrown if the key maps to an object that is not a Date.

getDateList

public List<Date> getDateList(String key)

getDateList

public List<Date> getDateList(String key,
                              String format)

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-localized DateFormat 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

public List<Date> getDateList(String key,
                              List<Date> defaultValue)

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 the DATE_FORMAT_KEY property, or if it's not defined with the DEFAULT_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

public List<Date> getDateList(String key,
                              List<Date> defaultValue,
                              String format)

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-localized DateFormat 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

public Date[] getDateArray(String key)

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 the DATE_FORMAT_KEY property, or if it's not defined with the DEFAULT_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

public Date[] getDateArray(String key,
                           String format)

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-localized DateFormat 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

public Date[] getDateArray(String key,
                           Date... defaultValue)

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 the DATE_FORMAT_KEY property, or if it's not defined with the DEFAULT_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

public Date[] getDateArray(String key,
                           Date[] defaultValue,
                           String format)

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-localized DateFormat 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

public Calendar getCalendar(String key)

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 the DATE_FORMAT_KEY property, or if it's not defined with the DEFAULT_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

public Calendar getCalendar(String key,
                            String format)

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-localized DateFormat pattern.

Returns:

The associated Calendar

Throws:

ConversionException - is thrown if the key maps to an object that is not a Calendar.

getCalendar

public Calendar getCalendar(String key,
                            Calendar defaultValue)

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 the DATE_FORMAT_KEY property, or if it's not defined with the DEFAULT_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

public Calendar getCalendar(String key,
                            Calendar defaultValue,
                            String format)

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-localized DateFormat pattern.

Returns:

The associated Calendar.

Throws:

ConversionException - is thrown if the key maps to an object that is not a Calendar.

getCalendarList

public List<Calendar> getCalendarList(String key)

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 the DATE_FORMAT_KEY property, or if it's not defined with the DEFAULT_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

public List<Calendar> getCalendarList(String key,
                                      String format)

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-localized DateFormat 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

public List<Calendar> getCalendarList(String key,
                                      List<Calendar> defaultValue)

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 the DATE_FORMAT_KEY property, or if it's not defined with the DEFAULT_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

public List<Calendar> getCalendarList(String key,
                                      List<Calendar> defaultValue,
                                      String format)

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-localized DateFormat 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

public Calendar[] getCalendarArray(String key)

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 the DATE_FORMAT_KEY property, or if it's not defined with the DEFAULT_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

public Calendar[] getCalendarArray(String key,
                                   String format)

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-localized DateFormat 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

public Calendar[] getCalendarArray(String key,
                                   Calendar... defaultValue)

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 the DATE_FORMAT_KEY property, or if it's not defined with the DEFAULT_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

public Calendar[] getCalendarArray(String key,
                                   Calendar[] defaultValue,
                                   String format)

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-localized DateFormat 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

public Locale getLocale(String key)

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

public Locale getLocale(String key,
                        Locale defaultValue)

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

public List<Locale> getLocaleList(String key)

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

public List<Locale> getLocaleList(String key,
                                  List<Locale> defaultValue)

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

public Locale[] getLocaleArray(String key)

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

public Locale[] getLocaleArray(String key,
                               Locale... defaultValue)

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

public Color getColor(String key)

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

public Color getColor(String key,
                      Color defaultValue)

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

public List<Color> getColorList(String key)

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

public List<Color> getColorList(String key,
                                List<Color> defaultValue)

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

public Color[] getColorArray(String key)

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

public Color[] getColorArray(String key,
                             Color... defaultValue)

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.