Package com.electronwill.nightconfig.core.utils

Class ConfigWrapper<C extends Config>

java.lang.Object

com.electronwill.nightconfig.core.utils.UnmodifiableConfigWrapper<C>

com.electronwill.nightconfig.core.utils.ConfigWrapper<C>

All Implemented Interfaces:

Config, UnmodifiableConfig

Direct Known Subclasses:

CommentedConfigWrapper, ConvertedCommentedConfig, ConvertedCommentedFileConfig, ConvertedConfig, ConvertedFileConfig, FakeCommentedConfig

public abstract class ConfigWrapper<C extends Config>
extends UnmodifiableConfigWrapper<C>
implements Config

Nested Class Summary

Nested classes/interfaces inherited from interface com.electronwill.nightconfig.core.Config

Config.Entry

Nested classes/interfaces inherited from interface com.electronwill.nightconfig.core.UnmodifiableConfig

UnmodifiableConfig.Entry

Field Summary

Fields inherited from class com.electronwill.nightconfig.core.utils.UnmodifiableConfigWrapper

config

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ConfigWrapper(C config)

Method Summary

Modifier and Type	Method	Description
boolean	add(java.util.List<java.lang.String> path, java.lang.Object value)	Adds a config value.
void	clear()	Removes all values from the config.
Config	createSubConfig()	Creates a new sub config of this config, as created when a subconfig's creation is implied by Config.set(List, Object) or Config.add(List, Object).
java.util.Set<? extends Config.Entry>	entrySet()	Returns a Set view of the config's entries.
<T> T	remove(java.util.List<java.lang.String> path)	Removes a value from the config.
<T> T	set(java.util.List<java.lang.String> path, java.lang.Object value)	Sets a config value.
java.lang.String	toString()

Methods inherited from class com.electronwill.nightconfig.core.utils.UnmodifiableConfigWrapper

configFormat, contains, equals, getRaw, hashCode, isEmpty, size, valueMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.electronwill.nightconfig.core.Config

add, addAll, checked, putAll, remove, removeAll, set, unmodifiable, update, update, valueMap

Methods inherited from interface com.electronwill.nightconfig.core.UnmodifiableConfig

apply, apply, configFormat, contains, contains, get, get, getByte, getByte, getByteOrElse, getByteOrElse, getChar, getChar, getCharOrElse, getCharOrElse, getEnum, getEnum, getEnum, getEnum, getEnumOrElse, getEnumOrElse, getEnumOrElse, getEnumOrElse, getEnumOrElse, getEnumOrElse, getEnumOrElse, getEnumOrElse, getInt, getInt, getIntOrElse, getIntOrElse, getIntOrElse, getIntOrElse, getLong, getLong, getLongOrElse, getLongOrElse, getLongOrElse, getLongOrElse, getOptional, getOptional, getOptionalEnum, getOptionalEnum, getOptionalEnum, getOptionalEnum, getOptionalInt, getOptionalInt, getOptionalLong, getOptionalLong, getOrElse, getOrElse, getOrElse, getOrElse, getRaw, getRaw, getShort, getShort, getShortOrElse, getShortOrElse, isEmpty, isNull, isNull, size

Constructor Detail

ConfigWrapper

protected ConfigWrapper(C config)

Method Detail

entrySet

public java.util.Set<? extends Config.Entry> entrySet()

Description copied from interface: UnmodifiableConfig

Returns a Set view of the config's entries. If the config is unmodifiable then the returned set is unmodifiable too.

Specified by:

entrySet in interface Config

Specified by:

entrySet in interface UnmodifiableConfig

Overrides:

entrySet in class UnmodifiableConfigWrapper<C extends Config>

Returns:

a Set view of the config's entries.

set

public <T> T set(java.util.List<java.lang.String> path,
                 java.lang.Object value)

Description copied from interface: Config

Sets a config value.

Specified by:

set in interface Config

Type Parameters:

T - the type of the old value

Parameters:

path - the value's path, each element of the list is a different part of the path.

value - the value to set

Returns:

the old value if any, or null

add

public boolean add(java.util.List<java.lang.String> path,
                   java.lang.Object value)

Description copied from interface: Config

Adds a config value. The value is set iff there is no value associated with the given path.

Specified by:

add in interface Config

Parameters:

path - the value's path, each element of the list is a different part of the path.

value - the value to set

Returns:

true if the value has been added, false if a value is already associated with the given path

remove

public <T> T remove(java.util.List<java.lang.String> path)

Description copied from interface: Config

Removes a value from the config.

Specified by:

remove in interface Config

Type Parameters:

T - the type of the old value

Parameters:

path - the value's path, each element of the list is a different part of the path.

Returns:

the old value if any, or null

clear

public void clear()

Description copied from interface: Config

Removes all values from the config.

Specified by:

clear in interface Config

createSubConfig

public Config createSubConfig()

Description copied from interface: Config

Creates a new sub config of this config, as created when a subconfig's creation is implied by Config.set(List, Object) or Config.add(List, Object).

Specified by:

createSubConfig in interface Config

Returns:

a new sub config

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object