com.electronwill.nightconfig.core

Interface UnmodifiableConfig

All Known Subinterfaces:

CommentedConfig, CommentedFileConfig, Config, FileConfig, UnmodifiableCommentedConfig

All Known Implementing Classes:

AbstractCommentedConfig, AbstractConfig, CommentedConfigWrapper, ConfigWrapper, ConvertedCommentedConfig, ConvertedCommentedFileConfig, ConvertedConfig, ConvertedFileConfig, FakeCommentedConfig, FakeUnmodifiableCommentedConfig, UnmodifiableConfigWrapper

public interface UnmodifiableConfig

An unmodifiable (read-only) configuration that contains key/value mappings.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	UnmodifiableConfig.Entry An unmodifiable config entry.

Method Summary

Modifier and Type	Method and Description
default <T> T	apply(java.util.List<java.lang.String> path) For scala: gets a config value.
default <T> T	apply(java.lang.String path) For scala: gets a config value.
ConfigFormat<?>	configFormat() Returns the config's format.
boolean	contains(java.util.List<java.lang.String> path) Checks if the config contains a value at some path.
default boolean	contains(java.lang.String path) Checks if the config contains a value at some path.
java.util.Set<? extends UnmodifiableConfig.Entry>	entrySet() Returns a Set view of the config's entries.
default <T> T	get(java.util.List<java.lang.String> path) Gets a value from the config.
default <T> T	get(java.lang.String path) Gets a value from the config.
default byte	getByte(java.util.List<java.lang.String> path)
default byte	getByte(java.lang.String path)
default byte	getByteOrElse(java.util.List<java.lang.String> path, byte defaultValue)
default byte	getByteOrElse(java.lang.String path, byte defaultValue)
default char	getChar(java.util.List<java.lang.String> path) Returns a char value from the configuration.
default char	getChar(java.lang.String path) Returns a char value from the configuration.
default char	getCharOrElse(java.util.List<java.lang.String> path, char defaultValue) Returns a char value from the configuration.
default char	getCharOrElse(java.lang.String path, char defaultValue) Returns a char value from the configuration.
default <T extends java.lang.Enum<T>> T	getEnum(java.util.List<java.lang.String> path, java.lang.Class<T> enumType) Calls getEnum(List, Class, EnumGetMethod) with method EnumGetMethod.NAME_IGNORECASE.
default <T extends java.lang.Enum<T>> T	getEnum(java.util.List<java.lang.String> path, java.lang.Class<T> enumType, EnumGetMethod method) Gets an Enum value from the config.
default <T extends java.lang.Enum<T>> T	getEnum(java.lang.String path, java.lang.Class<T> enumType) Calls getEnum(String, Class, EnumGetMethod) with method EnumGetMethod.NAME_IGNORECASE.
default <T extends java.lang.Enum<T>> T	getEnum(java.lang.String path, java.lang.Class<T> enumType, EnumGetMethod method) Gets an Enum value from the config.
default <T extends java.lang.Enum<T>> T	getEnumOrElse(java.util.List<java.lang.String> path, java.lang.Class<T> enumType, EnumGetMethod method, java.util.function.Supplier<T> defaultValueSupplier) Gets an Enum value from the config.
default <T extends java.lang.Enum<T>> T	getEnumOrElse(java.util.List<java.lang.String> path, java.lang.Class<T> enumType, java.util.function.Supplier<T> defaultValueSupplier) Calls getEnumOrElse(List, Class, EnumGetMethod, Supplier) with method EnumGetMethod.NAME_IGNORECASE.
default <T extends java.lang.Enum<T>> T	getEnumOrElse(java.util.List<java.lang.String> path, T defaultValue) Calls getEnumOrElse(List, Enum, EnumGetMethod) with method EnumGetMethod.NAME_IGNORECASE.
default <T extends java.lang.Enum<T>> T	getEnumOrElse(java.util.List<java.lang.String> path, T defaultValue, EnumGetMethod method) Gets an Enum value from the config.
default <T extends java.lang.Enum<T>> T	getEnumOrElse(java.lang.String path, java.lang.Class<T> enumType, EnumGetMethod method, java.util.function.Supplier<T> defaultValueSupplier) Gets an Enum value from the config.
default <T extends java.lang.Enum<T>> T	getEnumOrElse(java.lang.String path, java.lang.Class<T> enumType, java.util.function.Supplier<T> defaultValueSupplier) Calls getEnumOrElse(String, Class, EnumGetMethod, Supplier) with method EnumGetMethod.NAME_IGNORECASE.
default <T extends java.lang.Enum<T>> T	getEnumOrElse(java.lang.String path, T defaultValue) Calls getEnumOrElse(String, Enum, EnumGetMethod) with method EnumGetMethod.NAME_IGNORECASE.
default <T extends java.lang.Enum<T>> T	getEnumOrElse(java.lang.String path, T defaultValue, EnumGetMethod method) Gets an Enum value from the config.
default int	getInt(java.util.List<java.lang.String> path) Like get(List) but returns a primitive int.
default int	getInt(java.lang.String path) Like get(String) but returns a primitive int.
default int	getIntOrElse(java.util.List<java.lang.String> path, int defaultValue) Like getOrElse(List, Object) but returns a primitive int.
default int	getIntOrElse(java.util.List<java.lang.String> path, java.util.function.IntSupplier defaultValueSupplier) Like getOrElse(List, Supplier) but returns a primitive int.
default int	getIntOrElse(java.lang.String path, int defaultValue) Like getOrElse(String, Object) but returns a primitive int.
default int	getIntOrElse(java.lang.String path, java.util.function.IntSupplier defaultValueSupplier) Like getOrElse(String, Supplier) but returns a primitive int.
default long	getLong(java.util.List<java.lang.String> path) Like get(List) but returns a primitive long.
default long	getLong(java.lang.String path) Like get(String) but returns a primitive long.
default long	getLongOrElse(java.util.List<java.lang.String> path, long defaultValue) Like getOrElse(List, Object) but returns a primitive long.
default long	getLongOrElse(java.util.List<java.lang.String> path, java.util.function.LongSupplier defaultValueSupplier) Like getOrElse(List, Supplier) but returns a primitive long.
default long	getLongOrElse(java.lang.String path, long defaultValue) Like getOrElse(String, Object) but returns a primitive long.
default long	getLongOrElse(java.lang.String path, java.util.function.LongSupplier defaultValueSupplier) Like getOrElse(String, Supplier) but returns a primitive long.
default <T> java.util.Optional<T>	getOptional(java.util.List<java.lang.String> path) Gets an optional value from the config.
default <T> java.util.Optional<T>	getOptional(java.lang.String path) Gets an optional value from the config.
default <T extends java.lang.Enum<T>> java.util.Optional<T>	getOptionalEnum(java.util.List<java.lang.String> path, java.lang.Class<T> enumType) Calls getOptionalEnum(List, Class, EnumGetMethod) with method EnumGetMethod.NAME_IGNORECASE.
default <T extends java.lang.Enum<T>> java.util.Optional<T>	getOptionalEnum(java.util.List<java.lang.String> path, java.lang.Class<T> enumType, EnumGetMethod method) Gets an optional Enum value from the config.
default <T extends java.lang.Enum<T>> java.util.Optional<T>	getOptionalEnum(java.lang.String path, java.lang.Class<T> enumType) Calls getOptionalEnum(String, Class, EnumGetMethod) with method EnumGetMethod.NAME_IGNORECASE.
default <T extends java.lang.Enum<T>> java.util.Optional<T>	getOptionalEnum(java.lang.String path, java.lang.Class<T> enumType, EnumGetMethod method) Gets an optional Enum value from the config.
default java.util.OptionalInt	getOptionalInt(java.util.List<java.lang.String> path) Like getOptional(List) but returns a primitive int.
default java.util.OptionalInt	getOptionalInt(java.lang.String path) Like getOptional(String) but returns a primitive int.
default java.util.OptionalLong	getOptionalLong(java.util.List<java.lang.String> path) Like getOptional(List) but returns a primitive long.
default java.util.OptionalLong	getOptionalLong(java.lang.String path) Like getOptional(String) but returns a primitive long.
default <T> T	getOrElse(java.util.List<java.lang.String> path, java.util.function.Supplier<T> defaultValueSupplier) Gets a value from the config.
default <T> T	getOrElse(java.util.List<java.lang.String> path, T defaultValue) Gets a value from the config.
default <T> T	getOrElse(java.lang.String path, java.util.function.Supplier<T> defaultValueSupplier) Gets a value from the config.
default <T> T	getOrElse(java.lang.String path, T defaultValue) Gets a value from the config.
<T> T	getRaw(java.util.List<java.lang.String> path) Gets a value from the config.
default <T> T	getRaw(java.lang.String path) Gets a value from the config.
default short	getShort(java.util.List<java.lang.String> path)
default short	getShort(java.lang.String path)
default short	getShortOrElse(java.util.List<java.lang.String> path, short defaultValue)
default short	getShortOrElse(java.lang.String path, short defaultValue)
default boolean	isEmpty() Checks if the config is empty.
default boolean	isNull(java.util.List<java.lang.String> path) Checks if the config contains a null value at some path.
default boolean	isNull(java.lang.String path) Checks if the config contains a null value at some path.
int	size() Gets the size of the config.
java.util.Map<java.lang.String,java.lang.Object>	valueMap() Returns a Map view of the config's values.

