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

Class EmptyConfigProperties

java.lang.Object

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

All Implemented Interfaces:

ConfigProperties

class EmptyConfigProperties
extends Object
implements ConfigProperties

Implementation of ConfigProperties that always is empty.

Since:

3.0.0

Field Summary

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

EMPTY, KEY_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
EmptyConfigProperties()

Method Summary

Modifier and Type	Method	Description
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).
Set<String>	getChildKeys()
String	getChildValue(String key)	Shortcut for getChild(key).ConfigProperties.getValue().
String	getChildValue(String... keys)	Shortcut for getChild(keys).ConfigProperties.getValue().
String	getValue()
<T> T	getValue(Class<T> type)
<T> T	getValue(Class<T> type, T defaultValue)
boolean	getValueAsBoolean()
MutableConfigProperties	inherit(ConfigProperties parent)
boolean	isEmpty()
Map<String,String>	toFlatMap()
Map<String,String>	toFlatMap(String rootKey)
Map<String,Object>	toHierarchicalMap()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EmptyConfigProperties

EmptyConfigProperties()

Method Detail

getChildKeys

public Set<String> getChildKeys()

Specified by:

getChildKeys in interface ConfigProperties

Returns:

the Set of the direct child keys available in the ConfigProperties-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

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.

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.

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.

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.

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.

toHierarchicalMap

public Map<String,Object> toHierarchicalMap()

Specified by:

toHierarchicalMap in interface ConfigProperties

Returns:

this ConfigProperties converted to a hierarchical Map.

inherit

public MutableConfigProperties inherit(ConfigProperties parent)

Specified by:

inherit in interface ConfigProperties

Parameters:

parent - 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.

toString

public String toString()

Overrides:

toString in class Object