me.zeroeightsix.fiber.tree

Class ConfigLeafImpl<T>

java.lang.Object

me.zeroeightsix.fiber.tree.ConfigNodeImpl

me.zeroeightsix.fiber.tree.ConfigLeafImpl<T>

All Implemented Interfaces:

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

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

Constructor Summary

Constructors

Constructor and Description
ConfigLeafImpl(java.lang.String name, java.lang.String comment, T defaultValue, java.util.function.BiConsumer<T,T> listener, java.util.List<Constraint<? super T>> constraints, java.lang.Class<T> type) 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 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.
java.lang.String	toString()

Methods inherited from class me.zeroeightsix.fiber.tree.ConfigNodeImpl

getComment, getName

Methods inherited from class java.lang.Object

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

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

getName

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

getComment

Constructor Detail

ConfigLeafImpl

public ConfigLeafImpl(@Nonnull
                      java.lang.String name,
                      @Nullable
                      java.lang.String comment,
                      @Nullable
                      T defaultValue,
                      @Nonnull
                      java.util.function.BiConsumer<T,T> listener,
                      @Nonnull
                      java.util.List<Constraint<? super T>> constraints,
                      @Nonnull
                      java.lang.Class<T> type)

Creates a ConfigLeaf.

Parameters:

name - the name for this node

comment - the comment for this node

defaultValue - the default value for this node

While the default value should generally satisfy the supplied constraints, this is not enforced by this constructor. This allows constraints such as ConstraintType.FINAL to work as intended. If this ConfigLeaf is built by a ConfigLeafBuilder, this criterion will always be met.

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.

constraints - the list of constraints for this item. For a value to be accepted, all constraints must be satisfied.

type - the type of value this item holds

See Also:

ConfigLeafBuilder, ConfigAggregateBuilder

Method Detail

getValue

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

getType

@Nonnull
public java.lang.Class<T> getType()

Description copied from interface: ConfigLeaf

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

Specified by:

getType in interface HasValue<T>

Returns:

the class representing the type of this node's values

setValue

public boolean setValue(@Nullable
                        T value)

Description copied from interface: ConfigLeaf

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 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)

accepts

public boolean accepts(@Nullable
                       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.

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 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:

setValue(Object), getConstraints()

getListener

@Nonnull
public java.util.function.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

getDefaultValue

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

getConstraints

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

Description copied from interface: ConfigLeaf

Returns the list of constraints for this item.

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

Specified by:

getConstraints in interface ConfigLeaf<T>

Returns:

the list of constraints

toString

public java.lang.String toString()

Overrides:

toString in class ConfigNodeImpl