io.github.fablabsmc.fablabs.api.fiber.v1.builder

Class ConfigLeafBuilder<T,R>

java.lang.Object

io.github.fablabsmc.fablabs.impl.fiber.builder.ConfigNodeBuilder

io.github.fablabsmc.fablabs.api.fiber.v1.builder.ConfigLeafBuilder<T,R>

Type Parameters:

T - the type of value the produced ConfigLeaf will hold

public class ConfigLeafBuilder<T,R>
extends ConfigNodeBuilder

A builder for ConfigLeafs.

See Also:

ConfigLeaf

Field Summary

Fields

Modifier and Type	Field and Description
protected Function<T,R>	deserializer
protected Function<R,T>	serializer
protected SerializableType<T>	type

Fields inherited from class io.github.fablabsmc.fablabs.impl.fiber.builder.ConfigNodeBuilder

attributes, comment, name, parent

Method Summary

Modifier and Type	Method and Description
ConfigLeaf<T>	build() Builds the ConfigLeaf.
static <T,R> ConfigLeafBuilder<T,R>	create(ConfigTreeBuilder parentNode, String name, ConfigType<R,T,?> type, R defaultValue) Creates a builder for a leaf node with the given parent, name, and type.
static <T> ConfigLeafBuilder<T,T>	create(ConfigTreeBuilder parentNode, String name, SerializableType<T> type, T defaultValue) Creates a builder for a leaf node with the given parent, name, and serialized type.
ConfigTreeBuilder	finishValue() Builds and registers the ConfigLeaf with the parent node.
ConfigTreeBuilder	finishValue(Consumer<ConfigLeaf<T>> action) Builds and registers the ConfigLeaf with the parent node before running the given action on the newly built leaf.
SerializableType<T>	getType() Returns the type of values stored in the leaf node.
ConfigLeafBuilder<T,R>	withAttribute(ConfigAttribute<?> attribute) Adds a single ConfigAttribute to the built ConfigNode.
<A> ConfigLeafBuilder<T,R>	withAttribute(FiberId id, SerializableType<A> type, A defaultValue) Adds a ConfigAttribute to the built ConfigNode.
ConfigLeafBuilder<T,R>	withAttributes(Collection<ConfigAttribute<?>> attributes) Adds a collection of ConfigAttribute to the built ConfigNode.
ConfigLeafBuilder<T,R>	withComment(String comment) Sets the ConfigLeaf's comment.
ConfigLeafBuilder<T,R>	withDefaultValue(R defaultValue) Sets the default value.
ConfigLeafBuilder<T,R>	withListener(BiConsumer<R,R> consumer) Adds a listener to the ConfigLeaf.
ConfigLeafBuilder<T,R>	withName(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 SerializableType<T> type

deserializer

protected final Function<T,R> deserializer

serializer

protected final Function<R,T> serializer

Method Detail

create

public static <T,R> ConfigLeafBuilder<T,R> create(ConfigTreeBuilder parentNode,
                                                  @Nonnull
                                                  String name,
                                                  @Nonnull
                                                  ConfigType<R,T,?> type,
                                                  @Nonnull
                                                  R defaultValue)

Creates a builder for a leaf node with the given parent, name, and type.

Type Parameters:

T - The type of serialized values the leaf node stores.

R - The runtime type of values the builder receives.

Parameters:

parentNode - The parent node builder.

name - The name for the leaf node.

type - The ConfigType for values stored in this leaf node. The actual type stored in the leaf node is represented by type.getSerializedType().

Returns:

A new builder.

create

public static <T> ConfigLeafBuilder<T,T> create(ConfigTreeBuilder parentNode,
                                                @Nonnull
                                                String name,
                                                @Nonnull
                                                SerializableType<T> type,
                                                @Nonnull
                                                T defaultValue)

Creates a builder for a leaf node with the given parent, name, and serialized type.

Type Parameters:

T - The type of serialized values the leaf node stores.

Parameters:

parentNode - The parent node builder.

name - The name for the leaf node.

type - The SerializableType for values stored in this leaf node.

Returns:

A new builder.

getType

@Nonnull
public SerializableType<T> getType()

Returns the type of values stored in the leaf node.

withName

public ConfigLeafBuilder<T,R> withName(@Nonnull
                                       String name)

Sets the ConfigLeaf's name.

Overrides:

withName in class ConfigNodeBuilder

Parameters:

name - the name

Returns:

this builder

See Also:

ConfigTree.lookupLeaf(java.lang.String, io.github.fablabsmc.fablabs.api.fiber.v1.schema.type.SerializableType<T>)

withComment

public ConfigLeafBuilder<T,R> withComment(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.

Overrides:

withComment in class ConfigNodeBuilder

Parameters:

comment - the comment

Returns:

this builder

withAttribute

public <A> ConfigLeafBuilder<T,R> withAttribute(FiberId id,
                                                SerializableType<A> type,
                                                A defaultValue)

Description copied from class: ConfigNodeBuilder

Adds a ConfigAttribute to the built ConfigNode.

Overrides:

withAttribute in class ConfigNodeBuilder

Type Parameters:

A - the type of values stored in the attribute

Parameters:

id - the id of the attribute

type - the class object representing the type of values stored in the attribute

defaultValue - the attribute's default value

Returns:

this, for chaining

See Also:

ConfigNode.getAttributes()

withAttributes

public ConfigLeafBuilder<T,R> withAttributes(Collection<ConfigAttribute<?>> attributes)

Description copied from class: ConfigNodeBuilder

Adds a collection of ConfigAttribute to the built ConfigNode.

Overrides:

withAttributes in class ConfigNodeBuilder

Parameters:

attributes - A collection of attributes.

Returns:

This builder.

withAttribute

public ConfigLeafBuilder<T,R> withAttribute(ConfigAttribute<?> attribute)

Description copied from class: ConfigNodeBuilder

Adds a single ConfigAttribute to the built ConfigNode.

Overrides:

withAttribute in class ConfigNodeBuilder

Parameters:

attribute - The attribute.

Returns:

This builder.

withListener

public ConfigLeafBuilder<T,R> withListener(BiConsumer<R,R> 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,R> withDefaultValue(R 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

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.

Specified by:

build in class ConfigNodeBuilder

Returns:

the ConfigLeaf

See Also:

finishValue(Consumer)

finishValue

public ConfigTreeBuilder finishValue()

Builds and registers the ConfigLeaf with the parent node. This method is equivalent to this.finishValue(leaf -> {}).

Returns:

The parent builder.

See Also:

finishValue(Consumer), build()

finishValue

public ConfigTreeBuilder finishValue(Consumer<ConfigLeaf<T>> action)

Builds and registers the ConfigLeaf with the parent node before running the given action on the newly built leaf.

Parameters:

action - An operation to run on the built ConfigLeaf.

Returns:

The parent builder.

See Also:

build()