me.zeroeightsix.fiber.impl.tree

Class ConfigBranchImpl

java.lang.Object

me.zeroeightsix.fiber.impl.tree.ConfigNodeImpl

me.zeroeightsix.fiber.impl.tree.ConfigBranchImpl

All Implemented Interfaces:

Commentable, ConfigBranch, ConfigNode, ConfigTree

public class ConfigBranchImpl
extends ConfigNodeImpl
implements ConfigBranch

Class implementing ConfigBranch

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
NodeCollection	getItems() Returns a collection of this branch's children.
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 class me.zeroeightsix.fiber.impl.tree.ConfigNodeImpl

attachTo, detach, getAttributes, getAttributeValue, getComment, getName, getOrCreateAttribute, getParent, 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.api.tree.ConfigBranch

getName

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

Constructor Detail

ConfigBranchImpl

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

Creates a new ConfigBranch.

Parameters:

name - the name for this ConfigBranchImpl

comment - the comment for this ConfigBranchImpl

items - the node's items

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

ConfigBranchImpl

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

Creates a new ConfigBranch with the provided name and comment.

This node will not be serialised separately.

Parameters:

name - the name for this ConfigBranchImpl

comment - the comment for this ConfigBranchImpl

ConfigBranchImpl

public ConfigBranchImpl()

Creates a new ConfigBranch without a name or comment.

This node will not be serialised separately.

Method Detail

getItems

@Nonnull
public NodeCollection getItems()

Description copied from interface: ConfigBranch

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 ConfigBranch

Specified by:

getItems in interface ConfigTree

Returns:

the set of children

See Also:

NodeOperations

lookup

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

Description copied from interface: ConfigBranch

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 ConfigBranch

Specified by:

lookup in interface ConfigTree

Parameters:

name - The name of the child to look for

Returns:

the child if found, otherwise null

isSerializedSeparately

public boolean isSerializedSeparately()

Description copied from interface: ConfigBranch

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.

Specified by:

isSerializedSeparately in interface ConfigBranch

Returns:

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