com.thetransactioncompany.util

Class PropertyRetriever

java.lang.Object

com.thetransactioncompany.util.PropertyRetriever

public class PropertyRetriever
extends Object

Provides typed retrieval of Properties as boolean, int, long, float, double, String, URL, URI or enum values.

Author:

Vladimir Dzhuvinov

Constructor Summary

Constructors

Constructor and Description
PropertyRetriever(Properties props) Creates a new retriever for the specified properties.
PropertyRetriever(Properties props, boolean enableSysPropOverride) Creates a new retriever for the specified properties.

Method Summary

Modifier and Type	Method and Description
boolean	getBoolean(String key) Retrieves a boolean value.
double	getDouble(String key) Retrieves a double value.
<T extends Enum<T>> T	getEnum(String key, Class<T> enumClass) Retrieves an enumerated constant.
String	getEnumString(String key, String[] enums) Retrieves an enumerated string value.
List<String>	getEnumStringList(String key, List<String> enums) Retrieves a string list consisting of one or more comma / space separated items from a enumeration.
List<String>	getEnumStringList(String key, String[] enums) Retrieves a string list consisting of one or more comma / space separated items from a enumeration.
float	getFloat(String key) Retrieves a float value.
int	getInt(String key) Retrieves an integer value.
long	getLong(String key) Retrieves a long value.
boolean	getOptBoolean(String key, boolean def) Retrieves an optional boolean value.
double	getOptDouble(String key, double def) Retrieves an optional double value.
<T extends Enum<T>> T	getOptEnum(String key, Class<T> enumClass, T def) Retrieves an optional enumerated constant.
String	getOptEnumString(String key, String[] enums, String def) Retrieves an enumerated string value.
List<String>	getOptEnumStringList(String key, List<String> enums, List<String> def) Retrieves an optional string list consisting of zero or more comma / space separated items from a enumeration.
List<String>	getOptEnumStringList(String key, String[] enums, List<String> def) Retrieves an optional string list consisting of zero or more comma / space separated items from a enumeration.
float	getOptFloat(String key, float def) Retrieves an optional float value.
int	getOptInt(String key, int def) Retrieves an optional integer value.
long	getOptLong(String key, long def) Retrieves an optional long value.
String	getOptString(String key, String def) Retrieves an optional string value.
List<String>	getOptStringList(String key, List<String> def) Retrieves an optional string list consisting of zero or more comma / space separated items.
List<String>	getOptStringListMulti(String commonPrefix, List<String> def) Retrieves an optional string list from multiple properties sharing a common prefix.
URI	getOptURI(String key, URI def) Retrieves an optional URI value.
URL	getOptURL(String key, URL def) Retrieves an optional URL value.
String	getString(String key) Retrieves a string value.
List<String>	getStringList(String key) Retrieves a string list consisting of one or more comma / space separated items.
List<String>	getStringListMulti(String commonPrefix) Retrieves a string list from multiple properties sharing a common prefix.
URI	getURI(String key) Retrieves a URI value.
URL	getURL(String key) Retrieves a URL value.
boolean	systemPropertyOverrideIsEnabled() Gets the system property override setting.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyRetriever

public PropertyRetriever(Properties props)

Creates a new retriever for the specified properties. System property override is disabled.

Parameters:

props - The properties. Must not be null.

PropertyRetriever

public PropertyRetriever(Properties props,
                         boolean enableSysPropOverride)

Creates a new retriever for the specified properties.

Parameters:

props - The properties. Must not be null.

enableSysPropOverride - If true if system properties with the same names are present they will override the specified properties, false to disable this behaviour.

Method Detail

systemPropertyOverrideIsEnabled

public boolean systemPropertyOverrideIsEnabled()

Gets the system property override setting.

Returns:

true if system property override has been enabled, false if it's disabled.

getBoolean

public boolean getBoolean(String key)
                   throws PropertyParseException

Retrieves a boolean value.

Parameters:

key - The property name.

Returns:

The property as a boolean value.

Throws:

PropertyParseException - On a missing or invalid property.

getOptBoolean

public boolean getOptBoolean(String key,
                             boolean def)
                      throws PropertyParseException