Method Detail

get

default <T> T get(java.lang.String path)

Gets a value from the config.

Type Parameters:

T - the value's type

Parameters:

path - the value's path, each part separated by a dot. Example "a.b.c"

Returns:

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

get

default <T> T get(java.util.List<java.lang.String> path)

Gets a value from the 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.

getRaw

default <T> T getRaw(java.lang.String path)

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

Type Parameters:

T - the value's type

Parameters:

path - the value's path, each part separated by a dot. Example "a.b.c"

Returns:

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

getRaw

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

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

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.

getOptional

default <T> java.util.Optional<T> getOptional(java.lang.String path)

Gets an optional value from the config.

Type Parameters:

T - the value's type

Parameters:

path - the value's path, each part separated by a dot. Example "a.b.c"

Returns:

an Optional containing the value at the given path, or Optional.empty() if there is no such value.

getOptional

default <T> java.util.Optional<T> getOptional(java.util.List<java.lang.String> path)

Gets an optional value from the 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:

an Optional containing the value at the given path, or Optional.empty() if there is no such value.

getOrElse

default <T> T getOrElse(java.lang.String path,
                        T defaultValue)

Gets a value from the config. If the value doesn't exist, returns the default value.

Type Parameters:

T - the value's type

Parameters:

path - the value's path, each part separated by a dot. Example "a.b.c"

