Package org.spongepowered.configurate

Interface CommentedConfigurationNode

All Superinterfaces:

CommentedConfigurationNodeIntermediary<CommentedConfigurationNode>, ConfigurationNode, ScopedConfigurationNode<CommentedConfigurationNode>

public interface CommentedConfigurationNode
extends CommentedConfigurationNodeIntermediary<CommentedConfigurationNode>

A configuration node that can have a comment attached to it.

All other standard data is supported.

Since:

4.0.0

Field Summary

Fields inherited from interface org.spongepowered.configurate.ConfigurationNode

NUMBER_DEF

Method Summary

Static Methods

Modifier and Type	Method	Description
static ConfigurationNodeFactory<CommentedConfigurationNode>	factory()	Create a new factory providing CommentedConfigurationNode instances.
static CommentedConfigurationNode	root()	Create a new empty root node.
static CommentedConfigurationNode	root(ConfigurationOptions options)	Create a new empty root node with the provided options.
static <E extends Exception> CommentedConfigurationNode	root(ConfigurationOptions options, CheckedConsumer<? super CommentedConfigurationNode,E> action)	Create a new root node with the provided options and initializer.
static <E extends Exception> CommentedConfigurationNode	root(CheckedConsumer<? super CommentedConfigurationNode,E> action)	Create a new root node with the provided initializer.

Methods inherited from interface org.spongepowered.configurate.CommentedConfigurationNodeIntermediary

comment, comment, commentIfAbsent

Methods inherited from interface org.spongepowered.configurate.ConfigurationNode

empty, get, get, get, get, get, get, get, get, get, getBoolean, getBoolean, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getList, getList, getList, getList, getList, getList, getLong, getLong, getString, getString, hasChild, hasChild, hint, isList, isMap, isNull, key, options, ownHint, ownHints, path, raw, rawScalar, removeChild, require, require, require, virtual, visit, visit, visit, visit

Methods inherited from interface org.spongepowered.configurate.ScopedConfigurationNode

act, appendListNode, childrenList, childrenMap, copy, from, hint, mergeFrom, node, node, parent, raw, self, set, set, set, set, setList, setList, toListCollector, toListCollector, toMapCollector, toMapCollector

Method Detail

factory

static ConfigurationNodeFactory<CommentedConfigurationNode> factory()

Create a new factory providing CommentedConfigurationNode instances.

The returned factory will create nodes with default options.

Returns:

a new factory

Since:

4.0.0

root

static CommentedConfigurationNode root()

Create a new empty root node.

This node will use the default options

A root node is always attached, and has no parent and an empty path.

Returns:

a new empty node

Since:

4.0.0

root

static <E extends Exception> CommentedConfigurationNode root(CheckedConsumer<? super CommentedConfigurationNode,E> action)
                                                      throws E extends Exception

Create a new root node with the provided initializer.

This node will use the default options

A root node is always attached, and has no parent and an empty path.

Type Parameters:

E - thrown type

Parameters:

action - action to be applied to the newly created node

Returns:

a new initialized node

Throws:

E - when thrown from inner action

E extends Exception

Since:

4.0.0

root

static CommentedConfigurationNode root(ConfigurationOptions options)

Create a new empty root node with the provided options.

A root node is always attached, and has no parent and an empty path.

Parameters:

options - options to apply

Returns:

a new empty node

Since:

4.0.0

root

static <E extends Exception> CommentedConfigurationNode root(ConfigurationOptions options,
                                                             CheckedConsumer<? super CommentedConfigurationNode,E> action)
                                                      throws E extends Exception

Create a new root node with the provided options and initializer.

A root node is always attached, and has no parent and an empty path.

Type Parameters:

E - thrown type

Parameters:

options - options to apply

action - action to be applied to the newly created node

Returns:

a new initialized node

Throws:

E - when thrown from inner action

E extends Exception

Since:

4.0.0