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

Interface ConfigProperties

All Known Subinterfaces:

MutableConfigProperties

All Known Implementing Classes:

SimpleConfigProperties

public interface ConfigProperties

Simple abstraction interface for generic access to configuration properties (from spring-boot application.properties).

Since:

3.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static ConfigProperties	EMPTY	An immutable instance of ConfigProperties that is always empty
static char	KEY_SEPARATOR	The separator charactor '.' for hierarchical keys such as "spring.datasource.url".

Method Summary

Modifier and Type	Method	Description
ConfigProperties	getChild(String key)
ConfigProperties	getChild(String... keys)	Recursive variant of 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).getValue().
String	getChildValue(String... keys)	Shortcut for getChild(keys).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()

Field Detail

KEY_SEPARATOR

static final char KEY_SEPARATOR

The separator charactor '.' for hierarchical keys such as "spring.datasource.url".

See Also:

Constant Field Values

EMPTY

static final ConfigProperties EMPTY

An immutable instance of ConfigProperties that is always empty

Method Detail

getChildKeys

Set<String> getChildKeys()

Returns:

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

getChild

ConfigProperties getChild(String key)

Parameters:

key - the child key of the requested configuration value.

Returns:

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

getChild

ConfigProperties getChild(String... keys)

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

Parameters:

keys - the keys to traverse recursively.

Returns:

the descendant child reached from recursively traversing the given keys.

getChildValue

String getChildValue(String key)

Shortcut for getChild(key).getValue().

Parameters:

key - the key of the child

Returns:

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

getChildValue

String getChildValue(String... keys)

Shortcut for getChild(keys).getValue().

Parameters:

keys - the keys to traverse recursively.

Returns:

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

getValue

String getValue()

Returns:

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

getValue

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

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

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

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

boolean getValueAsBoolean()

Returns:

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

isEmpty

boolean isEmpty()

Returns:

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

toFlatMap

Map<String,String> toFlatMap()

Returns:

this ConfigProperties converted to a flat Map.

toFlatMap

Map<String,String> toFlatMap(String rootKey)

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

Map<String,Object> toHierarchicalMap()

Returns:

this ConfigProperties converted to a hierarchical Map.

inherit

MutableConfigProperties inherit(ConfigProperties parent)

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.