io.github.fablabsmc.fablabs.impl.fiber.tree

Class ConfigLeafImpl<T>

java.lang.Object

io.github.fablabsmc.fablabs.impl.fiber.tree.ConfigNodeImpl

io.github.fablabsmc.fablabs.impl.fiber.tree.ConfigLeafImpl<T>

All Implemented Interfaces:

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

public final class ConfigLeafImpl<T>
extends ConfigNodeImpl
implements ConfigLeaf<T>

Constructor Summary

Constructors

Constructor and Description
ConfigLeafImpl(String name, SerializableType<T> type, String comment, T defaultValue, BiConsumer<T,T> listener) Creates a ConfigLeaf.

Method Summary

Modifier and Type	Method and Description
boolean	accepts(T value) 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.
T	getValue() Returns this ConfigLeaf's current value.
boolean	setValue(T value) Sets the value held by this ConfigLeaf.
String	toString()

Methods inherited from class io.github.fablabsmc.fablabs.impl.fiber.tree.ConfigNodeImpl

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

Methods inherited from class java.lang.Object

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

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

getType

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

Constructor Detail

ConfigLeafImpl

public ConfigLeafImpl(@Nonnull
                      String name,
                      @Nonnull
                      SerializableType<T> type,
                      @Nullable
                      String comment,
                      @Nonnull
                      T defaultValue,
                      @Nonnull
                      BiConsumer<T,T> listener)

Creates a ConfigLeaf.

Parameters:

name - the name for this node

type - the type of value this item holds

comment - the comment for this node

defaultValue - the default value for this node

listener - the consumer or 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.

See Also:

ConfigLeafBuilder

Method Detail

getValue

@Nonnull
public T getValue()

Description copied from interface: ConfigLeaf

Returns this ConfigLeaf's current value.

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

Specified by:

getValue in interface ConfigLeaf<T>

Specified by:

getValue in interface HasValue<T>

Returns:

this node's value

getConfigType

public SerializableType<T> getConfigType()

Specified by:

getConfigType in interface ConfigLeaf<T>

accepts

public boolean accepts(@Nonnull
                       T value)

Description copied from interface: ConfigLeaf

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 ConfigLeaf<T>

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:

SerializableType.accepts(Object)

setValue

public boolean setValue(@Nonnull
                        T value)

Description copied from interface: ConfigLeaf

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 ConfigLeaf<T>

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:

ConfigLeaf.accepts(Object)

getListener

@Nonnull
public BiConsumer<T,T> getListener()

Description copied from interface: ConfigLeaf

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.

Specified by:

getListener in interface ConfigLeaf<T>

Returns:

the listener

addChangeListener

public void addChangeListener(BiConsumer<T,T> listener)

Specified by:

addChangeListener in interface ConfigLeaf<T>

getDefaultValue

@Nonnull
public T getDefaultValue()

Description copied from interface: ConfigLeaf

Returns the default value for this item.

Specified by:

getDefaultValue in interface ConfigLeaf<T>

Returns:

the default value

toString

public String toString()

Overrides:

toString in class ConfigNodeImpl