org.apache.commons.configuration
public class DataConfiguration extends AbstractConfiguration implements Serializable
Let us know if you find this useful, the most frequently used getters are likely to be integrated in the Configuration interface in a future version.
Since: 1.1
Version: $Revision: 439648 $, $Date: 2006-09-02 22:42:10 +0200 (Sa, 02 Sep 2006) $
Field Summary | |
---|---|
protected Configuration | configuration Stores the wrapped configuration. |
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. |
static long | serialVersionUID
The serial version UID. |
Constructor Summary | |
---|---|
DataConfiguration(Configuration configuration)
Creates a new instance of DataConfiguration and sets the
wrapped configuration.
|
Method Summary | |
---|---|
protected void | addPropertyDirect(String key, Object obj) |
void | clearProperty(String key) |
boolean | containsKey(String key) |
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 | getBigDecimalList(String key)
Get a list of BigDecimals associated with the given configuration key.
|
List | getBigDecimalList(String key, List 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 | getBigIntegerList(String key)
Get a list of BigIntegers associated with the given configuration key.
|
List | getBigIntegerList(String key, List 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 | getBooleanList(String key)
Get a list of Boolean objects associated with the given
configuration key. |
List | getBooleanList(String key, List 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 | getByteList(String key)
Get a list of Byte objects associated with the given configuration key.
|
List | getByteList(String key, List 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, String format)
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[] | 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.
|
List | getCalendarList(String key)
Get a list of Calendars associated with the given configuration key.
|
List | getCalendarList(String key, String format)
Get a list of Calendars associated with the given configuration key.
|
List | getCalendarList(String key, List defaultValue)
Get a list of Calendars associated with the given configuration key.
|
List | getCalendarList(String key, List defaultValue, 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 | getColorList(String key)
Get a list of Colors associated with the given configuration key.
|
List | getColorList(String key, List defaultValue)
Get a list of Colors associated with the given configuration key.
|
Configuration | getConfiguration()
Return the configuration decorated by this DataConfiguration.
|
Date | getDate(String key)
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 | 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[] | 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.
|
List | getDateList(String key)
Get a list of Dates associated with the given configuration key.
|
List | getDateList(String key, String format)
Get a list of Dates associated with the given configuration key.
|
List | getDateList(String key, List defaultValue)
Get a list of Dates associated with the given configuration key.
|
List | getDateList(String key, List defaultValue, String format)
Get a list of Dates associated with the given configuration key.
|
String | getDefaultDateFormat()
Returns the date format specified by the user in the DATE_FORMAT_KEY
property, or the default format otherwise.
|
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 | getDoubleList(String key)
Get a list of Double objects associated with the given
configuration key. |
List | getDoubleList(String key, List 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 | getFloatList(String key)
Get a list of Float objects associated with the given configuration key.
|
List | getFloatList(String key, List 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 | getIntegerList(String key)
Get a list of Integer objects associated with the given
configuration key. |
List | getIntegerList(String key, List defaultValue)
Get a list of Integer objects associated with the given
configuration key. |
Iterator | getKeys() |
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 | getLocaleList(String key)
Get a list of Locales associated with the given configuration key.
|
List | getLocaleList(String key, List 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 | getLongList(String key)
Get a list of Long objects associated with the given configuration key.
|
List | getLongList(String key, List defaultValue)
Get a list of Long objects associated with the given configuration key.
|
Object | getProperty(String key) |
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 | getShortList(String key)
Get a list of Short objects associated with the given configuration key.
|
List | getShortList(String key, List defaultValue)
Get a list of Short objects 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 | getURLList(String key)
Get a list of URLs associated with the given configuration key.
|
List | getURLList(String key, List defaultValue)
Get a list of URLs associated with the given configuration key.
|
boolean | isEmpty() |
DataConfiguration
and sets the
wrapped configuration.
Parameters: configuration the wrapped configuration
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Parameters: key The configuration key. defaultValue The default value.
Returns: The associated List of strings.
Throws: ConversionException is thrown if the key maps to an object that is not a list of booleans.
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.
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.
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.
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.
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.
Parameters: key The configuration key. format The non-localized java.text.DateFormat pattern.
Returns: The associated Calendar
Throws: ConversionException is thrown if the key maps to an object that is not a Calendar.
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.
Parameters: key The configuration key. defaultValue The default value. format The non-localized java.text.DateFormat pattern.
Returns: The associated Calendar.
Throws: ConversionException is thrown if the key maps to an object that is not a Calendar.
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.
Parameters: key The configuration key. format The non-localized java.text.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.
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.
Parameters: key The configuration key. defaultValue The default value. format The non-localized java.text.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.
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.
Parameters: key The configuration key. format The non-localized java.text.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.
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.
Parameters: key The configuration key. defaultValue The default value. format The non-localized java.text.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.
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.
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.
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.
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.
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.
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.
Returns: the wrapped configuration
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.
Parameters: key The configuration key. format The non-localized java.text.DateFormat pattern.
Returns: The associated Date
Throws: ConversionException is thrown if the key maps to an object that is not a Date.
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.
Parameters: key The configuration key. defaultValue The default value. format The non-localized java.text.DateFormat pattern.
Returns: The associated Date.
Throws: ConversionException is thrown if the key maps to an object that is not a Date.
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.
Parameters: key The configuration key. format The non-localized java.text.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.
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.
Parameters: key The configuration key. defaultValue The default value. format The non-localized java.text.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.
Parameters: key The configuration key.
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.
Parameters: key The configuration key. format The non-localized java.text.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.
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.
Parameters: key The configuration key. defaultValue The default value. format The non-localized java.text.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.
Returns: the default date format
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.