ch.jalu.configme.properties

Class OptionalProperty<T>

java.lang.Object

ch.jalu.configme.properties.BaseProperty<Optional<T>>

ch.jalu.configme.properties.OptionalProperty<T>

All Implemented Interfaces:

Property<Optional<T>>

public class OptionalProperty<T>
extends BaseProperty<Optional<T>>

Property which may be empty.

Wraps another property with an Optional: if a property is not present in the property resource, Optional.empty() is returned.

Constructor Summary

Constructors

Constructor and Description
OptionalProperty(Property<T> baseProperty)
OptionalProperty(Property<T> baseProperty, T defaultValue)

Method Summary

Modifier and Type	Method and Description
protected Optional<T>	getFromReader(PropertyReader reader) Constructs the value of the property from the property reader.
boolean	isPresent(PropertyReader reader) Returns true if a valid value for this property is present in the property reader, i.e.
Object	toExportValue(Optional<T> value) Converts the given value to a representation that is suitable for exporting by a property resource.

Methods inherited from class ch.jalu.configme.properties.BaseProperty

determineValue, getDefaultValue, getPath, isValidValue, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionalProperty

public OptionalProperty(Property<T> baseProperty)

OptionalProperty

public OptionalProperty(Property<T> baseProperty,
                        T defaultValue)

Method Detail

getFromReader

protected Optional<T> getFromReader(PropertyReader reader)

Description copied from class: BaseProperty

Constructs the value of the property from the property reader. Returns null if no value is available in the reader or if it cannot be used to construct a value for this property.

Specified by:

getFromReader in class BaseProperty<Optional<T>>

Parameters:

reader - the reader to read from

Returns:

value based on the reader, or null if not applicable

isPresent

public boolean isPresent(PropertyReader reader)

Description copied from interface: Property

Returns true if a valid value for this property is present in the property reader, i.e. true if and only if there is a value at the property's path in the reader and it can be used to construct a value for the property.

Specified by:

isPresent in interface Property<Optional<T>>

Overrides:

isPresent in class BaseProperty<Optional<T>>

Parameters:

reader - the reader to use

Returns:

true if a valid value is present in the reader, false otherwise

toExportValue

public Object toExportValue(Optional<T> value)

Description copied from interface: Property

Converts the given value to a representation that is suitable for exporting by a property resource. The return value should contain the data in the given value represented with only basic types (String, Number, Boolean), as well as lists and maps thereof.

The values which are suitable for returning depend on the support of the used property resource. By default, the supported types include null, String, Integer, Double, Boolean; Collection of the aforementioned types; Map with String keys and values of any of the aforementioned types. Maps and collections can be nested at any arbitrary level. Null signifies that the property/value should be skipped in the export.

Parameters:

value - the value to convert to an export value

Returns:

value to use for export, null to skip the property