me.zeroeightsix.fiber.tree

Class ConfigValue<T>

java.lang.Object

me.zeroeightsix.fiber.tree.ConfigLeaf

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

Type Parameters:

T - The type of value this class holds

All Implemented Interfaces:

Commentable, HasValue<T>, Property<T>, TreeItem

public class ConfigValue<T>
extends ConfigLeaf
implements Property<T>

A ConfigLeaf with some value of type T.

See Also:

ConfigLeaf, ConfigValueBuilder, ConfigAggregateBuilder

Constructor Summary

Constructors

Constructor and Description
ConfigValue(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 ConfigValue.

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 the class of the type of the value being held
T	getValue() Returns the value being held
boolean	setValue(T value) Sets the value of this property.

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

getComment, getName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigValue

public ConfigValue(@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 ConfigValue.

Parameters:

name - the name for this item

comment - the comment for this item

defaultValue - the default value for this item

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 ConfigValue is built by a ConfigValueBuilder, 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:

ConfigValueBuilder, ConfigAggregateBuilder

Method Detail

getValue

@Nullable
public T getValue()

Description copied from interface: HasValue

Returns the value being held

Specified by:

getValue in interface HasValue<T>

Returns:

the value

getType

@Nonnull
public java.lang.Class<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

setValue

public boolean setValue(@Nullable
                        T value)

Description copied from interface: Property

Sets the value of this property.

This can fail and return false if, for example, the value did not satisfy the constraints of the property.

Specified by:

setValue in interface Property<T>

Parameters:

value - the new value this property should receive

Returns:

true if this property changed as a result of the call

See Also:

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

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

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
public T getDefaultValue()

Returns the default value for this item.

Returns:

the default value

getConstraints

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