ninja.leaping.configurate

Interface ConfigurationNode

All Known Subinterfaces:

CommentedConfigurationNode

All Known Implementing Classes:

SimpleCommentedConfigurationNode, SimpleConfigurationNode

public interface ConfigurationNode

A node in the configuration tree. This is more or less the main class of configurate, providing the methods to navigate through the configuration tree and get values

Field Summary

Fields

Modifier and Type	Field and Description
static int	NUMBER_DEF

Method Summary

Modifier and Type	Method and Description
ConfigurationNode	getAppendedNode()
default boolean	getBoolean() Gets the value typed using the appropriate type conversion from Types
default boolean	getBoolean(boolean def) Gets the value typed using the appropriate type conversion from Types
List<? extends ConfigurationNode>	getChildrenList() Return an immutable copy of the list of children this node is aware of
Map<Object,? extends ConfigurationNode>	getChildrenMap() Return an immutable copy of the mapping from key to node of every child this node is aware of
default double	getDouble() Gets the value typed using the appropriate type conversion from Types
default double	getDouble(double def) Gets the value typed using the appropriate type conversion from Types
default float	getFloat() Gets the value typed using the appropriate type conversion from Types
default float	getFloat(float def) Gets the value typed using the appropriate type conversion from Types
default int	getInt() Gets the value typed using the appropriate type conversion from Types
default int	getInt(int def) Gets the value typed using the appropriate type conversion from Types
Object	getKey() The key for this node.
<T> List<T>	getList(Function<Object,T> transformer) If this node has list values, this function unwraps them and converts them to an appropriate type based on the provided function.
<T> List<T>	getList(Function<Object,T> transformer, List<T> def) If this node has list values, this function unwraps them and converts them to an appropriate type based on the provided function.
<T> List<T>	getList(Function<Object,T> transformer, Supplier<List<T>> defSupplier) If this node has list values, this function unwraps them and converts them to an appropriate type based on the provided function.
default <T> List<T>	getList(TypeToken<T> type) If this node has list values, this function unwraps them and converts them to an appropriate type based on the provided type.
<T> List<T>	getList(TypeToken<T> type, List<T> def) If this node has list values, this function unwraps them and converts them to an appropriate type based on the provided type.
<T> List<T>	getList(TypeToken<T> type, Supplier<List<T>> defSupplier) If this node has list values, this function unwraps them and converts them to an appropriate type based on the provided type.
default long	getLong() Gets the value typed using the appropriate type conversion from Types
default long	getLong(long def) Gets the value typed using the appropriate type conversion from Types
ConfigurationNode	getNode(Object... path) Gets the node at the given (relative) path, possibly traversing multiple levels of nodes
ConfigurationOptions	getOptions() Return the options that currently apply to this node
ConfigurationNode	getParent() Returns the current parent for this node.
Object[]	getPath() The full path from the root to this node.
default String	getString() Gets the value typed using the appropriate type conversion from Types
default String	getString(String def) Gets the value typed using the appropriate type conversion from Types
default Object	getValue() Get the current value associated with this node.
default <T> T	getValue(Function<Object,T> transformer) Gets the appropriately transformed typed version of this node's value from the provided transformation function
<T> T	getValue(Function<Object,T> transformer, Supplier<T> defSupplier) Gets the appropriately transformed typed version of this node's value from the provided transformation function
<T> T	getValue(Function<Object,T> transformer, T def) Gets the appropriately transformed typed version of this node's value from the provided transformation function
Object	getValue(Object def) Get the current value associated with this node.
Object	getValue(Supplier<Object> defSupplier) Get the current value associated with this node.
default <T> T	getValue(TypeToken<T> type) Get the current value associated with this node.
<T> T	getValue(TypeToken<T> type, Supplier<T> defSupplier) Get the current value associated with this node.
<T> T	getValue(TypeToken<T> type, T def) Get the current value associated with this node.
boolean	hasListChildren()
boolean	hasMapChildren()
boolean	isVirtual() Whether this node does not currently exist in the configuration structure.
ConfigurationNode	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.
boolean	removeChild(Object key) Removes a direct child of this node
ConfigurationNode	setValue(Object value) Set this node's value to the given value.
default <T> ConfigurationNode	setValue(TypeToken<T> type, T value) Set this node's value to the given value.

Field Detail

NUMBER_DEF

static final int NUMBER_DEF

See Also:

Constant Field Values

Method Detail

getKey

Object getKey()

The key for this node. If this node is currently virtual, this method's result may be inaccurate.

Returns:

The key for this node

getPath

Object[] getPath()

The full path from the root to this node. Node implementations may keep a full path for each node, so this method may involve some object churn.

Returns:

An array compiled from the keys for each node up the hierarchy

getParent

ConfigurationNode getParent()

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

Returns:

The appropriate parent

getOptions

ConfigurationOptions getOptions()

Return the options that currently apply to this node

Returns:

The ConfigurationOptions instance that governs the functionality of this node

getValue

default Object getValue()

