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

Interface ConfigOption<T>

Type Parameters:

T - The type of the value

All Superinterfaces:

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

All Known Implementing Classes:

BooleanConfigOption, FloatConfigOption, IntConfigOption, ObjectConfigOption, StringConfigOption

public interface ConfigOption<T>
extends SimpleObservableProperty<T>, Transceivable<ConfigOption<T>>

Represents an option of the application's configuration.

Every option has an initial value and a validator which restricts the values of the option.

See Also:

• Config

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INITIAL_VALUE_ERROR

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

OBSERVER_ERROR

Method Summary

Modifier and Type	Method	Description
boolean	isValidValue(T value)	Checks whether a value is a valid value for this option.
default void	receive(ConfigOption<T> source)	Copies the value of another option to this option.
void	reset()	Resets this option to its initial value.
default ConfigOption<T>	self()
default void	transmit(ConfigOption<T> target)	Copies the value of this option to another option.

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

destroy

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

modifyValue, setValue, 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

Field Details

INITIAL_VALUE_ERROR

static final String INITIAL_VALUE_ERROR

See Also:

• Constant Field Values

Method Details

transmit

default void transmit(ConfigOption<T> target)

Copies the value of this option to another option.

Specified by:

transmit in interface Transceivable<T>

Specified by:

transmit in interface Transmittable<T>

Parameters:

target - The target object to transmit data to

receive

default void receive(ConfigOption<T> source)

Copies the value of another option to this option.

Specified by:

receive in interface Transceivable<T>

Parameters:

source - The object from which data will be received

isValidValue

boolean isValidValue(T value)

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

Parameters:

value - Value to check.

Returns:

True if the value is valid

reset

void reset()

Resets this option to its initial value.

self

default ConfigOption<T> self()

Specified by:

self in interface Transceivable<T>