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

Interface ConfigTree

All Known Subinterfaces:

ConfigBranch

All Known Implementing Classes:

ConfigBranchImpl, ConfigTreeBuilder

public interface ConfigTree

A container for a tree structure of ConfigNode.

Method Summary

Modifier and Type	Method and Description
static ConfigTreeBuilder	builder() Creates a new builder for a root config node.
static ConfigTreeBuilder	builder(ConfigTree parent, String name) Creates a new non-root ConfigTreeBuilder with a name.
NodeCollection	getItems() Returns a collection of this node's children.
ConfigNode	lookup(String name) Tries to find a child in this node by name.
boolean	lookupAndBind(String name, PropertyMirror<?> mirror) Tries to find a child leaf in this node by name.
ConfigBranch	lookupBranch(String name) Tries to find a child branch in this node by name.
<T> ConfigLeaf<T>	lookupLeaf(String name, SerializableType<T> type) Tries to find a child leaf in this node by name.

Method Detail

builder

static ConfigTreeBuilder builder()

Creates a new builder for a root config node.

builder

static ConfigTreeBuilder builder(@Nullable
                                 ConfigTree parent,
                                 @Nullable
                                 String name)

Creates a new non-root ConfigTreeBuilder with a name.

The built subtree will be attached to parent, with the given name. To generate a whole tree from the root, use builder() instead.

Parameters:

parent - the parent of the builder to create

name - the name of the ConfigTree created by the builder

Returns:

a ConfigTreeBuilder for an intermediary config branch

See Also:

builder()

getItems

@Nonnull
NodeCollection getItems()

Returns a collection of this node's children.

The returned collection is guaranteed to have no two nodes with the same name. Any changes made to it will be reflected by this tree.

Returns:

the set of children

See Also:

NodeOperations

lookup

@Nullable
ConfigNode lookup(String name)

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

Parameters:

name - The name of the child to look for.

Returns:

the child if found, otherwise null.

lookupBranch

@Nullable
ConfigBranch lookupBranch(String name)

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

Parameters:

name - The name of the child to look for.

Returns:

The child branch if found, otherwise null.

lookupLeaf

@Nullable
<T> ConfigLeaf<T> lookupLeaf(String name,
                                       SerializableType<T> type)

Tries to find a child leaf in this node by name. If a child with the right type is found, it will be returned.

Type Parameters:

T - the type of values held by the leaf

Parameters:

name - the name of the leaf to look for

type - a SerializableType object representing the type of values held by the leaf

Returns:

the leaf if found, otherwise null

lookupAndBind

boolean lookupAndBind(String name,
                      PropertyMirror<?> mirror)

Tries to find a child leaf in this node by name. If a child with the right type is found, the mirror will be bound to it.

Parameters:

name - the name of the leaf to mirror

mirror - the mirror to bind to the leaf

Returns:

true if the operation succeeded