Retrieves an optional boolean value.

Parameters:

key - The property name.

def - The default value if the property value is undefined or empty.

Returns:

The property as a boolean.

Throws:

PropertyParseException - On an invalid property.

getInt

public int getInt(String key)
           throws PropertyParseException

Retrieves an integer value.

Parameters:

key - The property name.

Returns:

The property as an integer.

Throws:

PropertyParseException - On a missing or invalid property.

getOptInt

public int getOptInt(String key,
                     int def)
              throws PropertyParseException

Retrieves an optional integer value.

Parameters:

key - The property name.

def - The default value if the property value is undefined or empty.

Returns:

The property as an integer.

Throws:

PropertyParseException - On an invalid property.

getLong

public long getLong(String key)
             throws PropertyParseException

Retrieves a long value.

Parameters:

key - The property name.

Returns:

The property as a long.

Throws:

PropertyParseException - On a missing or invalid property.

getOptLong

public long getOptLong(String key,
                       long def)
                throws PropertyParseException

Retrieves an optional long value.

Parameters:

key - The property name.

def - The default value if the property value is undefined or empty.

Returns:

The property as a long.

Throws:

PropertyParseException - On an invalid property.

getFloat

public float getFloat(String key)
               throws PropertyParseException

Retrieves a float value.

Parameters:

key - The property name.

Returns:

The property as a float.

Throws:

PropertyParseException - On a missing or invalid property.

getOptFloat

public float getOptFloat(String key,
                         float def)
                  throws PropertyParseException

Retrieves an optional float value.

Parameters:

key - The property name.

def - The default value if the property value is undefined or empty.

Returns:

The property as a float.

Throws:

PropertyParseException - On an invalid property.

getDouble

public double getDouble(String key)
                 throws PropertyParseException

Retrieves a double value.

Parameters:

key - The property name.

Returns:

The property as a double.

Throws:

PropertyParseException - On a missing or invalid property.

getOptDouble

public double getOptDouble(String key,
                           double def)
                    throws PropertyParseException

Retrieves an optional double value.

Parameters:

key - The property name.

def - The default value if the property value is undefined or empty.

Returns:

The property as a double.

Throws:

PropertyParseException - On an invalid property.

getString

public String getString(String key)
                 throws PropertyParseException

Retrieves a string value.

Parameters:

key - The property name.

Returns:

The property as a string.

Throws:

PropertyParseException - On a missing or invalid property.

getOptString

public String getOptString(String key,
                           String def)
                    throws PropertyParseException

Retrieves an optional string value.

Parameters:

key - The property name.

def - The default value if the property value is undefined or empty.

Returns:

The property as a string.

Throws:

PropertyParseException - On an invalid property.

getEnumString

public String getEnumString(String key,
                            String[] enums)
                     throws PropertyParseException

Retrieves an enumerated string value. String case is ignored during comparison.

Parameters:

key - The property name.

enums - A string array defining the acceptable values.

Returns:

The property as a string.

Throws:

PropertyParseException - On a missing or invalid property.

getOptEnumString

public String getOptEnumString(String key,
                               String[] enums,
                               String def)
                        throws PropertyParseException

Retrieves an enumerated string value. String case is ignored during comparison.

Parameters:

key - The property name.

enums - A string array defining the acceptable values.

def - The default value if the property value is undefined or empty.

Returns:

The property as a string.

Throws:

PropertyParseException - On an invalid property.

getEnum

public <T extends Enum<T>> T getEnum(String key,
                                     Class<T> enumClass)
                              throws PropertyParseException

Retrieves an enumerated constant. String case is ignored during comparison.

Parameters:

key - The property name.

enumClass - The enumeration class specifying the acceptable values.

Returns:

The matching enumerated constant.

Throws:

PropertyParseException - On a missing or invalid property.

getOptEnum

public <T extends Enum<T>> T getOptEnum(String key,
                                        Class<T> enumClass,
                                        T def)
                                 throws PropertyParseException

Retrieves an optional enumerated constant. String case is ignored during comparison.

Parameters:

key - The property name.

