Package com.devonfw.module.basic.common.api.config

Class SimpleConfigProperties

java.lang.Object

com.devonfw.module.basic.common.api.config.SimpleConfigProperties

All Implemented Interfaces:

ConfigProperties

Direct Known Subclasses:

MutableConfigPropertiesImpl

public class SimpleConfigProperties
extends Object
implements ConfigProperties

Simple implementation of ConfigProperties.

Since:

3.0.0

Field Summary

Fields

Modifier and Type	Field	Description
private Set<String>	childKeys
private Map<String,SimpleConfigProperties>	childMap
private String	nodeKey
private int	nodeModifications
private String	value

Fields inherited from interface com.devonfw.module.basic.common.api.config.ConfigProperties

EMPTY, KEY_SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SimpleConfigProperties(String key)	The constructor.

Method Summary

Modifier and Type	Method	Description
protected static SimpleConfigProperties	asSimple(ConfigProperties configProperties)
protected static String	composeKey(String parentKey, String childKey)
protected SimpleConfigProperties	createChild(String childKey, boolean create)
protected void	fromFlatMap(Map<String,String> map)
protected void	fromHierarchicalMap(Map<String,Object> map)
protected ConfigProperties	getChild(boolean create, String... keys)
ConfigProperties	getChild(String key)
ConfigProperties	getChild(String... keys)	Recursive variant of ConfigProperties.getChild(String) such that config.getChild(key1, ..., keyN) is the same as config.getChild(key1)...getChild(keyN).
protected ConfigProperties	getChild(String key, boolean create)
Set<String>	getChildKeys()
String	getChildValue(String key)	Shortcut for getChild(key).ConfigProperties.getValue().
String	getChildValue(String... keys)	Shortcut for getChild(keys).ConfigProperties.getValue().
protected String	getNodeKey()
protected int	getNodeModifications()
String	getValue()
<T> T	getValue(Class<T> type)
<T> T	getValue(Class<T> type, T defaultValue)
boolean	getValueAsBoolean()
MutableConfigProperties	inherit(ConfigProperties parentNode)
boolean	isEmpty()
static ConfigProperties	ofFlatMap(String key, Map<String,String> map)	Converts a flat Map of configuration values to hierarchical ConfigProperties.
static ConfigProperties	ofFlatMap(Map<String,String> map)
static ConfigProperties	ofHierarchicalMap(String key, Map<String,Object> map)	Converts a hierarchical Map of configuration values to ConfigProperties.
static ConfigProperties	ofHierarchicalMap(Map<String,Object> map)
protected void	setValue(String value)
Map<String,String>	toFlatMap()
Map<String,String>	toFlatMap(String rootKey)
private void	toFlatMap(String key, Map<String,String> map)
Map<String,Object>	toHierarchicalMap()
private void	toHierarchicalMap(Map<String,Object> map)
String	toString()
protected void	updateChildren()	Updates the child-nodes in case of a mutable copy node.

Methods inherited from class java.lang.Object

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

Field Detail

nodeKey

private final String nodeKey

childMap

private final Map<String,SimpleConfigProperties> childMap

childKeys

private final Set<String> childKeys

value

private String value

nodeModifications

private int nodeModifications

Constructor Detail

SimpleConfigProperties

protected SimpleConfigProperties(String key)

The constructor.

Parameters:

key - the hierarchical key of this ConfigProperties-node.

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface ConfigProperties

Returns:

true if this is an empty ConfigProperties-node that neither has a value nor any child.

getNodeKey

protected String getNodeKey()

Returns:

the absolute key of this ConfigProperties-node.

getNodeModifications

protected int getNodeModifications()

Returns:

the modification counter that gets incremented whenever a child node is added.

getChildKeys

public Set<String> getChildKeys()

Specified by:

getChildKeys in interface ConfigProperties

Returns:

the Set of the direct child keys available in the ConfigProperties-node.

updateChildren

protected void updateChildren()

Updates the child-nodes in case of a mutable copy node.

getChild

public ConfigProperties getChild(String key)

Specified by:

getChild in interface ConfigProperties

Parameters:

key - the child key of the requested configuration value.

Returns:

the child ConfigProperties. Will be an empty child if undefined.

getChild

protected ConfigProperties getChild(String key,
                                    boolean create)

Parameters:

key - the key of the requested child.

create - - true to create if not exits, false otherwise.

Returns:

the requested child.

See Also:

getChild(String)

createChild

protected SimpleConfigProperties createChild(String childKey,
                                             boolean create)

Parameters:

childKey - the key segment of the child to create.

create - - true to force creation, false otherwise.

Returns:

the new child or null.

getChild

public ConfigProperties getChild(String... keys)

Description copied from interface: ConfigProperties

Recursive variant of ConfigProperties.getChild(String) such that config.getChild(key1, ..., keyN) is the same as config.getChild(key1)...getChild(keyN).

Specified by:

getChild in interface ConfigProperties

Parameters:

keys - the keys to traverse recursively.

Returns:

the descendant child reached from recursively traversing the given keys.

getChild

protected ConfigProperties getChild(boolean create,
                                    String... keys)

Parameters:

create - - true to create if not exits, false otherwise.

keys - the key segments of the requested child.

Returns:

the requested child.

getValue

public String getValue()

Specified by:

getValue in interface ConfigProperties

Returns:

the value of this ConfigProperties-node. May be null.

getValue

public <T> T getValue(Class<T> type)

Specified by:

getValue in interface ConfigProperties

Type Parameters:

T - the requested type

Parameters:

type - the Class reflecting the requested result type.

Returns:

the value of this ConfigProperties-node converted to the given type. Will be null if undefined.

getValue

public <T> T getValue(Class<T> type,
                      T defaultValue)

Specified by:

getValue in interface ConfigProperties

Type Parameters:

T - the requested type

Parameters:

type - the Class reflecting the requested result type.

defaultValue - the value returned as default if the actual value is undefined.

Returns:

the value of this ConfigProperties-node converted to the given type. Will be defaultValue if undefined.

getValueAsBoolean

public boolean getValueAsBoolean()

Specified by:

getValueAsBoolean in interface ConfigProperties

Returns:

the ConfigProperties.getValue(Class, Object) as boolean with false as default.

setValue

protected void setValue(String value)

Parameters:

value - new value of getValue().

getChildValue

public String getChildValue(String key)

Description copied from interface: ConfigProperties

Shortcut for getChild(key).ConfigProperties.getValue().

Specified by:

getChildValue in interface ConfigProperties

Parameters:

key - the key of the child

Returns:

the value of this ConfigProperties-node. May be null.

getChildValue

public String getChildValue(String... keys)

Description copied from interface: ConfigProperties

Shortcut for getChild(keys).ConfigProperties.getValue().

Specified by:

getChildValue in interface ConfigProperties

Parameters:

keys - the keys to traverse recursively.

Returns:

the value of the descendant child traversed by keys. May be null.

toFlatMap

public Map<String,String> toFlatMap()

Specified by:

toFlatMap in interface ConfigProperties

Returns:

this ConfigProperties converted to a flat Map.

toFlatMap

public Map<String,String> toFlatMap(String rootKey)

Specified by:

toFlatMap in interface ConfigProperties

Parameters:

rootKey - the root key used as prefix for the keys separated with a dot if not empty. Typically the empty String.

Returns:

this ConfigProperties converted to a flat Map.

toFlatMap

private void toFlatMap(String key,
                       Map<String,String> map)

toHierarchicalMap

public Map<String,Object> toHierarchicalMap()

Specified by:

toHierarchicalMap in interface ConfigProperties

Returns:

this ConfigProperties converted to a hierarchical Map.

toHierarchicalMap

private void toHierarchicalMap(Map<String,Object> map)

fromFlatMap

protected void fromFlatMap(Map<String,String> map)

Parameters:

map - the flat Map of the configuration values.

See Also:

ofFlatMap(String, Map)

fromHierarchicalMap

protected void fromHierarchicalMap(Map<String,Object> map)

Parameters:

map - the hierarchical Map of the configuration values.

See Also:

ofHierarchicalMap(String, Map)

toString

public String toString()

Overrides:

toString in class Object

inherit

public MutableConfigProperties inherit(ConfigProperties parentNode)

Specified by:

inherit in interface ConfigProperties

Parameters:

parentNode - the parent ConfigProperties to extend.

Returns:

a new instance of ConfigProperties with all children and value(s) from this ConfigProperties-tree and all children and value(s) inherited from the given parent ConfigProperties-tree if they are undefined in this tree.

ofFlatMap

public static ConfigProperties ofFlatMap(Map<String,String> map)

Parameters:

map - the flat Map of the configuration values.

Returns:

the root ConfigProperties-node of the given flat Map converted to hierarchical ConfigProperties.

See Also:

ofFlatMap(String, Map)

ofFlatMap

public static ConfigProperties ofFlatMap(String key,
                                         Map<String,String> map)

Converts a flat Map of configuration values to hierarchical ConfigProperties. E.g. the flat map {"foo.bar.some"="some-value", "foo.bar.other"="other-value"} would result in ConfigProperties myRoot such that myRoot.getChild("foo", "bar").getChildKeys() returns the Collection {"some", "other"} and myRoot.getValue("foo.bar.some") returns "my-value".

Parameters:

key - the top-level key of the returned root ConfigProperties-node. Typically the empty string ("") for root.

map - the flat Map of the configuration values.

Returns:

the root ConfigProperties-node of the given flat Map converted to hierarchical ConfigProperties.

ofHierarchicalMap

public static ConfigProperties ofHierarchicalMap(Map<String,Object> map)

Parameters:

map - the hierarchical Map of the configuration values.

Returns:

the root ConfigProperties-node of the given hierarchical Map converted to ConfigProperties.

See Also:

ofHierarchicalMap(String, Map)

ofHierarchicalMap

public static ConfigProperties ofHierarchicalMap(String key,
                                                 Map<String,Object> map)

Converts a hierarchical Map of configuration values to ConfigProperties. E.g. the hierarchical map {"foo"={"bar"={"some"="my-value", "other"="magic-value"}}} would result in ConfigProperties myRoot such that myRoot.getChild("foo", "bar").getChildKeys() returns the Collection {"some", "other"} and myRoot.getValue("foo.bar.some") returns "my-value".

Parameters:

key - the top-level key of the returned root ConfigProperties-node. Typically the empty string ("") for root.

map - the hierarchical Map of the configuration values.

Returns:

the root ConfigProperties-node of the given hierarchical Map converted to ConfigProperties.

composeKey

protected static String composeKey(String parentKey,
                                   String childKey)

Parameters:

parentKey - the parent key.

childKey - the child key.

Returns:

the composed key.

asSimple

protected static SimpleConfigProperties asSimple(ConfigProperties configProperties)

Parameters:

configProperties - the ConfigProperties.

Returns:

the given ConfigProperties as SimpleConfigProperties or null if no such instance.