defaultValue - the default value to return if not found

Returns:

the value at the given path, or the default value if not found.

getOrElse

default <T> T getOrElse(java.util.List<java.lang.String> path,
                        T defaultValue)

Gets a value from the config. If the value doesn't exist, returns the default value.

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.

defaultValue - the default value to return if not found

Returns:

the value at the given path, or the default value if not found.

getOrElse

default <T> T getOrElse(java.util.List<java.lang.String> path,
                        java.util.function.Supplier<T> defaultValueSupplier)

Gets a value from the config. If the value doesn't exist, returns the default value.

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.

defaultValueSupplier - the Supplier of the default value

Returns:

the value at the given path, or the default value if not found.

getOrElse

default <T> T getOrElse(java.lang.String path,
                        java.util.function.Supplier<T> defaultValueSupplier)

Gets a value from the config. If the value doesn't exist, returns the default value.

Type Parameters:

T - the value's type

Parameters:

path - the value's path, each part separated by a dot. Example "a.b.c"

defaultValueSupplier - the Supplier of the default value

Returns:

the value at the given path, or the default value if not found.

getEnum

default <T extends java.lang.Enum<T>> T getEnum(java.lang.String path,
                                                java.lang.Class<T> enumType,
                                                EnumGetMethod method)

Gets an Enum value from the config. If the value doesn't exist, returns null.

