Package dev.prozilla.pine.core.state.config.option

Class ObjectConfigOption<T>

java.lang.Object

dev.prozilla.pine.common.property.mutable.SimpleMutableObjectProperty<T>

dev.prozilla.pine.common.property.observable.SimpleObservableObjectProperty<T>

dev.prozilla.pine.core.state.config.option.ObjectConfigOption<T>

All Implemented Interfaces:

Destructible, MutableObjectProperty<T>, MutableProperty<T>, ObservableObjectProperty<T>, ObservableProperty<T>, SimpleObservableProperty<T>, Property<T>, Transceivable<ConfigOption<T>>, Transmittable<ConfigOption<T>>, Functor<T>, ConfigOption<T>

Direct Known Subclasses:

StringConfigOption

public class ObjectConfigOption<T>
extends SimpleObservableObjectProperty<T>
implements ConfigOption<T>

Field Summary

Fields inherited from class dev.prozilla.pine.common.property.observable.SimpleObservableObjectProperty

logger

Fields inherited from interface dev.prozilla.pine.core.state.config.option.ConfigOption

INITIAL_VALUE_ERROR

Fields inherited from interface dev.prozilla.pine.common.property.observable.ObservableProperty

OBSERVER_ERROR

Constructor Summary

Constructors

Constructor	Description
ObjectConfigOption(T value)	Creates a config option without a validator.
ObjectConfigOption(T value, Predicate<T> validator)	Creates a config option with a validator.

Method Summary

Modifier and Type	Method	Description
boolean	isValidValue(T value)	Checks whether a value is a valid value for this option.
void	reset()	Resets this option to its initial value.
boolean	setValue(T value)	Sets the value of this property.

Methods inherited from class dev.prozilla.pine.common.property.observable.SimpleObservableObjectProperty

addObserver, destroy, getLogger, onValueChange, removeObserver, setLogger

Methods inherited from class dev.prozilla.pine.common.property.mutable.SimpleMutableObjectProperty

getValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.prozilla.pine.core.state.config.option.ConfigOption

receive, self, transmit

Methods inherited from interface dev.prozilla.pine.common.lifecycle.Destructible

destroy

Methods inherited from interface dev.prozilla.pine.common.property.mutable.MutableObjectProperty

setNull, steal

Methods inherited from interface dev.prozilla.pine.common.property.mutable.MutableProperty

modifyValue, swapValue, viewProperty

Methods inherited from interface dev.prozilla.pine.common.property.observable.ObservableProperty

addObserver, read, removeObserver

Methods inherited from interface dev.prozilla.pine.common.property.Property

getValue, getValueOr, hasValue, hasValueProperty, isNotNull, isNotNullProperty, isNull, map, replaceNull, requireValue, snapshot, toStringProperty

Methods inherited from interface dev.prozilla.pine.common.property.observable.SimpleObservableProperty

setLogger

Constructor Details

ObjectConfigOption

public ObjectConfigOption(T value)

Creates a config option without a validator.

Parameters:

value - Initial value

ObjectConfigOption

public ObjectConfigOption(T value,
 Predicate<T> validator)
                   throws IllegalArgumentException

Creates a config option with a validator.

Parameters:

value - Initial value

Throws:

IllegalArgumentException - If validator does not evaluate to true for the initial value.

Method Details

setValue

public boolean setValue(T value)

Description copied from interface: MutableProperty

Sets the value of this property.

Specified by:

setValue in interface MutableProperty<T>

Overrides:

setValue in class SimpleMutableObjectProperty<T>

Parameters:

value - The new value

Returns:

true if the value was changed.

isValidValue

public boolean isValidValue(T value)

Description copied from interface: ConfigOption

Checks whether a value is a valid value for this option.

Specified by:

isValidValue in interface ConfigOption<T>

Parameters:

value - Value to check.

Returns:

True if the value is valid

reset

public void reset()

Description copied from interface: ConfigOption

Resets this option to its initial value.

Specified by:

reset in interface ConfigOption<T>