me.zeroeightsix.fiber.api.tree

Interface ConfigBranch

All Superinterfaces:

Commentable, ConfigNode, ConfigTree

All Known Implementing Classes:

ConfigBranchImpl

public interface ConfigBranch
extends ConfigTree, ConfigNode, Commentable

A node that can hold any amount of children

A branch may represent an entire config tree, or a subtree grouping further configuration items.

See Also:

ConfigTreeBuilder

Method Summary

Modifier and Type	Method and Description
NodeCollection	getItems() Returns a collection of this branch's children.
java.lang.String	getName() Returns this node's name.
default boolean	isSerializedSeparately() Returns true if this node should be serialized separately from its parent.
ConfigNode	lookup(java.lang.String name) Tries to find a child in this group by name.

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

builder, builder

Methods inherited from interface me.zeroeightsix.fiber.api.tree.ConfigNode

attachTo, detach, getAttributes, getAttributeValue, getOrCreateAttribute, getParent

Methods inherited from interface me.zeroeightsix.fiber.api.tree.Commentable

getComment

Method Detail

getName

@Nullable
java.lang.String getName()

Returns this node's name.

If this node is the root of a config tree, it may not have a name. In this case, this method returns null.

Specified by:

getName in interface ConfigNode

Returns:

this node's name, or null if it does not have any.

lookup

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

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

The node returned for a given name is always the same.

Specified by:

lookup in interface ConfigTree

Parameters:

name - The name of the child to look for

Returns:

the child if found, otherwise null

getItems

@Nonnull
NodeCollection getItems()

Returns a collection of this branch's children.

The returned collection is guaranteed not to have two nodes with the same name.

Specified by:

getItems in interface ConfigTree

Returns:

the set of children

See Also:

NodeOperations

isSerializedSeparately

default boolean isSerializedSeparately()

Returns true if this node should be serialized separately from its parent.

If a node is serialized separately, it should not appear in the serialized representation of its ancestors. This property should be ignored if this node is the root of the currently serialised tree.

Returns:

true if this node should be serialized separately, and false otherwise