Type Parameters:

T - the value's type

Parameters:

path - the value's path, each part separated by a dot. Example "a.b.c"

enumType - the class of the Enum

method - the method to use when converting a non-enum value like a String or an int

Returns:

the value at the given path as an enum, or null value if not found.

Throws:

java.lang.IllegalArgumentException - if the config contains a String that doesn't match any of the enum constants, with regards to the given method

java.lang.ClassCastException - if the config contains a value that cannot be converted to an enum constant, like a List

getEnum

default <T extends java.lang.Enum<T>> T getEnum(java.lang.String path,
                                                java.lang.Class<T> enumType)

Calls getEnum(String, Class, EnumGetMethod) with method EnumGetMethod.NAME_IGNORECASE.

getEnum

default <T extends java.lang.Enum<T>> T getEnum(java.util.List<java.lang.String> path,
                                                java.lang.Class<T> enumType,
                                                EnumGetMethod method)

Gets an Enum value from the config. If the value doesn't exist, returns null.

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.

enumType - the class of the Enum

method - the method to use when converting a non-enum value like a String or an int

Returns:

the value at the given path as an enum, or null value if not found.

Throws:

java.lang.IllegalArgumentException - if the config contains a String that doesn't match any of the enum constants, with regards to the given method

java.lang.ClassCastException - if the config contains a value that cannot be converted to an enum constant, like a List

getEnum

default <T extends java.lang.Enum<T>> T getEnum(java.util.List<java.lang.String> path,
                                                java.lang.Class<T> enumType)

Calls getEnum(List, Class, EnumGetMethod) with method EnumGetMethod.NAME_IGNORECASE.

getOptionalEnum

default <T extends java.lang.Enum<T>> java.util.Optional<T> getOptionalEnum(java.lang.String path,
                                                                            java.lang.Class<T> enumType,
                                                                            EnumGetMethod method)

Gets an optional Enum value from the config.

Type Parameters:

T - the value's type

Parameters:

path - the value's path, each part separated by a dot. Example "a.b.c"

enumType - the class of the Enum

method - the method to use when converting a non-enum value like a String or an int

Returns:

the value at the given path as an enum, or null value if not found.

Throws:

java.lang.IllegalArgumentException - if the config contains a String that doesn't match any of the enum constants, with regards to the given method

java.lang.ClassCastException - if the config contains a value that cannot be converted to an enum constant, like a List

getOptionalEnum

default <T extends java.lang.Enum<T>> java.util.Optional<T> getOptionalEnum(java.lang.String path,
                                                                            java.lang.Class<T> enumType)

Calls getOptionalEnum(String, Class, EnumGetMethod) with method EnumGetMethod.NAME_IGNORECASE.

getOptionalEnum

default <T extends java.lang.Enum<T>> java.util.Optional<T> getOptionalEnum(java.util.List<java.lang.String> path,
                                                                            java.lang.Class<T> enumType,
                                                                            EnumGetMethod method)

Gets an optional Enum value from the 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.

enumType - the class of the Enum

method - the method to use when converting a non-enum value like a String or an int

Returns:

the value at the given path as an enum, or null value if not found.

Throws:

java.lang.IllegalArgumentException - if the config contains a String that doesn't match any of the enum constants, with regards to the given method

java.lang.ClassCastException - if the config contains a value that cannot be converted to an enum constant, like a List

