ninja.leaping.configurate.commented

Class SimpleCommentedConfigurationNode

java.lang.Object

ninja.leaping.configurate.SimpleConfigurationNode

ninja.leaping.configurate.commented.SimpleCommentedConfigurationNode

All Implemented Interfaces:

CommentedConfigurationNode, ConfigurationNode

public class SimpleCommentedConfigurationNode
extends SimpleConfigurationNode
implements CommentedConfigurationNode

Represents a configuration node containing comments

Field Summary

Fields inherited from interface ninja.leaping.configurate.ConfigurationNode

NUMBER_DEF

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimpleCommentedConfigurationNode(Object path, SimpleConfigurationNode parent, ConfigurationOptions options)

Method Summary

Modifier and Type	Method and Description
protected SimpleCommentedConfigurationNode	createNode(Object path)
boolean	equals(Object o)
SimpleCommentedConfigurationNode	getAppendedNode()
List<? extends SimpleCommentedConfigurationNode>	getChildrenList() Return an immutable copy of the list of children this node is aware of
Map<Object,? extends SimpleCommentedConfigurationNode>	getChildrenMap() Return an immutable copy of the mapping from key to node of every child this node is aware of
Optional<String>	getComment() Gets the current value for the comment.
SimpleCommentedConfigurationNode	getNode(Object... path) Gets the node at the given (relative) path, possibly traversing multiple levels of nodes
SimpleCommentedConfigurationNode	getParent() Returns the current parent for this node.
int	hashCode()
SimpleCommentedConfigurationNode	mergeValuesFrom(ConfigurationNode other) Set all the values from the given node that are not present in this node to their values in the provided node.
static SimpleCommentedConfigurationNode	root()
static SimpleCommentedConfigurationNode	root(ConfigurationOptions options)
SimpleCommentedConfigurationNode	setComment(String comment) Sets the comment for this configuration.
SimpleCommentedConfigurationNode	setValue(Object value) Set this node's value to the given value.
String	toString()

Methods inherited from class ninja.leaping.configurate.SimpleConfigurationNode

attachChild, attachIfNecessary, clear, getChild, getKey, getList, getList, getList, getList, getList, getOptions, getPath, getValue, getValue, getValue, getValue, getValue, getValue, hasListChildren, hasMapChildren, isVirtual, removeChild

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ninja.leaping.configurate.ConfigurationNode

getBoolean, getBoolean, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getKey, getList, getList, getList, getList, getList, getList, getLong, getLong, getOptions, getPath, getString, getString, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, hasListChildren, hasMapChildren, isVirtual, removeChild, setValue

Constructor Detail

SimpleCommentedConfigurationNode

protected SimpleCommentedConfigurationNode(Object path,
                                           SimpleConfigurationNode parent,
                                           ConfigurationOptions options)

Method Detail

root

public static SimpleCommentedConfigurationNode root()

root

public static SimpleCommentedConfigurationNode root(ConfigurationOptions options)

getComment

public Optional<String> getComment()

Description copied from interface: CommentedConfigurationNode

Gets the current value for the comment. If the comment contains multiple lines, the lines will be split by \n

Specified by:

getComment in interface CommentedConfigurationNode

Returns:

the configuration's current comment

setComment

public SimpleCommentedConfigurationNode setComment(String comment)

Description copied from interface: CommentedConfigurationNode

Sets the comment for this configuration.

Specified by:

setComment in interface CommentedConfigurationNode

Parameters:

comment - The comment to set. Line breaks should be represented as LFs (\n)

Returns:

this

getParent

public SimpleCommentedConfigurationNode getParent()

Description copied from interface: ConfigurationNode

Returns the current parent for this node. If this node is currently virtual, this method's result may be inaccurate.

Specified by:

getParent in interface CommentedConfigurationNode

Specified by:

getParent in interface ConfigurationNode

Overrides:

getParent in class SimpleConfigurationNode

Returns:

The appropriate parent

createNode

protected SimpleCommentedConfigurationNode createNode(Object path)

Overrides:

createNode in class SimpleConfigurationNode

setValue

public SimpleCommentedConfigurationNode setValue(Object value)

Description copied from interface: ConfigurationNode

Set this node's value to the given value. If the provided value is a Collection or a Map, it will be unwrapped into the appropriate configuration node structure

Specified by:

setValue in interface CommentedConfigurationNode

Specified by:

setValue in interface ConfigurationNode

Overrides:

setValue in class SimpleConfigurationNode

Parameters:

value - The value to set

Returns:

this

mergeValuesFrom

public SimpleCommentedConfigurationNode mergeValuesFrom(ConfigurationNode other)

Description copied from interface: ConfigurationNode

Set all the values from the given node that are not present in this node to their values in the provided node. Map keys will be merged. Lists and scalar values will be replaced.

Specified by:

mergeValuesFrom in interface CommentedConfigurationNode

Specified by:

mergeValuesFrom in interface ConfigurationNode

Overrides:

mergeValuesFrom in class SimpleConfigurationNode

Parameters:

other - The node to merge values from

Returns:

this

getNode

public SimpleCommentedConfigurationNode getNode(Object... path)

Description copied from interface: ConfigurationNode

Gets the node at the given (relative) path, possibly traversing multiple levels of nodes

Specified by:

getNode in interface CommentedConfigurationNode

Specified by:

getNode in interface ConfigurationNode

Overrides:

getNode in class SimpleConfigurationNode

Parameters:

path - The path to fetch the node at

Returns:

The node at the given path, possibly virtual

getChildrenList

public List<? extends SimpleCommentedConfigurationNode> getChildrenList()

Description copied from interface: ConfigurationNode

Return an immutable copy of the list of children this node is aware of

Specified by:

getChildrenList in interface CommentedConfigurationNode

Specified by:

getChildrenList in interface ConfigurationNode

Overrides:

getChildrenList in class SimpleConfigurationNode

Returns:

The children currently attached to this node

getChildrenMap

public Map<Object,? extends SimpleCommentedConfigurationNode> getChildrenMap()

Description copied from interface: ConfigurationNode

Return an immutable copy of the mapping from key to node of every child this node is aware of

Specified by:

getChildrenMap in interface CommentedConfigurationNode

Specified by:

getChildrenMap in interface ConfigurationNode

Overrides:

getChildrenMap in class SimpleConfigurationNode

Returns:

Child nodes currently attached

getAppendedNode

public SimpleCommentedConfigurationNode getAppendedNode()

Specified by:

getAppendedNode in interface CommentedConfigurationNode

Specified by:

getAppendedNode in interface ConfigurationNode

Overrides:

getAppendedNode in class SimpleConfigurationNode

Returns:

a new child created as the next entry in the list when it is attached

equals

public boolean equals(Object o)

Overrides:

equals in class SimpleConfigurationNode

hashCode

public int hashCode()

Overrides:

hashCode in class SimpleConfigurationNode

toString

public String toString()

Overrides:

toString in class SimpleConfigurationNode