Get the current value associated with this node. If this node has children, this method will recursively unwrap them to construct a List or a Map

Returns:

This configuration's current value, or null if there is none

See Also:

getValue(Object)

getValue

Object getValue(Object def)

Get the current value associated with this node. If this node has children, this method will recursively unwrap them to construct a List or a Map

Parameters:

def - The default value to return if this node has no set value

Returns:

This configuration's current value, or def if there is none

getValue

Object getValue(Supplier<Object> defSupplier)

Get the current value associated with this node. If this node has children, this method will recursively unwrap them to construct a List or a Map

Parameters:

defSupplier - The function that will be called to calculate a default value only if there is no existing value

Returns:

This configuration's current value, or def if there is none

getValue

default <T> T getValue(Function<Object,T> transformer)

Gets the appropriately transformed typed version of this node's value from the provided transformation function

Type Parameters:

T - The expected type

Parameters:

transformer - The transformation function

Returns:

A transformed value of the correct type, or null either if no value is present or the value could not be converted

getValue

<T> T getValue(Function<Object,T> transformer,
               T def)

Gets the appropriately transformed typed version of this node's value from the provided transformation function

Type Parameters:

T - The expected type

Parameters:

transformer - The transformation function

def - The default value to return if this node has no set value or is not of a convertable type

Returns:

A transformed value of the correct type, or def either if no value is present or the value could not be converted

getValue

<T> T getValue(Function<Object,T> transformer,
               Supplier<T> defSupplier)

Gets the appropriately transformed typed version of this node's value from the provided transformation function

Type Parameters:

T - The expected type

Parameters:

transformer - The transformation function

defSupplier - The function that will be called to calculate a default value only if there is no existing value of the correct type

Returns:

A transformed value of the correct type, or def either if no value is present or the value could not be converted

getList

<T> List<T> getList(Function<Object,T> transformer)

If this node has list values, this function unwraps them and converts them to an appropriate type based on the provided function. If this node has a scalar value, this function treats it as a list with one value

Type Parameters:

T - The expected type

Parameters:

transformer - The transformation function

Returns:

An immutable copy of the values contained

getList

<T> List<T> getList(Function<Object,T> transformer,
                    List<T> def)

If this node has list values, this function unwraps them and converts them to an appropriate type based on the provided function. If this node has a scalar value, this function treats it as a list with one value

Type Parameters:

T - The expected type

Parameters:

transformer - The transformation function

def - The default value if no appropriate value is set

Returns:

An immutable copy of the values contained that could be successfully converted, or def if no values could be converted

getList

<T> List<T> getList(Function<Object,T> transformer,
                    Supplier<List<T>> defSupplier)

If this node has list values, this function unwraps them and converts them to an appropriate type based on the provided function. If this node has a scalar value, this function treats it as a list with one value

Type Parameters:

T - The expected type

Parameters:

transformer - The transformation function

defSupplier - The function that will be called to calculate a default value only if there is no existing value of the correct type

Returns:

An immutable copy of the values contained that could be successfully converted, or def if no values could be converted

getList

default <T> List<T> getList(TypeToken<T> type)
                     throws ObjectMappingException

If this node has list values, this function unwraps them and converts them to an appropriate type based on the provided type. If this node has a scalar value, this function treats it as a list with one value

Type Parameters:

T - The expected type

Parameters:

type - The expected type

Returns:

An immutable copy of the values contained

Throws:

ObjectMappingException

getList

<T> List<T> getList(TypeToken<T> type,
                    List<T> def)
             throws ObjectMappingException

If this node has list values, this function unwraps them and converts them to an appropriate type based on the provided type. If this node has a scalar value, this function treats it as a list with one value

Type Parameters:

T - The expected type

Parameters:

type - The expected type

def - The default value if no appropriate value is set

Returns:

An immutable copy of the values contained that could be successfully converted, or def if no values could be converted

Throws:

ObjectMappingException

getList

<T> List<T> getList(TypeToken<T> type,
                    Supplier<List<T>> defSupplier)
             throws ObjectMappingException

If this node has list values, this function unwraps them and converts them to an appropriate type based on the provided type. If this node has a scalar value, this function treats it as a list with one value

Type Parameters:

T - The expected type

Parameters:

type - The expected type

defSupplier - The function that will be called to calculate a default value only if there is no existing value of the correct type

Returns:

An immutable copy of the values contained that could be successfully converted, or def if no values could be converted

Throws:

ObjectMappingException

getString

default String getString()

Gets the value typed using the appropriate type conversion from Types

Returns:

The appropriate type conversion, null if no appropriate value is available

See Also:

getValue()

getString

default String getString(String def)

Gets the value typed using the appropriate type conversion from Types

Parameters:

def - The default value if no appropriate value is set

Returns:

The appropriate type conversion, def if no appropriate value is available

See Also:

getValue()

getFloat

default float getFloat()

Gets the value typed using the appropriate type conversion from Types

Returns:

The appropriate type conversion, 0 if no appropriate value is available

See Also:

getValue()

getFloat

default float getFloat(float def)

