com.github.hypfvieh.config

Class XmlConfigurationUtil

java.lang.Object

com.github.hypfvieh.config.XmlConfigurationUtil

public class XmlConfigurationUtil
extends Object

Utility for reading XML configuration. This uses commons-configuration to read XML files but provides some additional features like
getting values with default, converting values to lists or sets instead of using arrays.

It also supports overriding configuration entries by setting up environment properties.
Example:
You want to override a configuration key <foo><bar>value<bar><foo>
so you can use: -Dfoo.bar=newValue

To override lists or sets you can use a string delimited by ~|~ (tilde pipe tilde).

Properties overridden by the environment always takes precedence over values in configuration file.

Constructor Summary

Constructors

Constructor and Description
XmlConfigurationUtil(String _configFileName) Create a new configuration util instance and use the given filename as configuration file.

Method Summary

Modifier and Type	Method and Description
boolean	getBoolean(String _key, boolean _default) Retrieve a configuration value as boolean.
double	getDouble(String _key, double _default) Retrieve a configuration value as double.
int	getInt(String _key, int _default) Get a configuration value as int.
String	getString(String _key) Get a config value as String.
String	getString(String _key, String _default) Returns a config value as String, or the default string if _key could not be found.
List<String>	getStringList(String _key) Returns the results of key as ArrayList.
Set<String>	getStringSet(String _key, Class<? extends Set> _setClass) Returns a result as Set of the given Set-Subclass.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlConfigurationUtil

public XmlConfigurationUtil(String _configFileName)
                     throws FileNotFoundException

Create a new configuration util instance and use the given filename as configuration file.

Parameters:

_configFileName -

Throws:

FileNotFoundException

Method Detail

getString

public String getString(String _key)

Get a config value as String. If _key could not be found, null is returned.

Parameters:

_key -

Returns:

getString

public String getString(String _key,
                        String _default)

Returns a config value as String, or the default string if _key could not be found.

Parameters:

_key -

_default -

Returns:

getInt

public int getInt(String _key,
                  int _default)

Get a configuration value as int. If _key not found, or not an integer, default is returned.

Parameters:

_key -

_default -

Returns:

getDouble

public double getDouble(String _key,
                        double _default)

Retrieve a configuration value as double. If _key could not be found, or value was not of type 'double', default is returned.

Parameters:

_key -

_default -

Returns:

getBoolean

public boolean getBoolean(String _key,
                          boolean _default)

Retrieve a configuration value as boolean. If _key could not be found, default is returned.
All other values will be tried to read as boolean.

Considered true values are:

• 1
• y
• j
• ja
• yes
• true
• enabled
• enable
• active

All other values are considered to be false.

Parameters:

_key -

_default -

Returns:

getStringList

public List<String> getStringList(String _key)

Returns the results of key as ArrayList.

Parameters:

_key -

Returns:

never null, maybe empty list

getStringSet

public Set<String> getStringSet(String _key,
                                Class<? extends Set> _setClass)

Returns a result as Set of the given Set-Subclass. If given Set-Class is null or could not be instantiated, TreeSet is used.

Parameters:

_key -

_setClass -

Returns: