com.sdl.delivery.configuration.values

Class ValueContainer

java.lang.Object

com.sdl.delivery.configuration.values.ValueContainer

All Implemented Interfaces:

Serializable

public class ValueContainer
extends Object
implements Serializable

A class which contains Values and their associated keys. In the future it may contain "merge" type methods.

Note: this is example code only, a version of this class may be be included in the common config module at some point in the future.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ValueContainer() Construct an empty value container.
ValueContainer(Map<String,com.sdl.delivery.configuration.Value> valueMap) Construct the container and populate it with a map of values.

Method Summary

Modifier and Type	Method and Description
void	add(String key, com.sdl.delivery.configuration.Value value) Add a value to the container.
com.sdl.delivery.configuration.Value	get(String valueKey) Returns a Value for the specified key, this never returns a null.
Set<String>	getAllPropertyKeys() Returns the keys of the all property values held within the container.
Set<String>	getChildConfigKeys() Returns the keys of the "top level" ChildConfigValues within this container (i.e.
Set<String>	getChildKeys() Returns the keys of the "top level" property values and ChildConfigValues.
Set<String>	getChildPropertyKeys() Returns the keys of the "top level" property values (that aren't "owned" by a child ChildConfigValue).
boolean	hasValues()
boolean	isEmpty()

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueContainer

public ValueContainer()

Construct an empty value container.

ValueContainer

public ValueContainer(Map<String,com.sdl.delivery.configuration.Value> valueMap)

Construct the container and populate it with a map of values.

Parameters:

valueMap - a map of property keys and their values

Method Detail

add

public void add(String key,
                com.sdl.delivery.configuration.Value value)

Add a value to the container.

Parameters:

key - the property name of the value

value - the value

getAllPropertyKeys

public Set<String> getAllPropertyKeys()

Returns the keys of the all property values held within the container. in the full dot notation form e.g. "image.whitelist.urls.localhost". It won't return the keys of any ChildConfigurationValues.

So if the container held property values:

myproperty = 0 module1.myproperty1 = value1 module2.submodule1.myproperty1 = value2 module2.submodule1.myproperty2 = value3 lastproperty = value4

This getAllPropertyKeys() method would return:

1) "myproperty" 2) "module1.myproperty1" 3) "module2.submodule1.myproperty1" 4) "module2.submodule1.myproperty2" 5) "lastproperty"

Returns:

the keys of the values held within the container

getChildConfigKeys

public Set<String> getChildConfigKeys()

Returns the keys of the "top level" ChildConfigValues within this container (i.e. the Values that contain other Values).

The term "top level" means that it won't return any ChildConfigValues which are "grandchildren".

As it will only return the "top level" children, none of the keys names returned will have embedded dots.

So if the container held property values:

myproperty = 0 module1.myproperty1 = value1 module2.submodule1.myproperty1 = value2 module2.submodule1.myproperty2 = value3 lastproperty = value4

This getChildConfigKeys() method would return:

1) "module1" - Child Configuration value 2) "module2" - Child Configuration value

it wouldn't return "module2.submodule1"

Returns:

the keys of the highest level ChildConfigValues

getChildPropertyKeys

public Set<String> getChildPropertyKeys()

Returns the keys of the "top level" property values (that aren't "owned" by a child ChildConfigValue). Property values are those that have real values (e.g. strings, numbers etc) and don't just contain other values.

So if the container held property values:

myproperty = 0 module1.myproperty1 = value1 module2.submodule1.myproperty1 = value2 module2.submodule1.myproperty2 = value3 lastproperty = value4

The getChildPropertyValueKeys() method would return:

1) "myproperty" - numeric value 2) "lastproperty" - string value

It wouldn't return "module1.myproperty1" as this is logically a child of "module1".

Returns:

the keys of the highest level ChildConfigValues

getChildKeys

public Set<String> getChildKeys()

Returns the keys of the "top level" property values and ChildConfigValues. It is the sum of the getChildConfigKeys() and getChildPropertyKeys() methods.

So if the container held property values:

myproperty = 0 module1.myproperty1 = value1 module2.submodule1.myproperty1 = value2 module2.submodule1.myproperty2 = value3 lastproperty = value4

The getChildKeys() method would return:

1) "myproperty" - which would relate to a Numeric value 2) "module1" - which would relate to a Child Configuration value 3) "module2" - which would relate to a Child Configuration value 4) "lastproperty" - which would relate to a String value

Returns:

the keys of the "top level" property values

get

public com.sdl.delivery.configuration.Value get(String valueKey)

Returns a Value for the specified key, this never returns a null.

So if the container held property values:

myproperty = 0 module1.myproperty1 = value1 module2.submodule1.myproperty1 = value2 module2.submodule1.myproperty2 = value3 lastproperty = value4

Calling the method with the following keys would give results as follows

get("myproperty") would return a numeric value of 0 get("module1.myproperty1") would return a string value of "value1" get("module1") would return a child configuration value (which contained "myproperty1") get("module1").get("myproperty1") would return a string value of "value1" get("unknown") would return a NullValue object get("unknown").get("unknown") would also return a NullValue object

Parameters:

valueKey - the value key

Returns:

the appropriate value

hasValues

public boolean hasValues()

isEmpty

public boolean isEmpty()