me.zeroeightsix.fiber.tree

Interface Node

All Superinterfaces:

TreeItem

All Known Implementing Classes:

ConfigNode

public interface Node
extends TreeItem

Method Summary

Modifier and Type	Method and Description
default TreeItem	add(TreeItem item)
default Node	fork(java.lang.String name) Forks this node, creating a subtree which parent is this node.
default Node	fork(java.lang.String name, boolean serializeSeparately) Forks this node, creating a subtree which parent is this node.
java.util.Set<TreeItem>	getItems()
default boolean	isSerializedSeparately() Returns true if this node should be serialized separately to its parent.
default TreeItem	lookup(java.lang.String name)
default TreeItem	remove(java.lang.String name)

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

getName

Method Detail

getItems

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

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)

add

default TreeItem add(@Nonnull
                     TreeItem item)
              throws FiberException

Throws:

FiberException

remove

default TreeItem remove(java.lang.String name)

fork

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

Forks this node, creating a subtree which 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 which 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