getOptionalEnum

default <T extends java.lang.Enum<T>> java.util.Optional<T> getOptionalEnum(java.util.List<java.lang.String> path,
                                                                            java.lang.Class<T> enumType)

Calls getOptionalEnum(List, Class, EnumGetMethod) with method EnumGetMethod.NAME_IGNORECASE.

getEnumOrElse

default <T extends java.lang.Enum<T>> T getEnumOrElse(java.lang.String path,
                                                      T defaultValue,
                                                      EnumGetMethod method)

Gets an Enum value from the config. If the value doesn't exist, returns the default value.

Type Parameters:

T - the value's type

Parameters:

path - the value's path, each part separated by a dot. Example "a.b.c"

defaultValue - the default value

method - the method to use when converting a non-enum value like a String or an int

Returns:

the value at the given path as an enum, or null value if not found.

Throws:

java.lang.IllegalArgumentException - if the config contains a String that doesn't match any of the enum constants, with regards to the given method

java.lang.ClassCastException - if the config contains a value that cannot be converted to an enum constant, like a List

getEnumOrElse

default <T extends java.lang.Enum<T>> T getEnumOrElse(java.lang.String path,
                                                      T defaultValue)

Calls getEnumOrElse(String, Enum, EnumGetMethod) with method EnumGetMethod.NAME_IGNORECASE.

getEnumOrElse

default <T extends java.lang.Enum<T>> T getEnumOrElse(java.util.List<java.lang.String> path,
                                                      T defaultValue,
                                                      EnumGetMethod method)

Gets an Enum value from the config. If the value doesn't exist, returns the default value.

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.

defaultValue - the default value

method - the method to use when converting a non-enum value like a String or an int

Returns:

the value at the given path as an enum, or null value if not found.

Throws:

java.lang.IllegalArgumentException - if the config contains a String that doesn't match any of the enum constants, with regards to the given method

java.lang.ClassCastException - if the config contains a value that cannot be converted to an enum constant, like a List

getEnumOrElse

default <T extends java.lang.Enum<T>> T getEnumOrElse(java.util.List<java.lang.String> path,
                                                      T defaultValue)

Calls getEnumOrElse(List, Enum, EnumGetMethod) with method EnumGetMethod.NAME_IGNORECASE.

getEnumOrElse

default <T extends java.lang.Enum<T>> T getEnumOrElse(java.lang.String path,
                                                      java.lang.Class<T> enumType,
                                                      EnumGetMethod method,
                                                      java.util.function.Supplier<T> defaultValueSupplier)

Gets an Enum value from the config. If the value doesn't exist, returns the default value.

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.

defaultValueSupplier - Supplier of the default value, only used if needed

method - the method to use when converting a non-enum value like a String or an int

Returns:

the value at the given path as an enum, or null value if not found.

Throws:

java.lang.IllegalArgumentException - if the config contains a String that doesn't match any of the enum constants, with regards to the given method

java.lang.ClassCastException - if the config contains a value that cannot be converted to an enum constant, like a List

getEnumOrElse

default <T extends java.lang.Enum<T>> T getEnumOrElse(java.lang.String path,
                                                      java.lang.Class<T> enumType,
                                                      java.util.function.Supplier<T> defaultValueSupplier)

Calls getEnumOrElse(String, Class, EnumGetMethod, Supplier) with method EnumGetMethod.NAME_IGNORECASE.

getEnumOrElse

default <T extends java.lang.Enum<T>> T getEnumOrElse(java.util.List<java.lang.String> path,
                                                      java.lang.Class<T> enumType,
                                                      EnumGetMethod method,
                                                      java.util.function.Supplier<T> defaultValueSupplier)

Gets an Enum value from the config. If the value doesn't exist, returns the default value.

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.

defaultValueSupplier - Supplier of the default value, only used if needed

method - the method to use when converting a non-enum value like a String or an int

