me.zeroeightsix.fiber.impl.tree

Class ConfigNodeImpl

java.lang.Object

me.zeroeightsix.fiber.impl.tree.ConfigNodeImpl

All Implemented Interfaces:

Commentable, ConfigNode

Direct Known Subclasses:

ConfigBranchImpl, ConfigLeafImpl

public abstract class ConfigNodeImpl
extends java.lang.Object
implements ConfigNode, Commentable

A commentable node.

See Also:

ConfigNode, ConfigBranchImpl, ConfigLeafImpl

Constructor Summary

Constructors

Constructor and Description
ConfigNodeImpl(java.lang.String name, java.lang.String comment) Creates a new ConfigLeaf.

Method Summary

Modifier and Type	Method and Description
void	attachTo(ConfigBranch parent) Attaches this node to an existing branch.
void	detach() Detaches this node from its parent branch, if any.
java.util.Map<FiberId,ConfigAttribute<?>>	getAttributes() Returns the map describing the attributes of this node.
<A> java.util.Optional<A>	getAttributeValue(FiberId id, java.lang.Class<A> expectedType) Retrieves the value of the attribute with the given id.
java.lang.String	getComment() Returns the comment that was assigned to this class
java.lang.String	getName() Returns this node's name.
<A> ConfigAttribute<A>	getOrCreateAttribute(FiberId id, java.lang.Class<A> attributeType, A defaultValue) Retrieves the attribute with the given id.
ConfigBranch	getParent() Returns this node's parent, if any.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigNodeImpl

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

Creates a new ConfigLeaf.

Parameters:

name - the name for this leaf

comment - the comment for this leaf

Method Detail

getName

@Nonnull
public java.lang.String getName()

Description copied from interface: ConfigNode

Returns this node's name.

Specified by:

getName in interface ConfigNode

Returns:

this node's name

getComment

@Nullable
public java.lang.String getComment()

Description copied from interface: Commentable

Returns the comment that was assigned to this class

Specified by:

getComment in interface Commentable

Returns:

the comment

getParent

@Nullable
public ConfigBranch getParent()

Description copied from interface: ConfigNode

Returns this node's parent, if any.

Specified by:

getParent in interface ConfigNode

Returns:

this node's parent, or null if it is not part of a config tree

getAttributes

public java.util.Map<FiberId,ConfigAttribute<?>> getAttributes()

Description copied from interface: ConfigNode

Returns the map describing the attributes of this node.

Attributes store metadata pertaining to the node itself, rather than its value. The returned map can be mutated by third parties to supplement the default node metadata. Examples of attributes include translation keys or rendering information.

As the returned data structure is shared by every attribute source, attributes should be grouped by namespace.

Specified by:

getAttributes in interface ConfigNode

Returns:

this node's configurable attributes

getOrCreateAttribute

public <A> ConfigAttribute<A> getOrCreateAttribute(FiberId id,
                                                   java.lang.Class<A> attributeType,
                                                   @Nullable
                                                   A defaultValue)

Description copied from interface: ConfigNode

Retrieves the attribute with the given id. If it does not exist, one is created with the given type and default value.

Specified by:

getOrCreateAttribute in interface ConfigNode

Type Parameters:

A - the type of value stored by the attribute

Parameters:

id - the id of the desired attribute

attributeType - the type of values held by the attribute

defaultValue - the default value, used if the attribute does not exist

Returns:

the current (existing or computed) attribute associated with the given id

See Also:

ConfigNode.getAttributes()

getAttributeValue

public <A> java.util.Optional<A> getAttributeValue(FiberId id,
                                                   java.lang.Class<A> expectedType)

Description copied from interface: ConfigNode

Retrieves the value of the attribute with the given id.

Specified by:

getAttributeValue in interface ConfigNode

Type Parameters:

A - the type of values expected from the attribute

Parameters:

id - the attribute's id

expectedType - the class object describing the type of values expected

Returns:

an Optional describing the value of the attribute, or an empty Optional if the attribute does not exist

detach

public void detach()

Description copied from interface: ConfigNode

Detaches this node from its parent branch, if any.

After this method has returned, this node will be removed from the current parent's children, and this node's parent will be set to null.

This method has no effect is this node has no parent.

Specified by:

detach in interface ConfigNode

See Also:

NodeCollection.remove(Object)

attachTo

public void attachTo(ConfigBranch parent)

Description copied from interface: ConfigNode

Attaches this node to an existing branch.

After this method has returned normally, this node will be part of the branch's children, and this node's parent will be set to parent.

If parent is null, this method does not mutate any state. It will however still throw IllegalTreeStateException if this node is not in a suitable state to be attached to another parent. To detach the node from its current parent, use ConfigNode.detach().

Specified by:

attachTo in interface ConfigNode

Parameters:

parent - the new parent branch for this node

See Also:

NodeCollection.add(ConfigNode, boolean)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object