public interface UnmodifiableConfig
| Modifier and Type | Interface and Description |
|---|---|
static interface |
UnmodifiableConfig.Entry
An unmodifiable config entry.
|
| 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>> |
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>> |
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>> |
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>> |
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>> |
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>> |
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>> |
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>> |
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>> |
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>> |
getEnumOrElse(java.lang.String path,
java.lang.Class<T> enumType,
java.util.function.Supplier<T> defaultValueSupplier)
|
default <T extends java.lang.Enum<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>> |
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>> |
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>> |
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>> |
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>> |
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.
|
default <T> T get(java.lang.String path)
T - the value's typepath - the value's path, each part separated by a dot. Example "a.b.c"null if there is no such value.default <T> T get(java.util.List<java.lang.String> path)
T - the value's typepath - the value's path, each element of the list is a different part of the path.null if there is no such value.default <T> T getRaw(java.lang.String path)
NullObject.NULL_OBJECT to null.T - the value's typepath - the value's path, each part separated by a dot. Example "a.b.c"null if there is no such value.<T> T getRaw(java.util.List<java.lang.String> path)
NullObject.NULL_OBJECT to null.T - the value's typepath - the value's path, each element of the list is a different part of the path.null if there is no such value.default <T> java.util.Optional<T> getOptional(java.lang.String path)
T - the value's typepath - the value's path, each part separated by a dot. Example "a.b.c"Optional.empty() if
there is no such value.default <T> java.util.Optional<T> getOptional(java.util.List<java.lang.String> path)
T - the value's typepath - the value's path, each element of the list is a different part of the path.Optional.empty() if
there is no such value.default <T> T getOrElse(java.lang.String path,
T defaultValue)
T - the value's typepath - the value's path, each part separated by a dot. Example "a.b.c"defaultValue - the default value to return if not founddefault <T> T getOrElse(java.util.List<java.lang.String> path,
T defaultValue)
T - the value's typepath - the value's path, each element of the list is a different part of the path.defaultValue - the default value to return if not founddefault <T> T getOrElse(java.util.List<java.lang.String> path,
java.util.function.Supplier<T> defaultValueSupplier)
T - the value's typepath - the value's path, each element of the list is a different part of the path.defaultValueSupplier - the Supplier of the default valuedefault <T> T getOrElse(java.lang.String path,
java.util.function.Supplier<T> defaultValueSupplier)
T - the value's typepath - the value's path, each part separated by a dot. Example "a.b.c"defaultValueSupplier - the Supplier of the default valuedefault <T extends java.lang.Enum<T>> T getEnum(java.lang.String path,
java.lang.Class<T> enumType,
EnumGetMethod method)
T - the value's typepath - the value's path, each part separated by a dot. Example "a.b.c"enumType - the class of the Enummethod - the method to use when converting a non-enum value like a String or an intjava.lang.IllegalArgumentException - if the config contains a String that doesn't match any of
the enum constants, with regards to the given methodjava.lang.ClassCastException - if the config contains a value that cannot be converted to
an enum constant, like a Listdefault <T extends java.lang.Enum<T>> T getEnum(java.lang.String path,
java.lang.Class<T> enumType)
getEnum(String, 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)
T - the value's typepath - the value's path, each element of the list is a different part of the path.enumType - the class of the Enummethod - the method to use when converting a non-enum value like a String or an intjava.lang.IllegalArgumentException - if the config contains a String that doesn't match any of
the enum constants, with regards to the given methodjava.lang.ClassCastException - if the config contains a value that cannot be converted to
an enum constant, like a Listdefault <T extends java.lang.Enum<T>> T getEnum(java.util.List<java.lang.String> path,
java.lang.Class<T> enumType)
getEnum(List, 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)
T - the value's typepath - the value's path, each part separated by a dot. Example "a.b.c"enumType - the class of the Enummethod - the method to use when converting a non-enum value like a String or an intjava.lang.IllegalArgumentException - if the config contains a String that doesn't match any of
the enum constants, with regards to the given methodjava.lang.ClassCastException - if the config contains a value that cannot be converted to
an enum constant, like a Listdefault <T extends java.lang.Enum<T>> java.util.Optional<T> getOptionalEnum(java.lang.String path,
java.lang.Class<T> enumType)
getOptionalEnum(String, 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)
T - the value's typepath - the value's path, each element of the list is a different part of the path.enumType - the class of the Enummethod - the method to use when converting a non-enum value like a String or an intjava.lang.IllegalArgumentException - if the config contains a String that doesn't match any of
the enum constants, with regards to the given methodjava.lang.ClassCastException - if the config contains a value that cannot be converted to
an enum constant, like a Listdefault <T extends java.lang.Enum<T>> java.util.Optional<T> getOptionalEnum(java.util.List<java.lang.String> path,
java.lang.Class<T> enumType)
getOptionalEnum(List, Class, EnumGetMethod) with method
EnumGetMethod.NAME_IGNORECASE.default <T extends java.lang.Enum<T>> T getEnumOrElse(java.lang.String path,
T defaultValue,
EnumGetMethod method)
T - the value's typepath - the value's path, each part separated by a dot. Example "a.b.c"defaultValue - the default valuemethod - the method to use when converting a non-enum value like a String or an intjava.lang.IllegalArgumentException - if the config contains a String that doesn't match any of
the enum constants, with regards to the given methodjava.lang.ClassCastException - if the config contains a value that cannot be converted to
an enum constant, like a Listdefault <T extends java.lang.Enum<T>> T getEnumOrElse(java.lang.String path,
T defaultValue)
getEnumOrElse(String, 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)
T - the value's typepath - the value's path, each element of the list is a different part of the path.defaultValue - the default valuemethod - the method to use when converting a non-enum value like a String or an intjava.lang.IllegalArgumentException - if the config contains a String that doesn't match any of
the enum constants, with regards to the given methodjava.lang.ClassCastException - if the config contains a value that cannot be converted to
an enum constant, like a Listdefault <T extends java.lang.Enum<T>> T getEnumOrElse(java.util.List<java.lang.String> path,
T defaultValue)
getEnumOrElse(List, Enum, EnumGetMethod) with method
EnumGetMethod.NAME_IGNORECASE.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)
T - the value's typepath - 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 neededmethod - the method to use when converting a non-enum value like a String or an intjava.lang.IllegalArgumentException - if the config contains a String that doesn't match any of
the enum constants, with regards to the given methodjava.lang.ClassCastException - if the config contains a value that cannot be converted to
an enum constant, like a Listdefault <T extends java.lang.Enum<T>> T getEnumOrElse(java.lang.String path,
java.lang.Class<T> enumType,
java.util.function.Supplier<T> defaultValueSupplier)
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)
T - the value's typepath - 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 neededmethod - the method to use when converting a non-enum value like a String or an intjava.lang.IllegalArgumentException - if the config contains a String that doesn't match any of
the enum constants, with regards to the given methodjava.lang.ClassCastException - if the config contains a value that cannot be converted to
an enum constant, like a Listdefault <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)
getEnumOrElse(List, Class, EnumGetMethod, Supplier) with method
EnumGetMethod.NAME_IGNORECASE.default int getInt(java.lang.String path)
get(String) but returns a primitive int. The config's value must be a
Number.default int getInt(java.util.List<java.lang.String> path)
get(List) but returns a primitive int. The config's value must be a
Number.default java.util.OptionalInt getOptionalInt(java.lang.String path)
getOptional(String) but returns a primitive int. The config's value must be a
Number or null or nonexistant.default java.util.OptionalInt getOptionalInt(java.util.List<java.lang.String> path)
getOptional(List) but returns a primitive int. The config's value must be a
Number or null or nonexistant.default int getIntOrElse(java.lang.String path,
int defaultValue)
getOrElse(String, Object) but returns a primitive int.
The config's value must be a Number or null or nonexistant.default int getIntOrElse(java.util.List<java.lang.String> path,
int defaultValue)
getOrElse(List, Object) but returns a primitive int.
The config's value must be a Number or null or nonexistant.default int getIntOrElse(java.lang.String path,
java.util.function.IntSupplier defaultValueSupplier)
getOrElse(String, Supplier) but returns a primitive int.
The config's value must be a Number or null or nonexistant.default int getIntOrElse(java.util.List<java.lang.String> path,
java.util.function.IntSupplier defaultValueSupplier)
getOrElse(List, Supplier) but returns a primitive int.
The config's value must be a Number or null or nonexistant.default long getLong(java.lang.String path)
get(String) but returns a primitive long. The config's value must be a
Number.default long getLong(java.util.List<java.lang.String> path)
get(List) but returns a primitive long. The config's value must be a
Number.default java.util.OptionalLong getOptionalLong(java.lang.String path)
getOptional(String) but returns a primitive long. The config's value must be a
Number or null or nonexistant.default java.util.OptionalLong getOptionalLong(java.util.List<java.lang.String> path)
getOptional(List) but returns a primitive long. The config's value must be a
Number or null or nonexistant.default long getLongOrElse(java.lang.String path,
long defaultValue)
getOrElse(String, Object) but returns a primitive long.
The config's value must be a Number or null or nonexistant.default long getLongOrElse(java.util.List<java.lang.String> path,
long defaultValue)
getOrElse(List, Object) but returns a primitive long.
The config's value must be a Number or null or nonexistant.default long getLongOrElse(java.lang.String path,
java.util.function.LongSupplier defaultValueSupplier)
getOrElse(String, Supplier) but returns a primitive long.
The config's value must be a Number or null or nonexistant.default long getLongOrElse(java.util.List<java.lang.String> path,
java.util.function.LongSupplier defaultValueSupplier)
getOrElse(List, Supplier) but returns a primitive long.
The config's value must be a Number or null or nonexistant.default byte getByte(java.lang.String path)
default byte getByte(java.util.List<java.lang.String> path)
default byte getByteOrElse(java.lang.String path,
byte defaultValue)
default byte getByteOrElse(java.util.List<java.lang.String> path,
byte defaultValue)
default short getShort(java.lang.String path)
default short getShort(java.util.List<java.lang.String> path)
default short getShortOrElse(java.lang.String path,
short defaultValue)
default short getShortOrElse(java.util.List<java.lang.String> path,
short defaultValue)
default char getChar(java.lang.String path)
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.
path - the value's path as a dot-separated Stringdefault char getChar(java.util.List<java.lang.String> path)
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.
path - the value's path as a list of Stringdefault char getCharOrElse(java.lang.String path,
char defaultValue)
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.
path - the value's pathdefaultValue - the char to return if the value doesn't exist in the configdefault char getCharOrElse(java.util.List<java.lang.String> path,
char defaultValue)
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.
path - the value's pathdefaultValue - the char to return if the value doesn't exist in the configdefault boolean contains(java.lang.String path)
path - the path to check, each part separated by a dot. Example "a.b.c"true if the path is associated with a value, false if it's not.boolean contains(java.util.List<java.lang.String> path)
path - the path to check, each element of the list is a different part of the path.true if the path is associated with a value, false if it's not.default boolean isNull(java.lang.String path)
path - the path to check, each part separated by a dot. Example "a.b.c"true if the path is associated with NullObject.NULL_OBJECT,
false if it's associated with another value or with no value.default boolean isNull(java.util.List<java.lang.String> path)
path - the path to check, each element of the list is a different part of the path.true if the path is associated with NullObject.NULL_OBJECT,
false if it's associated with another value or with no value.int size()
default boolean isEmpty()
true if the config is empty, false if it contains at least one
element.java.util.Map<java.lang.String,java.lang.Object> valueMap()
java.util.Set<? extends UnmodifiableConfig.Entry> entrySet()
ConfigFormat<?> configFormat()
default <T> T apply(java.lang.String path)
T - the value's typepath - the value's path, each part separated by a dot. Example "a.b.c"get(String)default <T> T apply(java.util.List<java.lang.String> path)
T - the value's typepath - the value's path, each element of the list is a different part of the path.get(List)