Returns:

the value at the given path as an enum, or null value if not found.

Throws:

java.lang.IllegalArgumentException - if the config contains a String that doesn't match any of the enum constants, with regards to the given method

java.lang.ClassCastException - if the config contains a value that cannot be converted to an enum constant, like a List

getEnumOrElse

default <T extends java.lang.Enum<T>> T getEnumOrElse(java.util.List<java.lang.String> path,
                                                      java.lang.Class<T> enumType,
                                                      java.util.function.Supplier<T> defaultValueSupplier)

Calls getEnumOrElse(List, Class, EnumGetMethod, Supplier) with method EnumGetMethod.NAME_IGNORECASE.

getInt

default int getInt(java.lang.String path)

Like get(String) but returns a primitive int. The config's value must be a Number.

getInt

default int getInt(java.util.List<java.lang.String> path)

Like get(List) but returns a primitive int. The config's value must be a Number.

getOptionalInt

default java.util.OptionalInt getOptionalInt(java.lang.String path)

Like getOptional(String) but returns a primitive int. The config's value must be a Number or null or nonexistant.

getOptionalInt

default java.util.OptionalInt getOptionalInt(java.util.List<java.lang.String> path)

Like getOptional(List) but returns a primitive int. The config's value must be a Number or null or nonexistant.

getIntOrElse

default int getIntOrElse(java.lang.String path,
                         int defaultValue)

Like getOrElse(String, Object) but returns a primitive int. The config's value must be a Number or null or nonexistant.

getIntOrElse

default int getIntOrElse(java.util.List<java.lang.String> path,
                         int defaultValue)

Like getOrElse(List, Object) but returns a primitive int. The config's value must be a Number or null or nonexistant.

getIntOrElse

default int getIntOrElse(java.lang.String path,
                         java.util.function.IntSupplier defaultValueSupplier)

Like getOrElse(String, Supplier) but returns a primitive int. The config's value must be a Number or null or nonexistant.

getIntOrElse

default int getIntOrElse(java.util.List<java.lang.String> path,
                         java.util.function.IntSupplier defaultValueSupplier)

Like getOrElse(List, Supplier) but returns a primitive int. The config's value must be a Number or null or nonexistant.

getLong

default long getLong(java.lang.String path)

Like get(String) but returns a primitive long. The config's value must be a Number.

getLong

default long getLong(java.util.List<java.lang.String> path)

Like get(List) but returns a primitive long. The config's value must be a Number.

getOptionalLong

default java.util.OptionalLong getOptionalLong(java.lang.String path)

Like getOptional(String) but returns a primitive long. The config's value must be a Number or null or nonexistant.

getOptionalLong

default java.util.OptionalLong getOptionalLong(java.util.List<java.lang.String> path)

Like getOptional(List) but returns a primitive long. The config's value must be a Number or null or nonexistant.

getLongOrElse

default long getLongOrElse(java.lang.String path,
                           long defaultValue)

Like getOrElse(String, Object) but returns a primitive long. The config's value must be a Number or null or nonexistant.

getLongOrElse

default long getLongOrElse(java.util.List<java.lang.String> path,
                           long defaultValue)

Like getOrElse(List, Object) but returns a primitive long. The config's value must be a Number or null or nonexistant.

getLongOrElse

default long getLongOrElse(java.lang.String path,
                           java.util.function.LongSupplier defaultValueSupplier)

Like getOrElse(String, Supplier) but returns a primitive long. The config's value must be a Number or null or nonexistant.

getLongOrElse

default long getLongOrElse(java.util.List<java.lang.String> path,
                           java.util.function.LongSupplier defaultValueSupplier)

Like getOrElse(List, Supplier) but returns a primitive long. The config's value must be a Number or null or nonexistant.

getByte

default byte getByte(java.lang.String path)

getByte

default byte getByte(java.util.List<java.lang.String> path)

