me.zeroeightsix.fiber.api.tree

Interface ConfigNode

All Known Subinterfaces:

ConfigBranch, ConfigLeaf<T>

All Known Implementing Classes:

ConfigBranchImpl, ConfigLeafImpl, ConfigNodeImpl

public interface ConfigNode

The building block of a tree: every node implement this interface.

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

Method Detail

getName

java.lang.String getName()

Returns this node's name.

Returns:

this node's name

getAttributes

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

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.

Returns:

this node's configurable attributes

getAttributeValue

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

Retrieves the value of the attribute with the given id.

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

Throws:

java.lang.ClassCastException - if the attribute exists but has a type that is not assignable to expectedType

getOrCreateAttribute

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

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

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:

getAttributes()

getParent

@Nullable
ConfigBranch getParent()

Returns this node's parent, if any.

Returns:

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

attachTo

void attachTo(ConfigBranch parent)
       throws DuplicateChildException,
              IllegalTreeStateException

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 detach().

Parameters:

parent - the new parent branch for this node

Throws:

DuplicateChildException - if the new parent already has a child of the same name

IllegalTreeStateException - if this node is already attached to another branch

See Also:

NodeCollection.add(ConfigNode, boolean)

detach

void detach()

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.

See Also:

NodeCollection.remove(Object)