me.zeroeightsix.fiber.builder

Class ConfigNodeBuilder

java.lang.Object

me.zeroeightsix.fiber.builder.ConfigNodeBuilder

All Implemented Interfaces:

NodeLike

public class ConfigNodeBuilder
extends java.lang.Object
implements NodeLike

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name
protected ConfigNodeBuilder	parent

Constructor Summary

Constructors

Constructor and Description
ConfigNodeBuilder()

Method Summary

Modifier and Type	Method and Description
ConfigNodeBuilder	add(TreeItem item) Attempts to introduce a new child to this node.
ConfigNodeBuilder	add(TreeItem item, boolean overwrite) Attempts to introduce a new child to this node.
ConfigNodeBuilder	applyFromPojo(java.lang.Object pojo) Configure this builder using a POJO (Plain Old Java Object).
<C extends java.util.Collection<E>,E> ConfigAggregateBuilder<C,E>	beginAggregateValue(java.lang.String name, C defaultValue, java.lang.Class<E> elementType) Creates an aggregate ConfigValueBuilder.
<E> ConfigAggregateBuilder<E[],E>	beginAggregateValue(java.lang.String name, E[] defaultValue) Creates an aggregate ConfigValueBuilder.
<T> ConfigValueBuilder<T>	beginValue(java.lang.String name, java.lang.Class<T> type) Creates a scalar ConfigValueBuilder.
<T> ConfigValueBuilder<T>	beginValue(java.lang.String name, T defaultValue) Creates a ConfigValueBuilder with the given default value.
ConfigNode	build() Construct a new ConfigNode based on this builder's specifications.
ConfigNodeBuilder	finishNode()
ConfigNodeBuilder	finishNode(java.util.function.Consumer<ConfigNode> action)
ConfigNodeBuilder	fork(java.lang.String name) Forks this builder, creating a subtree whose parent is this node.
java.util.Collection<TreeItem>	getItems() Returns a collection of this node's children.
TreeItem	lookup(java.lang.String name) Tries to find a child in this node by name.
TreeItem	remove(java.lang.String name) Attempts to remove an item from this node by name.
ConfigNodeBuilder	withComment(java.lang.String comment)
ConfigNodeBuilder	withName(java.lang.String name)
ConfigNodeBuilder	withParent(ConfigNodeBuilder parent)
ConfigNodeBuilder	withSeparateSerialization() Marks the built node as being serialized separately
ConfigNodeBuilder	withSeparateSerialization(boolean serializeSeparately)

Methods inherited from class java.lang.Object

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

Field Detail

parent

@Nullable
protected ConfigNodeBuilder parent

name

@Nullable
protected java.lang.String name

Constructor Detail

ConfigNodeBuilder

public ConfigNodeBuilder()

Method Detail

getItems

@Nonnull
public java.util.Collection<TreeItem> getItems()

Returns a collection of this node's children.

The returned collection is guaranteed to have no two nodes with the same name. Elements may be removed from it, but no elements may be added directly.

Specified by:

getItems in interface NodeLike

Returns:

the set of children

See Also:

add(TreeItem)

lookup

@Nullable
public TreeItem lookup(java.lang.String name)

Tries to find a child in this node by name. If a child is found, it will be returned.

Specified by:

lookup in interface NodeLike

Parameters:

name - The name of the child to look for

Returns:

the child if found, otherwise null

withParent

public ConfigNodeBuilder withParent(ConfigNodeBuilder parent)

withName

public ConfigNodeBuilder withName(java.lang.String name)

withComment

public ConfigNodeBuilder withComment(@Nullable
                                     java.lang.String comment)

withSeparateSerialization

public ConfigNodeBuilder withSeparateSerialization()

Marks the built node as being serialized separately

withSeparateSerialization

public ConfigNodeBuilder withSeparateSerialization(boolean serializeSeparately)

Parameters:

serializeSeparately - if true, the subtree will not appear in the serialized representation of the built Node

Returns:

this, for chaining

applyFromPojo

public ConfigNodeBuilder applyFromPojo(java.lang.Object pojo)
                                throws FiberException

Configure this builder using a POJO (Plain Old Java Object).

The node's structure will be based on the pojo's fields, recursively generating settings. The generated settings can be configured in the pojo's class declaration, using annotations such as Setting.

The generated ConfigValues will be bound to their respective fields, setting the latter when the former's value is updated.

Parameters:

pojo - an object serving as a base to reflectively generate a config tree

Returns:

this, for chaining

Throws:

FiberException

See Also:

Setting, Settings, AnnotatedSettings.applyToNode(ConfigNodeBuilder, Object)

beginValue

public <T> ConfigValueBuilder<T> beginValue(@Nonnull
                                            java.lang.String name,
                                            @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:

ConfigValueBuilder

beginValue

public <T> ConfigValueBuilder<T> beginValue(@Nonnull
                                            java.lang.String name,
                                            @Nonnull
                                            T defaultValue)

Creates a ConfigValueBuilder with the given default value.

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:

ConfigValueBuilder, ConfigAggregateBuilder

beginAggregateValue

public <E> ConfigAggregateBuilder<E[],E> beginAggregateValue(@Nonnull
                                                             java.lang.String name,
                                                             @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

beginAggregateValue

public <C extends java.util.Collection<E>,E> ConfigAggregateBuilder<C,E> beginAggregateValue(@Nonnull
                                                                                             java.lang.String name,
                                                                                             @Nonnull
                                                                                             C defaultValue,
                                                                                             @Nullable
                                                                                             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

add

public ConfigNodeBuilder add(@Nonnull
                             TreeItem item)
                      throws FiberException

Attempts to introduce a new child to this node.

Parameters:

item - The child to add

Throws:

FiberException - if there was already a child by the same name

See Also:

Property

add

public ConfigNodeBuilder add(@Nonnull
                             TreeItem item,
                             boolean overwrite)
                      throws FiberException

Attempts to introduce a new child to this node.

Parameters:

item - The child to add

overwrite - whether existing items should be overwritten

Throws:

FiberException - if there was already a child by the same name

See Also:

Property

remove

public TreeItem remove(java.lang.String name)

Attempts to remove an item from this node by name.

Parameters:

name - the name of the child that should be removed

Returns:

the child if removed, otherwise null

fork

public ConfigNodeBuilder fork(java.lang.String name)

Forks this builder, creating a subtree whose parent is this node.

Parameters:

name - the name of the new Node

Returns:

the created node builder

build

public ConfigNode build()

Construct a new ConfigNode based on this builder's specifications.

This method cannot be called more than once, as allowing multiple nodes to be built would result in duplicated references. To guard against this, usually undesirable, behaviour, this method will throw an exception on successive calls.

Returns:

a new ConfigNode

Throws:

java.lang.IllegalStateException - if this builder already built a node

finishNode

public ConfigNodeBuilder finishNode()

finishNode

public ConfigNodeBuilder finishNode(java.util.function.Consumer<ConfigNode> action)