ch.jalu.configme.properties

Class BeanProperty<T>

java.lang.Object

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

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

All Implemented Interfaces:

Property<T>

public class BeanProperty<T>
extends BaseProperty<T>

Constructor Summary

Constructors

Modifier	Constructor and Description
	BeanProperty(Class<T> beanType, String path, T defaultValue)
	BeanProperty(Class<T> beanType, String path, T defaultValue, Mapper mapper)
protected	BeanProperty(TypeInformation beanType, String path, T defaultValue, Mapper mapper) Constructor.

Method Summary

Modifier and Type	Method and Description
protected T	getFromReader(PropertyReader reader) Constructs the value of the property from the property reader.
Object	toExportValue(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, isPresent, isValidValue, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BeanProperty

public BeanProperty(Class<T> beanType,
                    String path,
                    T defaultValue)

BeanProperty

public BeanProperty(Class<T> beanType,
                    String path,
                    T defaultValue,
                    Mapper mapper)

BeanProperty

protected BeanProperty(TypeInformation beanType,
                       String path,
                       T defaultValue,
                       Mapper mapper)

Constructor. Allows to instantiate bean properties with generic types. Since it is hard to validate that the default value is actually correct, it is recommended to extend this class with specific type parameters.

Parameters:

beanType - the bean type

path - the path

defaultValue - the default value

mapper - the mapper to map with

Method Detail

getFromReader

protected 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<T>

Parameters:

reader - the reader to read from

Returns:

value based on the reader, or null if not applicable

toExportValue

public Object toExportValue(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