me.zeroeightsix.fiber.api.tree

Interface ConfigTree

All Known Subinterfaces:

ConfigBranch

All Known Implementing Classes:

ConfigBranchImpl, ConfigTreeBuilder

public interface ConfigTree

Method Summary

Modifier and Type	Method and Description
static ConfigTreeBuilder	builder()
static ConfigTreeBuilder	builder(ConfigTree parent, java.lang.String name) Creates a new non-root ConfigTreeBuilder with a name.
NodeCollection	getItems() Returns a collection of this node's children.
ConfigNode	lookup(java.lang.String name) Tries to find a child in this node by name.

Method Detail

builder

static ConfigTreeBuilder builder()

Returns:

a new builder for a root config node

builder

static ConfigTreeBuilder builder(@Nullable
                                 ConfigTree parent,
                                 @Nullable
                                 java.lang.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(java.lang.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