Package io.openems.common.types

Class ConfigurationProperty<T>

java.lang.Object

io.openems.common.types.ConfigurationProperty<T>

Type Parameters:

T - type of the configuration property

public class ConfigurationProperty<T>
extends Object

Holds the value of a configuration property.

This implementation is similar to Optional<>, but it makes a difference if a value is 'null' - i.e. configuration property should be set to 'null' - or 'not set' - i.e. configuration property should not be changed.

Method Summary

Modifier and Type	Method	Description
static <T> ConfigurationProperty<T>	asNotSet()	Creates a ConfigurationProperty object with 'not set' value.
static <T> ConfigurationProperty<T>	asNull()	Creates a ConfigurationProperty object with 'null' value.
static <T> ConfigurationProperty<T>	fromJsonElement(Optional<com.google.gson.JsonElement> element, ThrowingFunction<com.google.gson.JsonElement,T,OpenemsError.OpenemsNamedException> function)	Creates a ConfigurationProperty object from a JsonElement value.
T	getValue()
boolean	isNull()
boolean	isSet()
boolean	isSetAndNotNull()
static <T> ConfigurationProperty<T>	of(T value)	Creates a ConfigurationProperty object from a value.

Methods inherited from class java.lang.Object

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

Method Details

of

public static <T> ConfigurationProperty<T> of(T value)

Creates a ConfigurationProperty object from a value.

Type Parameters:

T - the type of the value

Parameters:

value - the value

Returns:

the ConfigurationProperty

asNull

public static <T> ConfigurationProperty<T> asNull()

Creates a ConfigurationProperty object with 'null' value.

Type Parameters:

T - the type of the value

Returns:

the ConfigurationProperty

asNotSet

public static <T> ConfigurationProperty<T> asNotSet()

Creates a ConfigurationProperty object with 'not set' value.

Type Parameters:

T - the type of the value

Returns:

the ConfigurationProperty

fromJsonElement

public static <T> ConfigurationProperty<T> fromJsonElement(Optional<com.google.gson.JsonElement> element,
 ThrowingFunction<com.google.gson.JsonElement,T,OpenemsError.OpenemsNamedException> function)
                                                    throws OpenemsError.OpenemsNamedException

Creates a ConfigurationProperty object from a JsonElement value.

Type Parameters:

T - the type of the value

Parameters:

element - the JsonElement value

function - conversion function from JsonElement to type T

Returns:

the ConfigurationProperty

Throws:

OpenemsError.OpenemsNamedException - on error

getValue

public T getValue()

isNull

public boolean isNull()

isSet

public boolean isSet()

isSetAndNotNull

public boolean isSetAndNotNull()