me.zeroeightsix.fiber.builder

Class ConfigTreeBuilder

java.lang.Object

me.zeroeightsix.fiber.builder.ConfigTreeBuilder

All Implemented Interfaces:

ConfigTree

public class ConfigTreeBuilder
extends java.lang.Object
implements ConfigTree

A builder for configuration trees/branches.

Usage example:

 ConfigNode config = new ConfigNodeBuilder()
         .beginValue("version", "1.0.0")
             .withFinality()
             .beginConstraints() // checks the default value
                 .regex("\\d+\\.\\d+\\.\\d+")
             .finishConstraints()
         .finishValue()
         .fork("child")
             .beginValue("A", 10)
                 .beginConstraints()
                     .composite(CompositeType.OR)
                         .atLeast(3)
                         .atMost(0)
                     .finishComposite()
                 .finishConstraints()
             .finishValue()
         .finishNode()
         .build();
 

See Also:

ConfigTree.builder(), PropertyMirror

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ConfigTreeBuilder()

Method Summary

Modifier and Type	Method and Description
ConfigTreeBuilder	add(ConfigNode item) Attempts to introduce a new child to this node.
ConfigTreeBuilder	add(ConfigNode item, boolean overwrite) Attempts to introduce a new child to this node.
ConfigTreeBuilder	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 ConfigLeafBuilder.
<E> ConfigAggregateBuilder<E[],E>	beginAggregateValue(java.lang.String name, E[] defaultValue) Creates an aggregate ConfigLeafBuilder.
<T> ConfigLeafBuilder<T>	beginValue(java.lang.String name, java.lang.Class<T> type) Creates a scalar ConfigLeafBuilder.
<T> ConfigLeafBuilder<T>	beginValue(java.lang.String name, T defaultValue) Creates a ConfigLeafBuilder with the given default value.
ConfigBranch	build() Construct a new ConfigNode based on this builder's specifications.
ConfigTreeBuilder	finishNode()
ConfigTreeBuilder	finishNode(java.util.function.Consumer<ConfigBranch> action)
ConfigTreeBuilder	fork(java.lang.String name) Forks this builder, creating a subtree whose parent is this node.
java.util.Collection<ConfigNode>	getItems() Returns a collection of this builder's children.
ConfigNode	lookup(java.lang.String name) Tries to find a child in this builder by name.
ConfigNode	remove(java.lang.String name) Attempts to remove an item from this node by name.
ConfigTreeBuilder	withComment(java.lang.String comment)
ConfigTreeBuilder	withName(java.lang.String name)
ConfigTreeBuilder	withParent(ConfigTreeBuilder parent)
ConfigTreeBuilder	withSeparateSerialization() Marks the built subtree as being serialized separately.
ConfigTreeBuilder	withSeparateSerialization(boolean serializeSeparately) Sets whether a subtree should be serialized separately.

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.zeroeightsix.fiber.tree.ConfigTree

builder

Field Detail

parent

@Nullable
protected ConfigTreeBuilder parent

name

@Nullable
protected java.lang.String name

Constructor Detail

ConfigTreeBuilder

public ConfigTreeBuilder()

Method Detail

getItems

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

Returns a collection of this builder'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 ConfigTree

Returns:

the set of children

See Also:

add(ConfigNode)

lookup

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

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

Specified by:

lookup in interface ConfigTree

Parameters:

name - The name of the child to look for

Returns:

the child if found, otherwise null

withParent

public ConfigTreeBuilder withParent(ConfigTreeBuilder parent)

withName

public ConfigTreeBuilder withName(java.lang.String name)

withComment

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

withSeparateSerialization

public ConfigTreeBuilder withSeparateSerialization()

Marks the built subtree as being serialized separately.

A subtree marked for separate serialization will not appear in the serialized representation of its ancestors. This property can be useful when partitioning a big configuration tree into several files.

This method has no effect if the built node is a tree root.

Returns:

this, for chaining

See Also:

withSeparateSerialization(), ConfigBranch.isSerializedSeparately()

withSeparateSerialization

public ConfigTreeBuilder withSeparateSerialization(boolean serializeSeparately)

Sets whether a subtree should be serialized separately.

If serializeSeparately is true, the subtree created from this builder will not appear in the serialized representation of the ancestor. This property can be especially useful when partitioning a big configuration tree into several files.

This method has no effect if the built node is a tree root.

Parameters:

serializeSeparately - true if the built tree should be serialized separately

Returns:

this, for chaining

applyFromPojo

public ConfigTreeBuilder 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 ConfigLeafs 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(ConfigTreeBuilder, Object)

beginValue

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

Creates a scalar ConfigLeafBuilder.

Type Parameters:

T - the type type represents

Parameters:

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

Returns:

the newly created builder

See Also:

ConfigLeafBuilder

beginValue

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

Creates a ConfigLeafBuilder with the given default value.

Type Parameters:

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

Parameters:

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

Returns:

the newly created builder

See Also:

ConfigLeafBuilder, ConfigAggregateBuilder

beginAggregateValue

public <E> ConfigAggregateBuilder<E[],E> beginAggregateValue(@Nonnull
                                                             java.lang.String name,
                                                             @Nonnull
                                                             E[] defaultValue)

Creates an aggregate ConfigLeafBuilder.

Type Parameters:

E - the type of elements defaultValue holds

Parameters:

defaultValue - the default array of values the ConfigLeaf 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 ConfigLeafBuilder.

Type Parameters:

C - the type of collection defaultValue is

E - the type elementType represents

Parameters:

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

elementType - the class of the type of elements defaultValue holds

Returns:

the newly created builder

add

public ConfigTreeBuilder add(@Nonnull
                             ConfigNode 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 ConfigTreeBuilder add(@Nonnull
                             ConfigNode 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 ConfigNode 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 ConfigTreeBuilder 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 ConfigBranch 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 ConfigTreeBuilder finishNode()

finishNode

public ConfigTreeBuilder finishNode(java.util.function.Consumer<ConfigBranch> action)