me.zeroeightsix.fiber.tree

Class ConfigNode

java.lang.Object

me.zeroeightsix.fiber.tree.ConfigLeaf

me.zeroeightsix.fiber.tree.ConfigNode

All Implemented Interfaces:

Commentable, Node, NodeLike, TreeItem

public class ConfigNode
extends ConfigLeaf
implements Node

A ConfigLeaf with children

Constructor Summary

Constructors

Constructor and Description
ConfigNode() Creates a new ConfigNode without a name or comment.
ConfigNode(java.lang.String name, java.lang.String comment) Creates a new ConfigNode with the provided name and comment.
ConfigNode(java.lang.String name, java.lang.String comment, java.util.Map<java.lang.String,TreeItem> items, boolean serializeSeparately) Creates a new ConfigNode.

Method Summary

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

Methods inherited from class me.zeroeightsix.fiber.tree.ConfigLeaf

getComment, getName, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getName

Constructor Detail

ConfigNode

public ConfigNode(java.lang.String name,
                  @Nullable
                  java.lang.String comment,
                  @Nonnull
                  java.util.Map<java.lang.String,TreeItem> items,
                  boolean serializeSeparately)

Creates a new ConfigNode.

Parameters:

name - the name for this ConfigNode

comment - the comment for this ConfigNode

items - the node's items

serializeSeparately - whether or not this node should be serialised separately. If true, it will be ignored during serialisation.

ConfigNode

public ConfigNode(@Nonnull
                  java.lang.String name,
                  @Nullable
                  java.lang.String comment)

Creates a new ConfigNode with the provided name and comment.

This node will not be serialised separately.

Parameters:

name - the name for this ConfigNode

comment - the comment for this ConfigNode

See Also:

ConfigNode

ConfigNode

public ConfigNode()

Creates a new ConfigNode without a name or comment.

This node will not be serialised separately.

See Also:

ConfigNode

Method Detail

builder

public static ConfigNodeBuilder builder()

Returns:

a new builder for a root config node

getItems

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

Description copied from interface: Node

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 Node

Specified by:

getItems in interface NodeLike

Returns:

the set of children

lookup

@Nullable
public TreeItem lookup(java.lang.String name)

Description copied from interface: Node

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 Node

Specified by:

lookup in interface NodeLike

Parameters:

name - The name of the child to look for

Returns:

the child if found, otherwise null

isSerializedSeparately

public boolean isSerializedSeparately()

Returns if this node should be serialised separately.

If true, it should be ignored during serialisation.

Specified by:

isSerializedSeparately in interface Node

Returns:

whether or not it is serialised separately