io.github.fablabsmc.fablabs.api.fiber.v1.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:

ConfigNode, ConfigLeafBuilder

Method Summary

Modifier and Type	Method and Description
default boolean	accepts(T rawValue) Returns true if this property can be set to the given raw value.
void	addChangeListener(BiConsumer<T,T> listener)
SerializableType<T>	getConfigType()
T	getDefaultValue() Returns the default value for this item.
BiConsumer<T,T>	getListener() Returns the listener for this item.
default Class<? super T>	getType() Returns the class of the type of the value being held.
T	getValue() Returns this ConfigLeaf's current value.
boolean	setValue(T value) Sets the value held by this ConfigLeaf.

Methods inherited from interface io.github.fablabsmc.fablabs.api.fiber.v1.tree.ConfigNode

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

Methods inherited from interface io.github.fablabsmc.fablabs.api.fiber.v1.tree.Commentable

getComment

Method Detail

setValue

boolean setValue(@Nonnull
                 T value)

Sets the value held by this ConfigLeaf.

If the provided value does not satisfy this setting's type constraints:

• if a corrected value can be found, this setting is set to the corrected value and this method returns true.
• otherwise, 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)

accepts

default boolean accepts(@Nonnull
                        T rawValue)

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

This method does not account for possible corrections offered by the type's constraints. In other words, it returns true if and only if every constraint of this property's config type accepts the given value as is.

Specified by:

accepts in interface Property<T>

Parameters:

rawValue - the value to check

Returns:

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

See Also:

SerializableType.accepts(Object)

getValue

@Nonnull
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

getConfigType

SerializableType<T> getConfigType()

getType

default Class<? super T> getType()

Description copied from interface: HasValue

Returns the class of the type of the value being held.

Specified by:

getType in interface HasValue<T>

Returns:

the class of the type of the value

getListener

@Nonnull
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

addChangeListener

void addChangeListener(BiConsumer<T,T> listener)

getDefaultValue

@Nullable
T getDefaultValue()

Returns the default value for this item.

Returns:

the default value