Package rs.baselib.configuration

Class ConfigurationUtils

java.lang.Object

rs.baselib.configuration.ConfigurationUtils

public class ConfigurationUtils
extends java.lang.Object

Useful methods for configuration issues.

Author:

ralph

Constructor Summary

Constructors

Constructor	Description
ConfigurationUtils()

Method Summary

Modifier and Type	Method	Description
static void	configure(IConfigurable configurable, Configuration config)	Configure the object accordingly.
static PropertiesBuilderParameters	createPropertiesBuilderParams(java.lang.String encoding)	Creates the basic Properties Builder parameters
static XMLBuilderParameters	createXMLBuilderParams(java.lang.String encoding)	Creates the basic XML Builder parameters
static java.lang.String	getParam(HierarchicalConfiguration<ImmutableNode> config, java.lang.String name)	Returns the config parameter with given value for attribute name.
static java.lang.String	getParam(SubnodeConfiguration config, java.lang.String name)	Returns the config parameter with given value for attribute name.
static PropertiesConfiguration	getPropertiesConfiguration(java.io.File file)	Create a Properties configuration object with UTF-8.
static PropertiesConfiguration	getPropertiesConfiguration(java.io.File file, java.lang.String encoding)	Create a Properties configuration object.
static PropertiesConfiguration	getPropertiesConfiguration(java.net.URL url)	Create a Properties configuration object with UTF-8.
static PropertiesConfiguration	getPropertiesConfiguration(java.net.URL url, java.lang.String encoding)	Create a Properties configuration object.
static PropertiesConfiguration	getPropertiesConfiguration(PropertiesBuilderParameters params)	Creates the Properties configuration object based on the given parameters.
static XMLConfiguration	getXmlConfiguration(java.io.File file)	Create a XML configuration object with UTF-8.
static XMLConfiguration	getXmlConfiguration(java.io.File file, java.lang.String encoding)	Create a XML configuration object.
static XMLConfiguration	getXmlConfiguration(java.net.URL configUrl)	Create a XML configuration object with UTF-8.
static XMLConfiguration	getXmlConfiguration(java.net.URL configUrl, java.lang.String encoding)	Create a XML configuration object.
static XMLConfiguration	getXmlConfiguration(XMLBuilderParameters params)	Creates the XML configuration object based on the given parameters.
static <T> T	load(java.lang.Class<T> clazz, Configuration config, boolean configure)	Loads an object from a configuration.
static java.lang.Object	load(java.lang.String className, Configuration config, boolean configure)	Loads an object from a configuration.
static java.lang.Object	load(Configuration config, boolean configure)	Loads an object from a configuration.

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigurationUtils

public ConfigurationUtils()

Method Details

load

public static java.lang.Object load(Configuration config, boolean configure)

Loads an object from a configuration. The object is configured if it is an instance of IConfigurable. The class will be taken from attribute [@class].

Parameters:

config - the configuration to apply

configure - whether the object shall be configured (if it is a IConfigurable).

Returns:

the object

load

public static java.lang.Object load(java.lang.String className, Configuration config, boolean configure)

Loads an object from a configuration. The object is configured if it is an instance of IConfigurable.

Parameters:

className - the name of class to be instantiated

config - the configuration to apply

configure - whether the object shall be configured (if it is a IConfigurable).

Returns:

the object

load

public static <T> T load(java.lang.Class<T> clazz, Configuration config, boolean configure)

Loads an object from a configuration. The object is configured if it is an instance of IConfigurable.

Type Parameters:

T - the type of the object to be instantiated

Parameters:

clazz - the class to be instantiated

config - the configuration to apply

configure - whether the object shall be configured (if it is a IConfigurable).

Returns:

the object

configure

public static void configure(IConfigurable configurable, Configuration config) throws ConfigurationException

Configure the object accordingly.

Parameters:

configurable - the object to be configured

config - the configuration to apply

Throws:

ConfigurationException - when a problem occurs

getParam

public static java.lang.String getParam(SubnodeConfiguration config, java.lang.String name)

