org.eth.cyril.util.configuration

Class Configurations

java.lang.Object

org.eth.cyril.util.configuration.Configurations

public class Configurations
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Configurations()

Method Summary

Modifier and Type	Method and Description
static ConfigurationArray	emptyArray() Get an empty array.
static Configuration	emptyConfiguration() Get an empty configuration.
static Configuration	getActiveConfiguration() Get the currently active configuration.
static ConfigurationBuilder	getBuilder() Returns a new ConfigurationBuilder instance.
static Configuration	getConfiguration(java.lang.Object key) Get the configuration for the given key.
static java.util.Collection<java.lang.Object>	getConfigurationKeys() Get all keys which are mapped to a configuration.
static Configuration	getOrEmpty(ConfigurationArray from, int index) Tries to get a configuration from the given array.
static Configuration	getOrEmpty(Configuration from, java.lang.String property) Tries to get an inner configuration from the given configuration.
static Configuration	getOrEmpty(java.lang.String property) Equal to calling getOrEmpty(Configuration, String) with the currently active configuration getActiveConfiguration().
static ConfigurationArray	getOrEmptyArray(ConfigurationArray from, int index) Tries to get an array from the given array.
static ConfigurationArray	getOrEmptyArray(Configuration from, java.lang.String property) Tries to get an array from the given configuration.
static ConfigurationArray	getOrEmptyArray(java.lang.String property) Equal to calling getOrEmptyArray(String) with the currently active configuration getActiveConfiguration().
static EditableConfiguration	makeEditable(Configuration configuration) Returns an editable version of the given configuration.
static EditableConfigurationArray	makeEditable(ConfigurationArray array) Returns an editable version of the given array.
static void	setActiveConfiguration(Configuration configuration) Set the currently active configuration.
static void	setConfiguration(java.lang.Object key, Configuration configuration) Set the configuration for the given key.

Methods inherited from class java.lang.Object

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

Constructor Detail

Configurations

public Configurations()

Method Detail

makeEditable

public static EditableConfiguration makeEditable(Configuration configuration)

Returns an editable version of the given configuration. If the given configuration is already editable, itself is returned. Otherwise, an editable wrapper for the configuration is given.

Parameters:

configuration - The configuration to be made editable. May be null.

makeEditable

public static EditableConfigurationArray makeEditable(ConfigurationArray array)

Returns an editable version of the given array. If the given array is already editable, itself is returned. Otherwise, an editable wrapper for the array is given.

Parameters:

array - The array to be made editable. May be null.

setActiveConfiguration

public static void setActiveConfiguration(Configuration configuration)

Set the currently active configuration.

Parameters:

configuration - The new active configuration.

getActiveConfiguration

public static Configuration getActiveConfiguration()

Get the currently active configuration.

setConfiguration

public static void setConfiguration(java.lang.Object key,
                                    Configuration configuration)

Set the configuration for the given key.

Parameters:

key - The key to set the configuration for.

configuration - The new configuration. May not be null.

getConfiguration

public static Configuration getConfiguration(java.lang.Object key)

Get the configuration for the given key. Returns null if no configuration for the key exists.

Parameters:

key - The key to get the configuration for.

getConfigurationKeys

public static java.util.Collection<java.lang.Object> getConfigurationKeys()

Get all keys which are mapped to a configuration. getConfiguration(Object) will not return null for these keys.

Returns:

The keys to which configurations are mapped.

emptyConfiguration

public static Configuration emptyConfiguration()

Get an empty configuration. It is not defined whether the configuration is editable.

emptyArray

public static ConfigurationArray emptyArray()

Get an empty array. It is not defined whether the array is editable.

getOrEmpty

public static Configuration getOrEmpty(Configuration from,
                                       java.lang.String property)

Tries to get an inner configuration from the given configuration. Returns an empty configuration if it doesn't exist.

Parameters:

from - The configuration to get the inner configuration from.

property - The name of the property to get the inner configuration from.

getOrEmpty

public static Configuration getOrEmpty(java.lang.String property)

Equal to calling getOrEmpty(Configuration, String) with the currently active configuration getActiveConfiguration().

getOrEmpty

public static Configuration getOrEmpty(ConfigurationArray from,
                                       int index)

Tries to get a configuration from the given array. Returns an empty configuration if it doesn't exist.

Parameters:

from - The array to get the configuration from.

index - The index to get the inner configuration from.

getOrEmptyArray

public static ConfigurationArray getOrEmptyArray(Configuration from,
                                                 java.lang.String property)

Tries to get an array from the given configuration. Returns an empty array if it doesn't exist.

Parameters:

from - The configuration to get the array from.

property - The name of the property to get the array from.

getOrEmptyArray

public static ConfigurationArray getOrEmptyArray(java.lang.String property)

Equal to calling getOrEmptyArray(String) with the currently active configuration getActiveConfiguration().

getOrEmptyArray

public static ConfigurationArray getOrEmptyArray(ConfigurationArray from,
                                                 int index)

Tries to get an array from the given array. Returns an empty array if it doesn't exist.

Parameters:

from - The array to get the array from.

index - The index to get the array from.

getBuilder

public static ConfigurationBuilder getBuilder()

Returns a new ConfigurationBuilder instance.