net.obvj.confectory

Class ConfigurationContainer

java.lang.Object

net.obvj.confectory.ConfigurationContainer

public class ConfigurationContainer
extends Object

An object that holds multiple Configuration objects and retrieves configuration data seamlessly, by namespace and key.

The Configuration objects are sorted by precedence (from highest to lowest). So, in case of key collision, the object with the highest precedence will be selected first. The container may still select other lower-precedence Configuration objects if a key is not found in the highest-precedence Configuration.

To create a new empty container, use the default constructor new ConfigurationContainer(). To create a new container with preset Configuration objects, pass them as "var-args".

Use the add(Configuration) method at any time to register new objects inside the container.

To retrieve Configuration data, use any of the getter methods, specifying a namespace and key.

Single-argument getter methods can be used to retrieve data from Configuration objects that do not have a declared namespace. These methods may also retrieve data from all Configuration objects if the selected data-fetch strategy is LENIENT.

Each container may have a custom DataFetchStrategy and NullValueProvider. Both objects may be specified at container construction time and modified using the setter methods at anytime. If not specified, the container uses the default objects configured via ConfectorySettings.

Since:

0.1.0

Author:

oswaldo.bapvic.jr (Oswaldo Junior)

See Also:

Configuration, DataFetchStrategy

Constructor Summary

Constructors

Constructor and Description
ConfigurationContainer(Configuration<?>... configs) Builds a new ConfigurationContainer with an arbitrary number of preset Configuration objects to be registered.
ConfigurationContainer(DataFetchStrategy dataFetchStrategy, Configuration<?>... configs) Builds a new ConfigurationContainer with a custom DataFetchStrategy and an arbitrary number of preset Configuration objects.
ConfigurationContainer(DataFetchStrategy dataFetchStrategy, NullValueProvider nullValueProvider, Configuration<?>... configs) Builds a new ConfigurationContainer with custom DataFetchStrategy and NullValueProvider and an arbitrary number of preset Configuration objects.
ConfigurationContainer(NullValueProvider nullValueProvider, Configuration<?>... configs) Builds a new ConfigurationContainer with a custom NullValueProvider and an arbitrary number of preset Configuration objects.

Method Summary

Modifier and Type	Method and Description
void	add(Configuration<?> configuration) Adds the specified Configuration to this container.
void	addAll(ConfigurationContainer source) Copies all of the Configuration objects from another container to this container.
void	clear() Removes all of the Configuration objects from this container.
boolean	getBooleanProperty(String key) Returns the boolean value associated with the specified key in the default namespace.
boolean	getBooleanProperty(String namespace, String key) Returns the boolean value associated with the specified key in the specified namespace.
DataFetchStrategy	getDataFetchStrategy() Returns the DataFetchStrategy associated with this container.
double	getDoubleProperty(String key) Returns the double value associated with the specified key in the default namespace.
double	getDoubleProperty(String namespace, String key) Returns the double value associated with the specified key in the specified namespace.
int	getIntProperty(String key) Returns the int value associated with the specified key in the default namespace.
int	getIntProperty(String namespace, String key) Returns the int value associated with the specified key in the specified namespace.
long	getLongProperty(String key) Returns the long value associated with the specified key in the default namespace.
long	getLongProperty(String namespace, String key) Returns the long value associated with the specified key in the specified namespace.
Collection<String>	getNamespaces() Returns all of the namespaces defined inside this container.
NullValueProvider	getNullValueProvider() Returns the NullValueProvider associated with this container.
String	getStringProperty(String key) Returns the String value associated with the specified key in the default namespace.
String	getStringProperty(String namespace, String key) Returns the String value associated with the specified key in the specified namespace.
void	setDataFetchStrategy(DataFetchStrategy strategy) Defines a custom DataFetchStrategy for this container.
void	setNullValueProvider(NullValueProvider provider) Defines a custom NullValueProvider for this container.
long	size(String namespace) Returns the number of Configuration objects associated with the specified namespace in this container.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationContainer

public ConfigurationContainer(Configuration<?>... configs)

Builds a new ConfigurationContainer with an arbitrary number of preset Configuration objects to be registered.

Parameters:

configs - an arbitrary number of Configuration objects (zero or more) to be registered at constructor time

ConfigurationContainer

public ConfigurationContainer(DataFetchStrategy dataFetchStrategy,
                              Configuration<?>... configs)

Builds a new ConfigurationContainer with a custom DataFetchStrategy and an arbitrary number of preset Configuration objects.

Parameters:

dataFetchStrategy - an optional DataFetchStrategy to be applied by this container; null is allowed and means the default strategy will be applied

configs - an arbitrary number of Configuration objects (zero or more) to be registered at constructor time

ConfigurationContainer

