me.zeroeightsix.fiber.tree

Interface Node

All Superinterfaces:

NodeLike, TreeItem

All Known Implementing Classes:

ConfigNode

public interface Node
extends NodeLike, TreeItem

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

See Also:

ConfigNode

Method Summary

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

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 TreeItem

Returns:

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

lookup

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

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

Specified by:

lookup in interface NodeLike

Parameters:

name - The name of the child to look for

Returns:

the child if found, otherwise null

getItems

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

Returns a collection of this node's children.

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

Specified by:

getItems in interface NodeLike

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