Gets the value typed using the appropriate type conversion from Types

Parameters:

def - The default value if no appropriate value is set

Returns:

The appropriate type conversion, def if no appropriate value is available

See Also:

getValue()

getDouble

default double getDouble()

Gets the value typed using the appropriate type conversion from Types

Returns:

The appropriate type conversion, 0 if no appropriate value is available

See Also:

getValue()

getDouble

default double getDouble(double def)

Gets the value typed using the appropriate type conversion from Types

Parameters:

def - The default value if no appropriate value is set

Returns:

The appropriate type conversion, def if no appropriate value is available

See Also:

getValue()

getInt

default int getInt()

Gets the value typed using the appropriate type conversion from Types

Returns:

The appropriate type conversion, 0 if no appropriate value is available

See Also:

getValue()

getInt

default int getInt(int def)

Gets the value typed using the appropriate type conversion from Types

Parameters:

def - The default value if no appropriate value is set

Returns:

The appropriate type conversion, def if no appropriate value is available

See Also:

getValue()

getLong

default long getLong()

Gets the value typed using the appropriate type conversion from Types

Returns:

The appropriate type conversion, 0 if no appropriate value is available

See Also:

getValue()

getLong

default long getLong(long def)

Gets the value typed using the appropriate type conversion from Types

Parameters:

def - The default value if no appropriate value is set

Returns:

The appropriate type conversion, def if no appropriate value is available

See Also:

getValue()

getBoolean

default boolean getBoolean()

Gets the value typed using the appropriate type conversion from Types

Returns:

The appropriate type conversion, false if no appropriate value is available

See Also:

getValue()

getBoolean

default boolean getBoolean(boolean def)

Gets the value typed using the appropriate type conversion from Types

Parameters:

def - The default value if no appropriate value is set

Returns:

The appropriate type conversion, def if no appropriate value is available

See Also:

getValue()

setValue

ConfigurationNode setValue(Object value)

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

Parameters:

value - The value to set

Returns:

this

getValue

default <T> T getValue(TypeToken<T> type)
                throws ObjectMappingException

Get the current value associated with this node. If this node has children, this method will recursively unwrap them to construct a List or a Map. This method will also perform deserialization using the appropriate TypeSerializer for the given type, or casting if no type serializer is found.

Type Parameters:

T - the type to get

Parameters:

type - The type to deserialize to

Returns:

the value if present and of the proper type, else null

Throws:

ObjectMappingException

getValue

<T> T getValue(TypeToken<T> type,
               T def)
        throws ObjectMappingException

Get the current value associated with this node. If this node has children, this method will recursively unwrap them to construct a List or a Map. This method will also perform deserialization using the appropriate TypeSerializer for the given type, or casting if no type serializer is found.

Type Parameters:

T - the type to get

Parameters:

type - The type to deserialize to

def - The value to return if no value or value is not of appropriate type

Returns:

the value if of the proper type, else def

Throws:

ObjectMappingException

getValue

<T> T getValue(TypeToken<T> type,
               Supplier<T> defSupplier)
        throws ObjectMappingException

Get the current value associated with this node. If this node has children, this method will recursively unwrap them to construct a List or a Map. This method will also perform deserialization using the appropriate TypeSerializer for the given type, or casting if no type serializer is found.

Type Parameters:

T - the type to get

Parameters:

type - The type to deserialize to

defSupplier - The function that will be called to calculate a default value only if there is no existing value of the correct type

Returns:

the value if of the proper type, else def

Throws:

ObjectMappingException

setValue

default <T> ConfigurationNode setValue(TypeToken<T> type,
                                       T value)
                                throws ObjectMappingException

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. This method will also perform serialization using the appropriate TypeSerializer for the given type, or casting if no type serializer is found.

Type Parameters:

T - The type to serialize to

Parameters:

type - The type to use for serialization type information

value - The value to set

Returns:

this

Throws:

ObjectMappingException

mergeValuesFrom

ConfigurationNode 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. Map keys will be merged. Lists and scalar values will be replaced.

Parameters:

other - The node to merge values from

Returns:

this

hasListChildren

boolean hasListChildren()

Returns:

if this node has children in the form of a list

hasMapChildren

boolean hasMapChildren()

Returns:

if this node has children in the form of a map

getChildrenList

List<? extends ConfigurationNode> getChildrenList()

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

Returns:

The children currently attached to this node

getChildrenMap

Map<Object,? extends ConfigurationNode> getChildrenMap()

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

Returns:

Child nodes currently attached

removeChild

boolean removeChild(Object key)

Removes a direct child of this node

Parameters:

key - The key of the node to remove

Returns:

if an actual node was removed

getAppendedNode

ConfigurationNode getAppendedNode()

Returns:

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

getNode

ConfigurationNode getNode(Object... path)

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

Parameters:

path - The path to fetch the node at

Returns:

The node at the given path, possibly virtual

isVirtual

boolean isVirtual()

Whether this node does not currently exist in the configuration structure.

Returns:

true if this node is not attached (this occurs primarily when the node has no set value)