org.simpleyaml.configuration

Class ConfigurationWrapper<T extends Configuration>

java.lang.Object

org.simpleyaml.configuration.ConfigurationWrapper<T>

Direct Known Subclasses:

YamlFileWrapper

public class ConfigurationWrapper<T extends Configuration>
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	ConfigurationWrapper.ApplyToPath
protected static interface	ConfigurationWrapper.SetToPath

Field Summary

Fields

Modifier and Type	Field and Description
protected T	configuration
protected ConfigurationWrapper<T>	parent
protected String	path

Constructor Summary

Constructors

Modifier	Constructor and Description
	ConfigurationWrapper(T configuration, String path)
protected	ConfigurationWrapper(T configuration, String path, ConfigurationWrapper<T> parent)

Method Summary

Modifier and Type	Method and Description
ConfigurationWrapper<T>	addDefault(Object value) Sets the default value of this path.
ConfigurationWrapper<T>	addDefault(String child, Object value) Sets the default value of the provided child path.
protected ConfigurationWrapper<T>	apply(ConfigurationWrapper.ApplyToPath method)
protected ConfigurationWrapper<T>	applyToChild(ConfigurationWrapper.ApplyToPath method, String path)
protected String	childPath(String child)
ConfigurationWrapper<T>	createSection() Creates an empty ConfigurationSection at this path.
ConfigurationWrapper<T>	createSection(String child) Creates an empty ConfigurationSection at the provided child path.
boolean	equals(Object o)
String	getCurrentPath() Gets the current path.
int	hashCode()
ConfigurationWrapper<T>	parent() Returns to the parent.
ConfigurationWrapper<T>	path(String path) Get a wrapper builder for the given child path.
protected ConfigurationWrapper<T>	set(ConfigurationWrapper.SetToPath method, Object value)
ConfigurationWrapper<T>	set(Object value) Set the given value to this path.
ConfigurationWrapper<T>	setChild(String child, Object value) Set the given value to the provided child path.
protected ConfigurationWrapper<T>	setToChild(ConfigurationWrapper.SetToPath method, String child, Object value)

Methods inherited from class java.lang.Object

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

Field Detail

configuration

protected final T extends Configuration configuration

path

protected final String path

parent

protected final ConfigurationWrapper<T extends Configuration> parent

Constructor Detail

ConfigurationWrapper

protected ConfigurationWrapper(T configuration,
                               String path,
                               ConfigurationWrapper<T> parent)

ConfigurationWrapper

public ConfigurationWrapper(T configuration,
                            String path)

Method Detail

path

public ConfigurationWrapper<T> path(String path)

Get a wrapper builder for the given child path.

Parameters:

path - child path of this section path, not null.

Returns:

the child path wrapper

Throws:

IllegalArgumentException - if path is null

set

public ConfigurationWrapper<T> set(Object value)

Set the given value to this path.

If value is null, the entry will be removed. Any existing entry will be replaced, regardless of what the new value is.

Parameters:

value - new value to set the path to.

Returns:

this object, for chaining.

setChild

public ConfigurationWrapper<T> setChild(String child,
                                        Object value)

Set the given value to the provided child path.

If value is null, the entry will be removed. Any existing entry will be replaced, regardless of what the new value is.

Parameters:

child - the child path of this section path.

value - new value to set the child path to.

Returns:

this object, for chaining.

addDefault

public ConfigurationWrapper<T> addDefault(Object value)

Sets the default value of this path.

If no source Configuration was provided as a default collection, then a new MemoryConfiguration will be created to hold the new default value.

If value is null, the value will be removed from the default Configuration source.

If the value as returned by ConfigurationSection.getDefaultSection() is null, then this will create a new section at the path, replacing anything that may have existed there previously.

Parameters:

value - value to set the default to.

Returns:

this object, for chaining.

addDefault

public ConfigurationWrapper<T> addDefault(String child,
                                          Object value)

Sets the default value of the provided child path.

If no source Configuration was provided as a default collection, then a new MemoryConfiguration will be created to hold the new default value.

If value is null, the value will be removed from the default Configuration source.

If the value as returned by ConfigurationSection.getDefaultSection() is null, then this will create a new section at the path, replacing anything that may have existed there previously.

Parameters:

child - the child path of this section path.

value - value to set the default to.

Returns:

this object, for chaining.

createSection

public ConfigurationWrapper<T> createSection()

Creates an empty ConfigurationSection at this path.

Any value that was previously set at this path will be overwritten. If the previous value was itself a ConfigurationSection, it will be orphaned.

Returns:

this object, for chaining.

createSection

public ConfigurationWrapper<T> createSection(String child)

Creates an empty ConfigurationSection at the provided child path.

Any value that was previously set at this will be overwritten. If the previous value was itself a ConfigurationSection, it will be orphaned.

Parameters:

child - the child path of this section path.

Returns:

this object, for chaining.

getCurrentPath

public String getCurrentPath()

Gets the current path.

Returns:

this path.

parent

public ConfigurationWrapper<T> parent()

Returns to the parent.

Returns:

the parent path wrapper, or null if this path does not have a parent.

childPath

protected final String childPath(String child)

apply

protected ConfigurationWrapper<T> apply(ConfigurationWrapper.ApplyToPath method)

applyToChild

protected ConfigurationWrapper<T> applyToChild(ConfigurationWrapper.ApplyToPath method,
                                               String path)

set

protected ConfigurationWrapper<T> set(ConfigurationWrapper.SetToPath method,
                                      Object value)

setToChild

protected ConfigurationWrapper<T> setToChild(ConfigurationWrapper.SetToPath method,
                                             String child,
                                             Object value)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object