me.zeroeightsix.fiber.tree

Interface Node

All Superinterfaces:

TreeItem

All Known Implementing Classes:

ConfigNode

public interface Node
extends TreeItem

A member of a tree that can hold any amount of children

See Also:

ConfigNode

Method Summary

Modifier and Type	Method and Description
default TreeItem	add(TreeItem item) Attempts to introduce a new child to this node.
default Node	fork(java.lang.String name) Forks this node, creating a subtree whose parent is this node.
default Node	fork(java.lang.String name, boolean serializeSeparately) Forks this node, creating a subtree whose parent is this node.
java.util.Set<TreeItem>	getItems() Returns a set of this node's children.
default boolean	isSerializedSeparately() Returns true if this node should be serialized separately to its parent.
default TreeItem	lookup(java.lang.String name) Tries to find a child in this node by name.
default TreeItem	remove(java.lang.String name) Attempts to remove an item from this node by name.

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

getName

Method Detail

getItems

@Nonnull
java.util.Set<TreeItem> getItems()

Returns a set of this node's children.

Returns:

the set of children

isSerializedSeparately

default boolean isSerializedSeparately()

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

If a node is serialized separately, it should not appear in the serialized representation of its parent. This setting has no effect if this node is a root.

Returns:

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

lookup

@Nullable
default 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.

Parameters:

name - The name of the child to look for

Returns:

the child if found, otherwise null

add

default TreeItem add(@Nonnull
                     TreeItem item)
              throws FiberException

Attempts to introduce a new child to this node.

Parameters:

item - The child to add

Returns:

the child

Throws:

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

See Also:

Property

remove

default 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

default Node fork(java.lang.String name)
           throws FiberException

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

Parameters:

name - the name of the new Node

Returns:

the created node

Throws:

FiberException - if the new node cannot be added as a child to this node

fork

default Node fork(java.lang.String name,
                  boolean serializeSeparately)
           throws FiberException

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

Parameters:

name - the name of the new Node

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

Returns:

the created node

Throws:

FiberException - if the new node cannot be added as a child to this node