ch.jalu.configme.properties

Interface Property<T>

Type Parameters:

T - the property type

All Known Implementing Classes:

ArrayProperty, BaseProperty, BeanProperty, BooleanProperty, DoubleProperty, EnumProperty, InlineArrayProperty, IntegerProperty, ListProperty, LowercaseStringSetProperty, MapProperty, OptionalProperty, RegexProperty, SetProperty, StringListProperty, StringProperty, StringSetProperty, TypeBasedProperty

public interface Property<T>

Property interface. A property knows its path, its type, and can convert the values from a property reader to a value of its type (if the values of the reader are valid). Properties define their path and their behavior but do not keep track of their value.

Property implementations should always extend from BaseProperty instead of implementing this interface directly.

Method Summary

Modifier and Type	Method and Description
PropertyValue<T>	determineValue(PropertyReader propertyReader) Returns the value, based on the given reader, which should be used for this property.
T	getDefaultValue() Returns the default value of this property.
String	getPath()
default boolean	isValidInResource(PropertyReader propertyReader) Convenience method to check whether the property is present in the given reader and a valid representation of the property type.
boolean	isValidValue(T value) Returns whether the value can be associated to the given property, i.e.
Object	toExportValue(T value) Converts the given value to a representation that is suitable for exporting by a property resource.

Method Detail

getPath

String getPath()

Returns:

the path of the property

determineValue

PropertyValue<T> determineValue(PropertyReader propertyReader)

Returns the value, based on the given reader, which should be used for this property. By default this is the value as constructed from the reader, and otherwise the default value. Implementations of BaseProperty never return null. The return value must be in sync with isValidValue(Object).

Parameters:

propertyReader - the reader to construct the value from (if possible)

Returns:

the value to associate to this property

isValidInResource

default boolean isValidInResource(PropertyReader propertyReader)

Convenience method to check whether the property is present in the given reader and a valid representation of the property type. Prefer determineValue(PropertyReader) if you need the value afterwards to avoid performing the same operation twice.

Parameters:

propertyReader - the reader to check the value in

Returns:

true if a value is available for the property and it is valid, false otherwise

getDefaultValue

T getDefaultValue()

Returns the default value of this property.

Returns:

the default value

isValidValue

boolean isValidValue(T value)

Returns whether the value can be associated to the given property, i.e. whether it fulfills all requirements which may be imposed by the property type.

This method is used in ConfigurationDataImpl.setValue(ch.jalu.configme.properties.Property<T>, T), which throws an exception if this method returns false. Therefore, this method is intended as a last catch for invalid values and to ensure that programmatically no invalid value can be set. Extended validation of values encountered in the property reader should be preferably handled in determineValue(ch.jalu.configme.resource.PropertyReader), or in an extension of MigrationService.

Parameters:

value - the value to check

Returns:

true if the value can be used for the property, false otherwise

toExportValue

@Nullable
Object toExportValue(T value)

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