ninja.leaping.configurate.commented

Interface CommentedConfigurationNode

All Superinterfaces:

ConfigurationNode

All Known Implementing Classes:

SimpleCommentedConfigurationNode

public interface CommentedConfigurationNode
extends ConfigurationNode

A configuration node that is capable of having an attached comment

Method Summary

Modifier and Type	Method and Description
CommentedConfigurationNode	getAppendedNode()
List<? extends CommentedConfigurationNode>	getChildrenList() Return an immutable copy of the list of children this node is aware of
Map<Object,? extends CommentedConfigurationNode>	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.
CommentedConfigurationNode	getNode(Object... path) Gets the node at the given (relative) path, possibly traversing multiple levels of nodes
CommentedConfigurationNode	getParent() Returns the current parent for this node.
CommentedConfigurationNode	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.
CommentedConfigurationNode	setComment(String comment) Sets the comment for this configuration.
CommentedConfigurationNode	setValue(Object value) Set this node's value to the given value.

Methods inherited from interface ninja.leaping.configurate.ConfigurationNode

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

Method Detail

getComment

Optional<String> getComment()

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

Returns:

the configuration's current comment

setComment

CommentedConfigurationNode setComment(String comment)

Sets the comment for this configuration.

Parameters:

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

Returns:

this

getParent

CommentedConfigurationNode 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 ConfigurationNode

Returns:

The appropriate parent

getChildrenList

List<? extends CommentedConfigurationNode> 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 ConfigurationNode

Returns:

The children currently attached to this node

getChildrenMap

Map<Object,? extends CommentedConfigurationNode> 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 ConfigurationNode

Returns:

Child nodes currently attached

setValue

CommentedConfigurationNode 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 ConfigurationNode

Parameters:

value - The value to set

Returns:

this

mergeValuesFrom

CommentedConfigurationNode 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 ConfigurationNode

Parameters:

other - The node to merge values from

Returns:

this

getAppendedNode

CommentedConfigurationNode getAppendedNode()

Specified by:

getAppendedNode in interface ConfigurationNode

Returns:

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

getNode

CommentedConfigurationNode 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 ConfigurationNode

Parameters:

path - The path to fetch the node at

Returns:

The node at the given path, possibly virtual