ch.jalu.configme.properties

Class BaseProperty<T>

java.lang.Object

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

Type Parameters:

T - the property type

All Implemented Interfaces:

Property<T>

Direct Known Subclasses:

ArrayProperty, InlineArrayProperty, ListProperty, MapProperty, RegexProperty, SetProperty, TypeBasedProperty

public abstract class BaseProperty<T>
extends Object
implements Property<T>

Base implementation of Property. All properties should extend from this class.

This base implementation makes interacting with properties null safe by guaranteeing that the default value and its determined value can never be null.

Constructor Summary

Constructors

Constructor and Description
BaseProperty(@NotNull String path, T defaultValue) Constructor.

Method Summary

Modifier and Type	Method and Description
@NotNull PropertyValue<T>	determineValue(@NotNull PropertyReader reader) Returns the value, based on the given reader, which should be used for this property.
T	getDefaultValue() Returns the default value of this property.
protected abstract T	getFromReader(@NotNull PropertyReader reader, @NotNull ConvertErrorRecorder errorRecorder) Constructs the value of the property from the property reader.
@NotNull String	getPath()
boolean	isValidValue(T value) Returns whether the value can be associated to the given property, i.e.
@NotNull String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.jalu.configme.properties.Property

isValidInResource, toExportValue

Constructor Detail

BaseProperty

public BaseProperty(@NotNull
                    @NotNull String path,
                    @NotNull
                    T defaultValue)

Constructor.

Parameters:

path - the path of the property

defaultValue - the default value of the property

Method Detail

getPath

@NotNull
public @NotNull String getPath()

Specified by:

getPath in interface Property<T>

Returns:

the path of the property

getDefaultValue

@NotNull
public T getDefaultValue()

Description copied from interface: Property

Returns the default value of this property.

Specified by:

getDefaultValue in interface Property<T>

Returns:

the default value

determineValue

@NotNull
public @NotNull PropertyValue<T> determineValue(@NotNull
                                                         @NotNull PropertyReader reader)

Description copied from interface: Property

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 (never null). The return value must be in sync with Property.isValidValue(Object).

Specified by:

determineValue in interface Property<T>

Parameters:

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

Returns:

the value to associate to this property

isValidValue

public boolean isValidValue(@Nullable
                            T value)

Description copied from interface: Property

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 Property.determineValue(ch.jalu.configme.resource.PropertyReader), or in an extension of MigrationService.

Specified by:

isValidValue in interface Property<T>

Parameters:

value - the value to check

Returns:

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

getFromReader

@Nullable
protected abstract T getFromReader(@NotNull
                                             @NotNull PropertyReader reader,
                                             @NotNull
                                             @NotNull ConvertErrorRecorder errorRecorder)

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.

Parameters:

reader - the reader to read from

errorRecorder - error recorder to register errors even if a valid value is returned

Returns:

value based on the reader, or null if not applicable

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object