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

Class BooleanConfigOption

java.lang.Object

dev.prozilla.pine.common.property.mutable.SimpleMutableBooleanProperty

dev.prozilla.pine.common.property.observable.SimpleObservableBooleanProperty

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

All Implemented Interfaces:

Destructible, BooleanProperty, MutableBooleanProperty, MutableProperty<Boolean>, NonNullProperty<Boolean>, ObservableBooleanProperty, ObservableProperty<Boolean>, SimpleObservableProperty<Boolean>, Property<Boolean>, Transceivable<ConfigOption<Boolean>>, Transmittable<ConfigOption<Boolean>>, Functor<Boolean>, ConfigOption<Boolean>

public class BooleanConfigOption
extends SimpleObservableBooleanProperty
implements ConfigOption<Boolean>

Field Summary

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

logger

Fields inherited from interface dev.prozilla.pine.common.property.BooleanProperty

FALSE, TRUE

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
BooleanConfigOption(boolean value)	Creates a config option without a validator.
BooleanConfigOption(boolean value, BooleanPredicate validator)	Creates a config option with a validator.

Method Summary

Modifier and Type	Method	Description
boolean	isValid(boolean value)
boolean	isValidValue(Boolean value)	Checks whether a value is a valid value for this option.
void	receive(BooleanConfigOption otherOption)
void	reset()	Resets this option to its initial value.
boolean	set(boolean value)	Sets the value of this property.
boolean	setValue(Boolean value)	Sets the value of this option.
void	transmit(BooleanConfigOption otherOption)

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

addObserver, destroy, getLogger, onValueChange, removeObserver, setLogger

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

get

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.common.property.BooleanProperty

and, and, get, getValue, getValueOr, has, hasProperty, ifElse, map, not, or, or, replaceNull, requireValue, xor, xor

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.MutableBooleanProperty

modify, swap, toggle, viewProperty

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

modifyValue, swapValue

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

isNotNull, isNotNullProperty

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

addObserver, read, read, removeObserver

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

hasValue, hasValueProperty, isNull, map, snapshot, toStringProperty

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

setLogger

Constructor Details

BooleanConfigOption

public BooleanConfigOption(boolean value)

Creates a config option without a validator.

Parameters:

value - Initial value

BooleanConfigOption

public BooleanConfigOption(boolean value,
 BooleanPredicate 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(Boolean value)

Sets the value of this option.

Specified by:

setValue in interface MutableBooleanProperty

Specified by:

setValue in interface MutableProperty<Boolean>

Parameters:

value - New value for this option

Returns:

true if the value was changed.

set

public boolean set(boolean value)

Description copied from interface: MutableBooleanProperty

Sets the value of this property.

Specified by:

set in interface MutableBooleanProperty

Overrides:

set in class SimpleMutableBooleanProperty

Parameters:

value - The new value

Returns:

true if the value was changed.

isValidValue

public boolean isValidValue(Boolean value)

Description copied from interface: ConfigOption

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

Specified by:

isValidValue in interface ConfigOption<Boolean>

Parameters:

value - Value to check.

Returns:

True if the value is valid

isValid

public boolean isValid(boolean value)

transmit

public void transmit(BooleanConfigOption otherOption)

receive

public void receive(BooleanConfigOption otherOption)

reset

public void reset()

Description copied from interface: ConfigOption

Resets this option to its initial value.

Specified by:

reset in interface ConfigOption<Boolean>