getByteOrElse

default byte getByteOrElse(java.lang.String path,
                           byte defaultValue)

getByteOrElse

default byte getByteOrElse(java.util.List<java.lang.String> path,
                           byte defaultValue)

getShort

default short getShort(java.lang.String path)

getShort

default short getShort(java.util.List<java.lang.String> path)

getShortOrElse

default short getShortOrElse(java.lang.String path,
                             short defaultValue)

getShortOrElse

default short getShortOrElse(java.util.List<java.lang.String> path,
                             short defaultValue)

getChar

default char getChar(java.lang.String path)

Returns a char value from the configuration.

If the value is a Number, returns Number.intValue(), cast to char. If the value is a CharSequence, returns its first character. Otherwise, attempts to cast the value to a char.

Parameters:

path - the value's path as a dot-separated String

Returns:

the value, as a single char

getChar

default char getChar(java.util.List<java.lang.String> path)

Returns a char value from the configuration.

If the value is a Number, returns Number.intValue(), cast to char. If the value is a CharSequence, returns its first character. Otherwise, attempts to cast the value to a char.

Parameters:

path - the value's path as a list of String

Returns:

the value, as a single char

getCharOrElse

default char getCharOrElse(java.lang.String path,
                           char defaultValue)

Returns a char value from the configuration.

If the value is nonexistant, returns defaultValue. If the value is a Number, returns Number.intValue(), cast to char. If the value is a CharSequence, returns its first character. Otherwise, attempts to cast the value to a char.

Parameters:

path - the value's path

defaultValue - the char to return if the value doesn't exist in the config

Returns:

the value, as a single char

getCharOrElse

default char getCharOrElse(java.util.List<java.lang.String> path,
                           char defaultValue)

Returns a char value from the configuration.

If the value is nonexistant, returns defaultValue. If the value is a Number, returns Number.intValue(), cast to char. If the value is a CharSequence, returns its first character. Otherwise, attempts to cast the value to a char.

Parameters:

path - the value's path

defaultValue - the char to return if the value doesn't exist in the config

Returns:

the value, as a single char

contains

default boolean contains(java.lang.String path)

Checks if the config contains a value at some path.

Parameters:

path - the path to check, each part separated by a dot. Example "a.b.c"

Returns:

true if the path is associated with a value, false if it's not.

contains

boolean contains(java.util.List<java.lang.String> path)

Checks if the config contains a value at some path.

Parameters:

path - the path to check, each element of the list is a different part of the path.

Returns:

true if the path is associated with a value, false if it's not.

isNull

default boolean isNull(java.lang.String path)

Checks if the config contains a null value at some path.

Parameters:

path - the path to check, each part separated by a dot. Example "a.b.c"

Returns:

true if the path is associated with NullObject.NULL_OBJECT, false if it's associated with another value or with no value.

isNull

default boolean isNull(java.util.List<java.lang.String> path)

Checks if the config contains a null value at some path.

Parameters:

path - the path to check, each element of the list is a different part of the path.

Returns:

true if the path is associated with NullObject.NULL_OBJECT, false if it's associated with another value or with no value.

size

int size()

Gets the size of the config.

Returns:

the number of top-level elements in the config.

isEmpty

default boolean isEmpty()

Checks if the config is empty.

Returns:

true if the config is empty, false if it contains at least one element.

valueMap

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

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

Returns:

a Map view of the config's values.

entrySet

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

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

Returns:

a Set view of the config's entries.

configFormat

ConfigFormat<?> configFormat()

Returns the config's format.

Returns:

the config's format

apply

default <T> T apply(java.lang.String path)

For scala: gets a config value.

Type Parameters:

T - the value's type

Parameters:

path - the value's path, each part separated by a dot. Example "a.b.c"

See Also:

get(String)

apply

default <T> T apply(java.util.List<java.lang.String> path)

For scala: gets a config value.

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.

See Also:

get(List)