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

Constructor Summary

Constructors

Constructor and Description
ConfigValue(java.lang.String name, java.lang.String comment, T value, T defaultValue, java.util.function.BiConsumer<T,T> consumer, java.util.List<Constraint<? super T>> constraintList, java.lang.Class<T> type, boolean isFinal) Creates a ConfigValue.

Method Summary

Modifier and Type	Method and Description
static <C extends java.util.Collection<E>,E> ConfigValueBuilder.Aggregate<C,E>	builder(C defaultValue, java.lang.Class<E> elementType) Creates an aggregate ConfigValueBuilder.
static <T> ConfigValueBuilder.Scalar<T>	builder(java.lang.Class<T> type) Creates a scalar ConfigValueBuilder.
static <E> ConfigValueBuilder.Aggregate<E[],E>	builder(E[] defaultValue) Creates an aggregate ConfigValueBuilder.
static <T> ConfigValueBuilder.Scalar<T>	builder(T defaultValue) Creates a scalar ConfigValueBuilder.
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(@Nullable
                   java.lang.String name,
                   @Nullable
                   java.lang.String comment,
                   @Nullable
                   T value,
                   @Nullable
                   T defaultValue,
                   @Nonnull
                   java.util.function.BiConsumer<T,T> consumer,
                   @Nonnull
                   java.util.List<Constraint<? super T>> constraintList,
                   @Nonnull
                   java.lang.Class<T> type,
                   boolean isFinal)

Creates a ConfigValue.

Parameters:

name - the name for this item

comment - the comment for this item

value - the current value

defaultValue - the default value for this item
Preferably, if this item's value has constraints, the default value should satisfy those constraints.

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

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

isFinal - whether or not this value can be change. If true, setValue(Object) will always return false, implying this was not mutated.

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

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

builder

public static <T> ConfigValueBuilder.Scalar<T> builder(@Nonnull
                                                       java.lang.Class<T> type)

Creates a scalar ConfigValueBuilder.

Type Parameters:

T - the type type represents

Parameters:

type - the class of the type of value the ConfigValue produced by the builder holds

Returns:

the newly created builder

See Also:

Scalar

builder

public static <T> ConfigValueBuilder.Scalar<T> builder(@Nonnull
                                                       T defaultValue)

Creates a scalar ConfigValueBuilder.

Type Parameters:

T - the type of value the ConfigValue produced by the builder holds

Parameters:

defaultValue - the default value of the ConfigValue that will be produced by the created builder.

Returns:

the newly created builder

See Also:

Scalar

builder

public static <E> ConfigValueBuilder.Aggregate<E[],E> builder(@Nonnull
                                                              E[] defaultValue)

Creates an aggregate ConfigValueBuilder.

Type Parameters:

E - the type of elements defaultValue holds

Parameters:

defaultValue - the default array of values the ConfigValue will hold.

Returns:

the newly created builder

See Also:

Aggregate

builder

public static <C extends java.util.Collection<E>,E> ConfigValueBuilder.Aggregate<C,E> builder(@Nonnull
                                                                                              C defaultValue,
                                                                                              java.lang.Class<E> elementType)

Creates an aggregate ConfigValueBuilder.

Type Parameters:

C - the type of collection defaultValue is

E - the type elementType represents

Parameters:

defaultValue - the default collection of values the ConfigValue will hold.

elementType - the class of the type of elements defaultValue holds

Returns:

the newly created builder