public ConfigurationContainer(NullValueProvider nullValueProvider,
                              Configuration<?>... configs)

Builds a new ConfigurationContainer with a custom NullValueProvider and an arbitrary number of preset Configuration objects.

Parameters:

nullValueProvider - an optional NullValueProvider to be used when keys are not found; null is allowed and means the default provider will be applied

configs - an arbitrary number of Configuration objects (zero or more) to be registered at constructor time

ConfigurationContainer

public ConfigurationContainer(DataFetchStrategy dataFetchStrategy,
                              NullValueProvider nullValueProvider,
                              Configuration<?>... configs)

Builds a new ConfigurationContainer with custom DataFetchStrategy and NullValueProvider and an arbitrary number of preset Configuration objects.

Parameters:

dataFetchStrategy - an optional DataFetchStrategy to be applied by this container; null is allowed and means the default strategy will be applied

nullValueProvider - an optional NullValueProvider to be used when keys are not found; null is allowed and means the default provider will be applied

configs - an arbitrary number of Configuration objects (zero or more) to be registered at constructor time

Method Detail

getDataFetchStrategy

public DataFetchStrategy getDataFetchStrategy()

Returns the DataFetchStrategy associated with this container.

Returns:

a DataFetchStrategy

setDataFetchStrategy

public void setDataFetchStrategy(DataFetchStrategy strategy)

Defines a custom DataFetchStrategy for this container.

Parameters:

strategy - the DataFetchStrategy to set; not null

Throws:

NullPointerException - if the specified strategy is null

getNullValueProvider

public NullValueProvider getNullValueProvider()

Returns the NullValueProvider associated with this container.

Returns:

a NullValueProvider instance

setNullValueProvider

public void setNullValueProvider(NullValueProvider provider)

Defines a custom NullValueProvider for this container.

Parameters:

provider - the NullValueProvider to set; not null

Throws:

NullPointerException - if the specified provider is null

add

public void add(Configuration<?> configuration)

Adds the specified Configuration to this container.

Parameters:

configuration - the Configuration to be added to the container

addAll

public void addAll(ConfigurationContainer source)

Copies all of the Configuration objects from another container to this container.

Parameters:

source - the source container which Configuration objects are to be stored in this container; null is allowed

clear

public void clear()

Removes all of the Configuration objects from this container.

getBooleanProperty

public boolean getBooleanProperty(String key)

Returns the boolean value associated with the specified key in the default namespace.

Parameters:

key - the property key

Returns:

the boolean value associated with the specified key

getBooleanProperty

public boolean getBooleanProperty(String namespace,
                                  String key)

Returns the boolean value associated with the specified key in the specified namespace.

Parameters:

namespace - the namespace to be used

key - the property key

Returns:

the boolean value associated with the specified key

getIntProperty

public int getIntProperty(String key)

Returns the int value associated with the specified key in the default namespace.

Parameters:

key - the property key

Returns:

the int value associated with the specified key

getIntProperty

public int getIntProperty(String namespace,
                          String key)

Returns the int value associated with the specified key in the specified namespace.

Parameters:

namespace - the namespace to be used

key - the property key

Returns:

the int value associated with the specified key

getLongProperty

public long getLongProperty(String key)

Returns the long value associated with the specified key in the default namespace.

Parameters:

key - the property key

Returns:

the long value associated with the specified key

getLongProperty

public long getLongProperty(String namespace,
                            String key)

Returns the long value associated with the specified key in the specified namespace.

Parameters:

namespace - the namespace to be used

key - the property key

Returns:

the long value associated with the specified key

getDoubleProperty

public double getDoubleProperty(String key)

Returns the double value associated with the specified key in the default namespace.

Parameters:

key - the property key

Returns:

the double value associated with the specified key

getDoubleProperty

public double getDoubleProperty(String namespace,
                                String key)

Returns the double value associated with the specified key in the specified namespace.

Parameters:

namespace - the namespace to be used

key - the property key

Returns:

the double value associated with the specified key

getStringProperty

public String getStringProperty(String key)

Returns the String value associated with the specified key in the default namespace.

Parameters:

key - the property key

Returns:

the String value associated with the specified key

getStringProperty

public String getStringProperty(String namespace,
                                String key)

Returns the String value associated with the specified key in the specified namespace.

Parameters:

namespace - the namespace to be used

key - the property key

Returns:

the String value associated with the specified key

size

public long size(String namespace)

Returns the number of Configuration objects associated with the specified namespace in this container.

Parameters:

namespace - the namespace to be tested

Returns:

the number of Configuration objects associated with the specified namespace

getNamespaces

public Collection<String> getNamespaces()

Returns all of the namespaces defined inside this container.

Returns:

a set of namespaces