me.zeroeightsix.fiber.builder

Class ConfigLeafBuilder<T>

java.lang.Object

me.zeroeightsix.fiber.builder.ConfigLeafBuilder<T>

Type Parameters:

T - the type of value the produced ConfigLeaf will hold

Direct Known Subclasses:

ConfigAggregateBuilder

public class ConfigLeafBuilder<T>
extends java.lang.Object

A builder for scalar ConfigLeafs.

The settings created by this builder are considered atomic, and do not allow specifications at the component level. Settings with aggregate types, such as arrays and collections, should be created using ConfigAggregateBuilder.

See Also:

ConfigLeaf

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ConfigLeafBuilder(ConfigTreeBuilder parentNode, java.lang.String name, java.lang.Class<T> type) Creates a new scalar ConfigLeafBuilder.

Method Summary

Modifier and Type	Method and Description
ConstraintsBuilder<T>	beginConstraints() Creates a constraint builder for this ConfigLeafBuilder.
ConfigLeaf<T>	build() Builds the ConfigLeaf.
ConfigTreeBuilder	finishValue()
ConfigTreeBuilder	finishValue(java.util.function.Consumer<ConfigLeaf<T>> action)
ConfigLeafBuilder<T>	withComment(java.lang.String comment) Sets the ConfigLeaf's comment.
ConfigLeafBuilder<T>	withDefaultValue(T defaultValue) Sets the default value.
ConfigLeafBuilder<T>	withFinality() Marks a setting as final.
ConfigLeafBuilder<T>	withFinality(boolean isFinal) Sets the finality.
ConfigLeafBuilder<T>	withListener(java.util.function.BiConsumer<T,T> consumer) Adds a listener to the ConfigLeaf.
ConfigLeafBuilder<T>	withName(java.lang.String name) Sets the ConfigLeaf's name.

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

Constructor Detail

ConfigLeafBuilder

public ConfigLeafBuilder(ConfigTreeBuilder parentNode,
                         @Nonnull
                         java.lang.String name,
                         @Nonnull
                         java.lang.Class<T> type)

Creates a new scalar ConfigLeafBuilder.

Parameters:

parentNode - the ConfigNodeBuilder this builder originates from

name - the name of the ConfigLeaf produced by this builder

type - the class object representing the type of values this builder will create settings for

Method Detail

withName

public ConfigLeafBuilder<T> withName(java.lang.String name)

Sets the ConfigLeaf's name.

If null, or if this method is never called, the ConfigLeaf 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:

ConfigTree.lookup(java.lang.String)

withComment

public ConfigLeafBuilder<T> withComment(java.lang.String comment)

Sets the ConfigLeaf's comment.

If null, or if this method is never called, the ConfigLeaf 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 ConfigLeafBuilder<T> withListener(java.util.function.BiConsumer<T,T> consumer)

Adds a listener to the ConfigLeaf.

Listeners are called when the value of a ConfigLeaf 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 ConfigLeafBuilder<T> withDefaultValue(T defaultValue)

Sets the default value.

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

Note that every ConfigLeaf created from this builder will share a reference to the given defaultValue. Immutability is encouraged.

Parameters:

defaultValue - the default value

Returns:

this builder

withFinality

public ConfigLeafBuilder<T> withFinality()

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:

withFinality(boolean)

withFinality

public ConfigLeafBuilder<T> withFinality(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; ConfigLeaf.setValue(Object) will always return false.

Parameters:

isFinal - whether or not the value can be changed after building

Returns:

this builder

beginConstraints

public ConstraintsBuilder<T> beginConstraints()

Creates a constraint builder for this ConfigLeafBuilder.

Returns:

the created builder

See Also:

ConstraintsBuilder

build

public ConfigLeaf<T> build()

Builds the ConfigLeaf.

If a parent was specified in the constructor, the ConfigLeaf will also be registered to its parent node.

This method should not be called multiple times if the default value is intended to be mutated. Multiple calls will result in duplicated references to the default value.

Returns:

the ConfigLeaf

finishValue

public ConfigTreeBuilder finishValue()

finishValue

public ConfigTreeBuilder finishValue(java.util.function.Consumer<ConfigLeaf<T>> action)