ninja.leaping.configurate

Class SimpleConfigurationNode

java.lang.Object

ninja.leaping.configurate.SimpleConfigurationNode

All Implemented Interfaces:

ConfigurationNode

Direct Known Subclasses:

SimpleCommentedConfigurationNode

public class SimpleConfigurationNode
extends Object
implements ConfigurationNode

Simple implementation of a configuration node

Field Summary

Fields inherited from interface ninja.leaping.configurate.ConfigurationNode

NUMBER_DEF

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	attachChild(SimpleConfigurationNode child)
protected void	attachIfNecessary()
protected void	clear()
protected SimpleConfigurationNode	createNode(Object path)
boolean	equals(Object o)
SimpleConfigurationNode	getAppendedNode()
protected SimpleConfigurationNode	getChild(Object key, boolean attach)
List<? extends SimpleConfigurationNode>	getChildrenList() Return an immutable copy of the list of children this node is aware of
Map<Object,? extends SimpleConfigurationNode>	getChildrenMap() Return an immutable copy of the mapping from key to node of every child this node is aware of
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.
<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.
SimpleConfigurationNode	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
SimpleConfigurationNode	getParent() Returns the current parent for this node.
Object[]	getPath() The full path from the root to this node.
<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.
<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.
int	hashCode()
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
static SimpleConfigurationNode	root()
static SimpleConfigurationNode	root(ConfigurationOptions options)
SimpleConfigurationNode	setValue(Object newValue) Set this node's value to the given value.
String	toString()

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, getList, getLong, getLong, getString, getString, getValue, getValue, getValue, setValue

Constructor Detail

SimpleConfigurationNode

protected SimpleConfigurationNode(Object key,
                                  SimpleConfigurationNode parent,
                                  ConfigurationOptions options)

Method Detail

root

public static SimpleConfigurationNode root()

root

public static SimpleConfigurationNode root(ConfigurationOptions options)

getValue

public Object getValue(Object def)

Description copied from interface: ConfigurationNode

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

Specified by:

getValue in interface ConfigurationNode

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

public Object getValue(Supplier<Object> defSupplier)

Description copied from interface: ConfigurationNode

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

Specified by:

getValue in interface ConfigurationNode

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

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

Description copied from interface: ConfigurationNode

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

Specified by:

getValue in interface ConfigurationNode

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

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

Description copied from interface: ConfigurationNode

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

Specified by:

getValue in interface ConfigurationNode

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

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

Description copied from interface: ConfigurationNode

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

Specified by:

getList in interface ConfigurationNode

Type Parameters:

T - The expected type

Parameters:

transformer - The transformation function

Returns:

An immutable copy of the values contained

getList

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

Description copied from interface: ConfigurationNode

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

Specified by:

getList in interface ConfigurationNode

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

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

Description copied from interface: ConfigurationNode

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

Specified by:

getList in interface ConfigurationNode

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

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

Description copied from interface: ConfigurationNode

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

Specified by:

getList in interface ConfigurationNode

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

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

Description copied from interface: ConfigurationNode

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

Specified by:

getList in interface ConfigurationNode

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

setValue

public SimpleConfigurationNode setValue(Object newValue)

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:

newValue - The value to set

Returns:

this

getValue

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

Description copied from interface: ConfigurationNode

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.

Specified by:

getValue in interface ConfigurationNode

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

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

Description copied from interface: ConfigurationNode

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.

Specified by:

getValue in interface ConfigurationNode

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

mergeValuesFrom

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

getNode

public SimpleConfigurationNode 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

isVirtual

public boolean isVirtual()

Description copied from interface: ConfigurationNode

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

Specified by:

isVirtual in interface ConfigurationNode

Returns:

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

hasListChildren

public boolean hasListChildren()

Specified by:

hasListChildren in interface ConfigurationNode

Returns:

if this node has children in the form of a list

hasMapChildren

public boolean hasMapChildren()

Specified by:

hasMapChildren in interface ConfigurationNode

Returns:

if this node has children in the form of a map

getChildrenList

public List<? extends SimpleConfigurationNode> 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

public Map<Object,? extends SimpleConfigurationNode> 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

getChild

protected SimpleConfigurationNode getChild(Object key,
                                           boolean attach)

removeChild

public boolean removeChild(Object key)

Description copied from interface: ConfigurationNode

Removes a direct child of this node

Specified by:

removeChild in interface ConfigurationNode

Parameters:

key - The key of the node to remove

Returns:

if an actual node was removed

getAppendedNode

public SimpleConfigurationNode getAppendedNode()

Specified by:

getAppendedNode in interface ConfigurationNode

Returns:

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

getKey

public Object getKey()

Description copied from interface: ConfigurationNode

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

Specified by:

getKey in interface ConfigurationNode

Returns:

The key for this node

getPath

public Object[] getPath()

Description copied from interface: ConfigurationNode

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.

Specified by:

getPath in interface ConfigurationNode

Returns:

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

getParent

public SimpleConfigurationNode 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

getOptions

public ConfigurationOptions getOptions()

Description copied from interface: ConfigurationNode

Return the options that currently apply to this node

Specified by:

getOptions in interface ConfigurationNode

Returns:

The ConfigurationOptions instance that governs the functionality of this node

createNode

protected SimpleConfigurationNode createNode(Object path)

attachIfNecessary

protected void attachIfNecessary()

attachChild

protected void attachChild(SimpleConfigurationNode child)

clear

protected void clear()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object