enumClass - The enumeration class specifying the acceptable values.

def - The default value if the property value is undefined or empty.

Returns:

The matching enumerated constant.

Throws:

PropertyParseException - On a missing or invalid property.

getStringList

public List<String> getStringList(String key)
                           throws PropertyParseException

Retrieves a string list consisting of one or more comma / space separated items.

Parameters:

key - The property name.

Returns:

The string list with at least one item.

Throws:

PropertyParseException - On a missing or empty property.

getOptStringList

public List<String> getOptStringList(String key,
                                     List<String> def)
                              throws PropertyParseException

Retrieves an optional string list consisting of zero or more comma / space separated items.

Parameters:

key - The property name.

def - The default value if the property value is undefined or empty.

Returns:

The string list with zero or more items.

Throws:

PropertyParseException - On a invalid property.

getEnumStringList

public List<String> getEnumStringList(String key,
                                      String[] enums)
                               throws PropertyParseException

Retrieves a string list consisting of one or more comma / space separated items from a enumeration.

Parameters:

key - The property name.

enums - A string array defining the acceptable values.

Returns:

The string list with at least one item.

Throws:

PropertyParseException - On a missing or empty property.

getOptEnumStringList

public List<String> getOptEnumStringList(String key,
                                         String[] enums,
                                         List<String> def)
                                  throws PropertyParseException

Retrieves an optional string list consisting of zero or more comma / space separated items from a enumeration.

Parameters:

key - The property name.

enums - A string array defining the acceptable values.

def - The default value if the property value is undefined or empty.

Returns:

The string list with zero or more items.

Throws:

PropertyParseException - On a invalid property.

getEnumStringList

public List<String> getEnumStringList(String key,
                                      List<String> enums)
                               throws PropertyParseException

Retrieves a string list consisting of one or more comma / space separated items from a enumeration.

Parameters:

key - The property name.

enums - A string list defining the acceptable values.

Returns:

The string list with at least one item.

Throws:

PropertyParseException - On a missing or empty property.

getOptEnumStringList

public List<String> getOptEnumStringList(String key,
                                         List<String> enums,
                                         List<String> def)
                                  throws PropertyParseException

Retrieves an optional string list consisting of zero or more comma / space separated items from a enumeration.

Parameters:

key - The property name.

enums - A string list defining the acceptable values.

def - The default value if the property value is undefined or empty.

Returns:

The string list with zero or more items.

Throws:

PropertyParseException - On a invalid property.

getStringListMulti

public List<String> getStringListMulti(String commonPrefix)
                                throws PropertyParseException

Retrieves a string list from multiple properties sharing a common prefix.

Parameters:

commonPrefix - The common property name prefix.

Returns:

The string list with at least one item.

Throws:

PropertyParseException - On a missing or empty property.

getOptStringListMulti

public List<String> getOptStringListMulti(String commonPrefix,
                                          List<String> def)

Retrieves an optional string list from multiple properties sharing a common prefix.

Parameters:

commonPrefix - The common property name prefix.

def - The default value if no non-blank properties are found.

Returns:

The string list with at least one item or the default value.

getURI

public URI getURI(String key)
           throws PropertyParseException

Retrieves a URI value.

Parameters:

key - The property name.

Returns:

The property as a URI.

Throws:

PropertyParseException - On a missing or invalid property.

getOptURI

public URI getOptURI(String key,
                     URI def)
              throws PropertyParseException

Retrieves an optional URI value.

Parameters:

key - The property name.

def - The default value if the property value is undefined or empty.

Returns:

The property as a URL.

Throws:

PropertyParseException - On an invalid property.

getURL

public URL getURL(String key)
           throws PropertyParseException

Retrieves a URL value.

Parameters:

key - The property name.

Returns:

The property as a URL.

Throws:

PropertyParseException - On a missing or invalid property.

getOptURL

public URL getOptURL(String key,
                     URL def)
              throws PropertyParseException

Retrieves an optional URL value.

Parameters:

key - The property name.

def - The default value if the property value is undefined or empty.

Returns:

The property as a URL.

Throws:

PropertyParseException - On an invalid property.