Package com.electronwill.nightconfig.core.conversion

Class ConvertedConfig

java.lang.Object

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

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

com.electronwill.nightconfig.core.conversion.ConvertedConfig

All Implemented Interfaces:

Config, UnmodifiableConfig

public final class ConvertedConfig
extends ConfigWrapper<C>

A Config's wrapper that converts the values that are read from and put into the 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

Constructor	Description
ConvertedConfig(Config config, ConversionTable readTable, ConversionTable writeTable, java.util.function.Predicate<java.lang.Class<?>> supportPredicate)	Creates a new ConvertedConfig that uses two conversion tables.
ConvertedConfig(Config config, java.util.function.Function<java.lang.Object,java.lang.Object> readConversion, java.util.function.Function<java.lang.Object,java.lang.Object> writeConversion, java.util.function.Predicate<java.lang.Class<?>> supportPredicate)	Creates a new ConvertedConfig that uses two custom conversion functions.

Method Summary

Modifier and Type	Method	Description
ConfigFormat<?>	configFormat()	Returns the config's format.
java.util.Set<? extends Config.Entry>	entrySet()	Returns a Set view of the config's entries.
<T> T	getRaw(java.util.List<java.lang.String> path)	Gets 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()
java.util.Map<java.lang.String,java.lang.Object>	valueMap()	Returns a Map view of the config's values.

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

add, clear, createSubConfig, remove

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

contains, equals, hashCode, isEmpty, size

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, add, addAll, checked, clear, createSubConfig, putAll, remove, remove, removeAll, set, unmodifiable, update, update

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

apply, apply, 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, getShort, getShort, getShortOrElse, getShortOrElse, isEmpty, isNull, isNull, size

Constructor Detail

ConvertedConfig

public ConvertedConfig(Config config,
                       ConversionTable readTable,
                       ConversionTable writeTable,
                       java.util.function.Predicate<java.lang.Class<?>> supportPredicate)

Creates a new ConvertedConfig that uses two conversion tables.

Parameters:

config - the config to wrap

readTable - the ConversionTable used for parse operations (like getValue)

writeTable - the ConversionTable used for write operations (like setValue)

supportPredicate - a Predicate that checks if a given class is supported by the ConvertedConfig

ConvertedConfig

public ConvertedConfig(Config config,
                       java.util.function.Function<java.lang.Object,java.lang.Object> readConversion,
                       java.util.function.Function<java.lang.Object,java.lang.Object> writeConversion,
                       java.util.function.Predicate<java.lang.Class<?>> supportPredicate)

Creates a new ConvertedConfig that uses two custom conversion functions.

Parameters:

config - the config to wrap

readConversion - the Function used for parse operations (like getValue)

writeConversion - the Function used for write operations (like setValue)

supportPredicate - a Predicate that checks if a given class is supported by the ConvertedConfig

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 ConfigWrapper<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

Overrides:

set in class ConfigWrapper<C extends 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

valueMap

public java.util.Map<java.lang.String,java.lang.Object> valueMap()

Description copied from interface: UnmodifiableConfig

Returns a Map view of the config's values. If the config is unmodifiable then the returned map is unmodifiable too.

Specified by:

valueMap in interface Config

Specified by:

valueMap in interface UnmodifiableConfig

Overrides:

valueMap in class UnmodifiableConfigWrapper<C extends Config>

Returns:

a Map view of the config's values.

getRaw

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

Description copied from interface: UnmodifiableConfig

Gets a value from the config. Doesn't convert NullObject.NULL_OBJECT to null.

Specified by:

getRaw in interface UnmodifiableConfig

Overrides:

getRaw in class UnmodifiableConfigWrapper<C extends Config>

Type Parameters:

T - the value's type

Parameters:

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

Returns:

the value at the given path, or null if there is no such value.

configFormat

public ConfigFormat<?> configFormat()

Description copied from interface: UnmodifiableConfig

Returns the config's format.

Specified by:

configFormat in interface UnmodifiableConfig

Overrides:

configFormat in class UnmodifiableConfigWrapper<C extends Config>

Returns:

the config's format

toString

public java.lang.String toString()

Overrides:

toString in class ConfigWrapper<C extends Config>