Returns the config parameter with given value for attribute name.

Parameters:

config - config

name - name of param

Returns:

value of param

getParam

public static java.lang.String getParam(HierarchicalConfiguration<ImmutableNode> config, java.lang.String name)

Returns the config parameter with given value for attribute name.

Parameters:

config - config

name - name of param

Returns:

value of param

createPropertiesBuilderParams

public static PropertiesBuilderParameters createPropertiesBuilderParams(java.lang.String encoding)

Creates the basic Properties Builder parameters

Parameters:

encoding - - loading character encoding

Returns:

basic builder params

getPropertiesConfiguration

public static PropertiesConfiguration getPropertiesConfiguration(PropertiesBuilderParameters params) throws ConfigurationException

Creates the Properties configuration object based on the given parameters.

Parameters:

params - - the Properties builder parameters

Returns:

the Properties configuration

Throws:

ConfigurationException - when an error occurs

getPropertiesConfiguration

public static PropertiesConfiguration getPropertiesConfiguration(java.io.File file) throws ConfigurationException

Create a Properties configuration object with UTF-8.

Parameters:

file - - file to load from

Returns:

the configuration object

Throws:

ConfigurationException - when an error occurs

getPropertiesConfiguration

public static PropertiesConfiguration getPropertiesConfiguration(java.io.File file, java.lang.String encoding) throws ConfigurationException

Create a Properties configuration object.

Parameters:

file - - file to load from

encoding - - encoding, e.g. UTF-8

Returns:

the configuration object

Throws:

ConfigurationException - when an error occurs

getPropertiesConfiguration

public static PropertiesConfiguration getPropertiesConfiguration(java.net.URL url) throws ConfigurationException

Create a Properties configuration object with UTF-8.

Parameters:

url - - URL to load from

Returns:

the configuration object

Throws:

ConfigurationException - when an error occurs

getPropertiesConfiguration

public static PropertiesConfiguration getPropertiesConfiguration(java.net.URL url, java.lang.String encoding) throws ConfigurationException

Create a Properties configuration object.

Parameters:

url - - URL to load from

encoding - - encoding, e.g. UTF-8

Returns:

the configuration object

Throws:

ConfigurationException - when an error occurs

createXMLBuilderParams

public static XMLBuilderParameters createXMLBuilderParams(java.lang.String encoding)

Creates the basic XML Builder parameters

Parameters:

encoding - - loading character encoding

Returns:

basic builder params

getXmlConfiguration

public static XMLConfiguration getXmlConfiguration(XMLBuilderParameters params) throws ConfigurationException

Creates the XML configuration object based on the given parameters.

Parameters:

params - - the XML builder parameters

Returns:

the XML configuration

Throws:

ConfigurationException - when an error occurs

getXmlConfiguration

public static XMLConfiguration getXmlConfiguration(java.io.File file) throws ConfigurationException

Create a XML configuration object with UTF-8.

Parameters:

file - - file to load from

Returns:

the configuration object

Throws:

ConfigurationException - when an error occurs

getXmlConfiguration

public static XMLConfiguration getXmlConfiguration(java.io.File file, java.lang.String encoding) throws ConfigurationException

Create a XML configuration object.

Parameters:

file - - file to load from

encoding - - encoding, e.g. UTF-8

Returns:

the configuration object

Throws:

ConfigurationException - when an error occurs

getXmlConfiguration

public static XMLConfiguration getXmlConfiguration(java.net.URL configUrl) throws ConfigurationException

Create a XML configuration object with UTF-8.

Parameters:

configUrl - - URL to load from

Returns:

the configuration object

Throws:

ConfigurationException - when an error occurs

getXmlConfiguration

public static XMLConfiguration getXmlConfiguration(java.net.URL configUrl, java.lang.String encoding) throws ConfigurationException

Create a XML configuration object.

Parameters:

configUrl - - URL to load from

encoding - - encoding, e.g. UTF-8

Returns:

the configuration object

Throws:

ConfigurationException - when an error occurs