Module io.github.mmm.base

Package io.github.mmm.base.variable

Class VariableMap

java.lang.Object

io.github.mmm.base.variable.VariableMap

public class VariableMap
extends Object

Simple wrapper for a Map of variables.

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
VariableMap()	The constructor.
VariableMap(Map<String,Object> map)	The constructor.

Method Summary

Modifier and Type	Method	Description
<T> T	get(VariableDefinition<T> variable)
boolean	getBoolean(VariableDefinition<Boolean> variable)
boolean	getBoolean(VariableDefinition<Boolean> variable, boolean defaultValue)
Map<String,Object>	getMap()
<T> T	set(VariableDefinition<T> key, T value)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

VariableMap

public VariableMap()

The constructor.

VariableMap

public VariableMap(Map<String,Object> map)

The constructor.

Parameters:

map - the raw Map with the configuration values.

Method Details

get

public <T> T get(VariableDefinition<T> variable)

Type Parameters:

T - type of config value.

Parameters:

variable - the VariableDefinition.

Returns:

the value of the given VariableDefinition.

getBoolean

public boolean getBoolean(VariableDefinition<Boolean> variable)

Parameters:

variable - the VariableDefinition.

Returns:

the value of the given VariableDefinition.

getBoolean

public boolean getBoolean(VariableDefinition<Boolean> variable,
 boolean defaultValue)

Parameters:

variable - the VariableDefinition.

defaultValue - the additional default value returned if the variable is undefined and the given VariableDefinition has no default value.

Returns:

the value of the given VariableDefinition.

set

public <T> T set(VariableDefinition<T> key,
 T value)

Type Parameters:

T - type of config value.

Parameters:

key - the VariableDefinition.

value - the new configuration value for the given VariableDefinition.

Returns:

the old configuration value that was previously associated with the given VariableDefinition. Will be null if no value was configured before.

getMap

public Map<String,Object> getMap()

Returns:

the raw Map with the configuration.

toString

public String toString()

Overrides:

toString in class Object