Class DataConfiguration

All Implemented Interfaces:
Serializable, Configuration

public class DataConfiguration extends AbstractConfiguration implements Serializable
Decorator providing additional getters for any Configuration. This extended Configuration supports more types: Lists and arrays are available for all 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.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.
Since:
1.1
Version:
$Id: DataConfiguration.java 1234985 2012-01-23 21:09:09Z oheger $
Author:
Emmanuel Bourg
See Also:
  • Field Details

  • Constructor Details

    • DataConfiguration

      public DataConfiguration(Configuration configuration)
      Creates a new instance of DataConfiguration 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

      public Object getProperty(String key)
      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 the Configuration 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 the Configuration 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 interface Configuration
      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

      protected void addPropertyDirect(String key, Object obj)
      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
      obj - object to store
    • addProperty

      public void addProperty(String key, Object value)
      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 call
      addProperty("resource.loader", "classpath")
      Then you will end up with a List like the following:
      ["file", "classpath"]
      Specified by:
      addProperty in interface Configuration
      Overrides:
      addProperty in class AbstractConfiguration
      Parameters:
      key - The key to add the property to.
      value - The value to add.
    • isEmpty

      public boolean isEmpty()
      Description copied from interface: Configuration
      Check if the configuration is empty.
      Specified by:
      isEmpty in interface Configuration
      Returns:
      true if the configuration contains no property, false otherwise.
    • containsKey

      public boolean containsKey(String key)
      Description copied from interface: Configuration
      Check if the configuration contains the specified key.
      Specified by:
      containsKey in interface Configuration
      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

      public void clearProperty(String key)
      Description copied from class: AbstractConfiguration
      Removes the specified property from this configuration. This implementation performs some preparations and then delegates to clearPropertyDirect(), which will do the real work.
      Specified by:
      clearProperty in interface Configuration
      Overrides:
      clearProperty in class AbstractConfiguration
      Parameters:
      key - the key to be removed
    • setProperty

      public void setProperty(String key, Object value)
      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 interface Configuration
      Overrides:
      setProperty in class AbstractConfiguration
      Parameters:
      key - The key of the property to change
      value - The new value
    • getKeys

      public Iterator<String> 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's remove() 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 calling Configuration.clearProperty(String) for this property. So it is highly recommended to avoid using the iterator's remove() method.
      Specified by:
      getKeys in interface Configuration
      Returns:
      An Iterator.
    • get

      public <T> T get(Class<T> cls, String key)
      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 unless AbstractConfiguration.isThrowExceptionOnMissing() is set to true.
      Type Parameters:
      T - the target type of the value
      Parameters:
      cls - the target class of the value
      key - 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=true
      ConversionException - if the value is not compatible with the requested type
      Since:
      1.5
    • get

      public <T> T get(Class<T> cls, String key, T defaultValue)
      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 value
      key - the key of the value
      defaultValue - 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

      public <T> List<T> getList(Class<T> cls, String key)
      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 list
      key - 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

      public <T> List<T> getList(Class<T> cls, String key, List<T> defaultValue)
      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 list
      key - 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

      public Object getArray(Class<?> cls, String key)
      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 array
      key - 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

      public Object getArray(Class<?> cls, String key, Object defaultValue)
      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 array
      key - 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

      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

      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

      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

      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

      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

      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

      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.
    • 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

      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

      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

      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.