io.github.fablabsmc.fablabs.impl.fiber.tree

Class ConfigBranchImpl

java.lang.Object

io.github.fablabsmc.fablabs.impl.fiber.tree.ConfigNodeImpl

io.github.fablabsmc.fablabs.impl.fiber.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(String name, String comment) Creates a new ConfigBranch with the provided name and comment.
ConfigBranchImpl(String name, String comment, 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(String name) Tries to find a child in this group by name.
boolean	lookupAndBind(String name, PropertyMirror<?> mirror) Tries to find a child leaf in this node by name.
ConfigBranch	lookupBranch(String name) Tries to find a child branch in this node by name.
<T> ConfigLeaf<T>	lookupLeaf(String name, SerializableType<T> type) Tries to find a child leaf in this node by name.

Methods inherited from class io.github.fablabsmc.fablabs.impl.fiber.tree.ConfigNodeImpl

attachTo, detach, getAttributes, getAttributeValue, 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 io.github.fablabsmc.fablabs.api.fiber.v1.tree.ConfigBranch

getName

Methods inherited from interface io.github.fablabsmc.fablabs.api.fiber.v1.tree.ConfigTree

builder, builder

Methods inherited from interface io.github.fablabsmc.fablabs.api.fiber.v1.tree.ConfigNode

attachTo, detach, getAttributes, getAttributeValue, getAttributeValue, getOrCreateAttribute, getParent

Methods inherited from interface io.github.fablabsmc.fablabs.api.fiber.v1.tree.Commentable

getComment

Constructor Detail

ConfigBranchImpl

public ConfigBranchImpl(String name,
                        @Nullable
                        String comment,
                        @Nonnull
                        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
                        String name,
                        @Nullable
                        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(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

lookupLeaf

@Nullable
public <T> ConfigLeaf<T> lookupLeaf(String name,
                                              SerializableType<T> type)

Description copied from interface: ConfigTree

Tries to find a child leaf in this node by name. If a child with the right type is found, it will be returned.

Specified by:

lookupLeaf in interface ConfigTree

Type Parameters:

T - the type of values held by the leaf

Parameters:

name - the name of the leaf to look for

type - a SerializableType object representing the type of values held by the leaf

Returns:

the leaf if found, otherwise null

lookupAndBind

public boolean lookupAndBind(String name,
                             PropertyMirror<?> mirror)

Description copied from interface: ConfigTree

Tries to find a child leaf in this node by name. If a child with the right type is found, the mirror will be bound to it.

Specified by:

lookupAndBind in interface ConfigTree

Parameters:

name - the name of the leaf to mirror

mirror - the mirror to bind to the leaf

Returns:

true if the operation succeeded

lookupBranch

@Nullable
public ConfigBranch lookupBranch(String name)

Description copied from interface: ConfigTree

Tries to find a child branch in this node by name. If a child is found, and it is a branch node, it is returned.

Specified by:

lookupBranch in interface ConfigTree

Parameters:

name - The name of the child to look for.

Returns:

The child branch 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