me.zeroeightsix.fiber.api.tree

Interface ConfigLeaf<T>

Type Parameters:

T - The type of value this class holds

All Superinterfaces:

Commentable, ConfigNode, HasValue<T>, Property<T>

All Known Implementing Classes:

ConfigLeafImpl

public interface ConfigLeaf<T>
extends ConfigNode, Property<T>, Commentable

A ConfigNode with some value of type T.

See Also:

ConfigNodeImpl, ConfigLeafBuilder, ConfigAggregateBuilder

Method Summary

Modifier and Type	Method and Description
default boolean	accepts(T value) Returns true if this property can be set to the given value.
java.util.List<Constraint<? super T>>	getConstraints() Returns the list of constraints for this item.
T	getDefaultValue() Returns the default value for this item.
java.util.function.BiConsumer<T,T>	getListener() Returns the listener for this item.
java.lang.Class<T>	getType() Returns a class object representing the type of values this node can hold.
T	getValue() Returns this ConfigLeaf's current value.
boolean	setValue(T value) Sets the value held by this ConfigLeaf.

Methods inherited from interface me.zeroeightsix.fiber.api.tree.ConfigNode

attachTo, detach, getAttributes, getAttributeValue, getName, getOrCreateAttribute, getParent

Methods inherited from interface me.zeroeightsix.fiber.api.tree.Commentable

getComment

Method Detail

setValue

boolean setValue(T value)

Sets the value held by this ConfigLeaf.

If the value does not satisfy this setting's constraints, the current value is not updated and the method returns false.

Specified by:

setValue in interface Property<T>

Parameters:

value - the new value this ConfigLeaf should hold

Returns:

true if this property changed as a result of the call, and false otherwise.

See Also:

accepts(Object)

getValue

T getValue()

Returns this ConfigLeaf's current value.

If no successful call to setValue(Object) has been made, this method returns this node's default value.

Specified by:

getValue in interface HasValue<T>

Returns:

this node's value

getType

java.lang.Class<T> getType()

Returns a class object representing the type of values this node can hold.

The returned class object can be used for various runtime type checks, as well as constraint configuration.

Specified by:

getType in interface HasValue<T>

Returns:

the class representing the type of this node's values

accepts

default boolean accepts(T value)

Returns true if this property can be set to the given value.

A value is accepted if it satisfies every constraint this setting has. Note that some constraints such as FinalConstraint will cause even the current value to be rejected.

Specified by:

accepts in interface Property<T>

Parameters:

value - the value to check

Returns:

true if this property accepts the given value, false otherwise.

See Also:

setValue(Object), getConstraints()

getListener

@Nonnull
java.util.function.BiConsumer<T,T> getListener()

Returns the listener for this item.

When this item's value changes, the consumer will be called with the old value as first argument and the new value as second argument.

Returns:

the listener

getDefaultValue

@Nullable
T getDefaultValue()

Returns the default value for this item.

Returns:

the default value

getConstraints

@Nonnull
java.util.List<Constraint<? super T>> getConstraints()

Returns the list of constraints for this item.

For a call to setValue(T) to pass (and such, return true), the value must satisfy all constraints in this list.

Returns:

the list of constraints