me.zeroeightsix.fiber.builder

Class ConfigValueBuilder<T,B extends ConfigValueBuilder<T,B>>

java.lang.Object

me.zeroeightsix.fiber.builder.ConfigValueBuilder<T,B>

Type Parameters:

T - the type of value the produced ConfigValue will hold

B - the type of this

Direct Known Subclasses:

ConfigValueBuilder.Aggregate, ConfigValueBuilder.Scalar

public abstract class ConfigValueBuilder<T,B extends ConfigValueBuilder<T,B>>
extends java.lang.Object

A builder for ConfigValues.

This is the abstract base class for all builders of this type. Builders implementing this class include Scalar and Aggregate for scalar (one-value) and aggregate (collection/array) values, respectively.

See Also:

ConfigValue

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigValueBuilder.Aggregate<A,E> A ConfigValueBuilder that produces aggregate ConfigValues.
static class	ConfigValueBuilder.Scalar<T> A ConfigValueBuilder that produces scalar ConfigValues.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<Constraint<? super T>>	constraintList
protected java.lang.Class<T>	type

Method Summary

Modifier and Type	Method and Description
static <C extends java.util.Collection<E>,E> ConfigValueBuilder.Aggregate<C,E>	aggregate(java.lang.Class<? super C> collectionType, java.lang.Class<E> componentType) Creates and returns an aggregate builder for a collection type.
static <E> ConfigValueBuilder.Aggregate<E[],E>	aggregate(java.lang.Class<E[]> arrayType) Creates and returns an aggregate builder for an array type.
ConfigValue<T>	build() Builds the ConfigValue.
abstract ConstraintsBuilder<B,T,?>	constraints() Creates a constraint builder for this ConfigValueBuilder.
static boolean	isAggregate(java.lang.Class<?> type) Determines if a Class object represents an aggregate type, ie.
static <T> ConfigValueBuilder.Scalar<T>	scalar(java.lang.Class<T> type) Creates and returns a scalar ConfigValueBuilder.
protected B	self()
B	setFinal() Marks a setting as final.
B	setFinal(boolean isFinal) Sets the finality.
B	withComment(java.lang.String comment) Sets the ConfigValue's comment.
B	withDefaultValue(T defaultValue) Sets the default value.
B	withListener(java.util.function.BiConsumer<T,T> consumer) Adds a listener to the ConfigValue.
B	withName(java.lang.String name) Sets the ConfigValue's name.
B	withParent(Node node) Sets the node that the ConfigValue will be registered to.

Methods inherited from class java.lang.Object

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

Field Detail

type

@Nonnull
protected final java.lang.Class<T> type

constraintList

protected java.util.List<Constraint<? super T>> constraintList

Method Detail

isAggregate

public static boolean isAggregate(java.lang.Class<?> type)

Determines if a Class object represents an aggregate type, ie. if it is an Array or a Collection.

Parameters:

type - the type to check

Returns:

true if type is an aggregate type; false otherwise

aggregate

public static <E> ConfigValueBuilder.Aggregate<E[],E> aggregate(@Nonnull
                                                                java.lang.Class<E[]> arrayType)

Creates and returns an aggregate builder for an array type.

Type Parameters:

E - the type of values held by arrayType

Parameters:

arrayType - the class of the array used for this aggregate builder

Returns:

the newly created builder

See Also:

isAggregate(java.lang.Class<?>)

aggregate

public static <C extends java.util.Collection<E>,E> ConfigValueBuilder.Aggregate<C,E> aggregate(@Nonnull
                                                                                                java.lang.Class<? super C> collectionType,
                                                                                                @Nonnull
                                                                                                java.lang.Class<E> componentType)

Creates and returns an aggregate builder for a collection type.

Type Parameters:

C - the type collectionType represents. eg. List

E - the type componentType represents. eg. Integer

Parameters:

collectionType - the class of the collection used for this aggregate builder

componentType - the class of the type of elements collectionType holds

Returns:

the newly created builder

scalar

public static <T> ConfigValueBuilder.Scalar<T> scalar(java.lang.Class<T> type)

Creates and returns a scalar ConfigValueBuilder.

Type Parameters:

T - the type type represents. For example, this could be Integer

Parameters:

type - the class of the type used for this builder

Returns:

the newly created builder

See Also:

ConfigValueBuilder.Scalar

withName

public B withName(java.lang.String name)

Sets the ConfigValue's name.

If null, or if this method is never called, the ConfigValue won't have a name. Thus, it might be ignored during (de)serialisation. It also won't be able to be found by name in its parent node.

Parameters:

name - the name

Returns:

this builder

See Also:

Node.lookup(java.lang.String)

withComment

public B withComment(java.lang.String comment)

Sets the ConfigValue's comment.

If null, or if this method is never called, the ConfigValue won't have a comment. An empty comment (non null, but only consisting of whitespace) will be serialised.

Parameters:

comment - the comment

Returns:

this builder

withListener

public B withListener(java.util.function.BiConsumer<T,T> consumer)

Adds a listener to the ConfigValue.

Listeners are called when the value of a ConfigValue is changed. They are of type BiConsumer: the first argument being the old value, and the second argument being the new value.

Listeners set with this method are chained: if there was already one specified, a new listener is created that calls the old one first, and then the new one.

Parameters:

consumer - the listener

Returns:

this builder

withDefaultValue

public B withDefaultValue(T defaultValue)

Sets the default value.

If null, or if this method is never called, the ConfigValue will have no default value.

Parameters:

defaultValue - the default value

Returns:

this builder

setFinal

public B setFinal()

Marks a setting as final.

As a result of this method, any attempt to update the value of the resulting setting will fail. This method behaves as if: this.setFinal(true).

Returns:

this builder

See Also:

setFinal(boolean)

setFinal

public B setFinal(boolean isFinal)

Sets the finality.

If true, the produced setting can not be changed. It will be initialised with its default value, if there is one. Afterwards, it can not be changed again.

Parameters:

isFinal - the finality

Returns:

this builder

withParent

public B withParent(Node node)

Sets the node that the ConfigValue will be registered to.

Parameters:

node - The node the ConfigValue will be registered to.

Returns:

The builder

self

protected final B self()

constraints

public abstract ConstraintsBuilder<B,T,?> constraints()

Creates a constraint builder for this ConfigValueBuilder.

Returns:

the created builder

See Also:

ConstraintsBuilder

build

public ConfigValue<T> build()

Builds the ConfigValue.

If a parent was specified using withParent(me.zeroeightsix.fiber.tree.Node), the ConfigValue will also be registered to its parent node.

Returns:

the ConfigValue