public class MemorySection extends Object implements ConfigurationSection
Synchronized with the commit on 07-June-2022.
| Modifier | Constructor and Description |
|---|---|
protected |
MemorySection()
Constructs an empty memory section for use as a root configuration
section.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addDefault(@NotNull String path,
@Nullable Object value)
Sets the default value in the root at the given path as provided.
|
protected void |
clear()
Clears the internal map.
|
boolean |
contains(@NotNull String path)
Checks if this configuration section contains the given path.
|
boolean |
contains(@NotNull String path,
boolean ignoreDefault)
Checks if this configuration section contains the given path.
|
static @NotNull String |
createPath(@NotNull ConfigurationSection section,
@Nullable String key)
Creates a full path to the given configuration section from its root
configuration.
|
static @NotNull String |
createPath(@NotNull ConfigurationSection section,
@Nullable String key,
@Nullable ConfigurationSection relative)
Creates a relative path to the given configuration section from the given
relative section.
|
@NotNull ConfigurationSection |
createSection(@NotNull String path)
Creates an empty configuration section at the given path.
|
@NotNull ConfigurationSection |
createSection(@NotNull String path,
@NotNull Map<?,?> map)
Creates a configuration section at the given path, with the given values.
|
@Nullable Object |
get(@NotNull String path)
Gets the value at the given path.
|
@Nullable Object |
get(@NotNull String path,
@Nullable Object def)
Gets the value at the given path, returning the given default value if
one has not been set.
|
boolean |
getBoolean(@NotNull String path)
Gets the boolean value at the given path.
|
boolean |
getBoolean(@NotNull String path,
boolean def)
Gets the boolean value at the given path.
|
@NotNull List<Boolean> |
getBooleanList(@NotNull String path)
Gets the list of booleans at the given path.
|
byte |
getByte(@NotNull String path)
Gets the byte value at the given path.
|
byte |
getByte(@NotNull String path,
byte def)
Gets the byte value at the given path.
|
@NotNull List<Byte> |
getByteList(@NotNull String path)
Gets the list of bytes at the given path.
|
char |
getChar(@NotNull String path)
Gets the char value at the given path.
|
char |
getChar(@NotNull String path,
char def)
Gets the char value at the given path.
|
@NotNull List<Character> |
getCharList(@NotNull String path)
Gets the list of chars at the given path.
|
@NotNull @UnmodifiableView List<String> |
getComments(@NotNull String path)
Gets the comments by path.
|
@Nullable ConfigurationSection |
getConfigurationSection(@NotNull String path)
Gets the configuration section value at the given path.
|
@NotNull String |
getCurrentPath()
Gets the path of this configuration section from its root configuration.
|
@Nullable ConfigurationSection |
getDefaultSection()
Gets the equivalent configuration section from the default configuration
defined in
ConfigurationSection.getRoot(). |
double |
getDouble(@NotNull String path)
Gets the double value at the given path.
|
double |
getDouble(@NotNull String path,
double def)
Gets the double value at the given path.
|
@NotNull List<Double> |
getDoubleList(@NotNull String path)
Gets the list of doubles at the given path.
|
float |
getFloat(@NotNull String path)
Gets the float value at the given path.
|
float |
getFloat(@NotNull String path,
float def)
Gets the float value at the given path.
|
@NotNull List<Float> |
getFloatList(@NotNull String path)
Gets the list of floats at the given path.
|
@NotNull @UnmodifiableView List<String> |
getInlineComments(@NotNull String path)
Gets the inline comments by path.
|
int |
getInt(@NotNull String path)
Gets the int value at the given path.
|
int |
getInt(@NotNull String path,
int def)
Gets the int value at the given path.
|
@NotNull List<Integer> |
getIntList(@NotNull String path)
Gets the list of ints at the given path.
|
@NotNull @UnmodifiableView Set<String> |
getKeys(boolean deep)
Gets a set containing a copy of all keys in this configuration section.
|
@Nullable List<?> |
getList(@NotNull String path)
Gets the list value at the given path.
|
@Nullable List<?> |
getList(@NotNull String path,
@Nullable List<?> def)
Gets the list value at the given path.
|
long |
getLong(@NotNull String path)
Gets the long value at the given path.
|
long |
getLong(@NotNull String path,
long def)
Gets the long value at the given path.
|
@NotNull List<Long> |
getLongList(@NotNull String path)
Gets the list of longs at the given path.
|
@NotNull List<Map<?,?>> |
getMapList(@NotNull String path)
Gets the list of maps at the given path.
|
@NotNull String |
getName()
Gets the name of this individual configuration section in its path.
|
<T> T |
getObject(@NotNull String path,
@NotNull Class<T> clazz)
Gets the value of type
T at the given path. |
<T> T |
getObject(@NotNull String path,
@NotNull Class<T> clazz,
T def)
Gets the value of type
T at the given path. |
@Nullable ConfigurationSection |
getParent()
Gets the parent configuration section that directly contains this
section.
|
@Nullable Configuration |
getRoot()
Gets the root configuration that contains this configuration section.
|
<T extends ConfigurationSerializable> |
getSerializable(@NotNull String path,
@NotNull Class<T> clazz)
Gets the configuration serializable value of type
T at the given
path. |
<T extends ConfigurationSerializable> |
getSerializable(@NotNull String path,
@NotNull Class<T> clazz,
T def)
Gets the configuration serializable value of type
T value at the
given path. |
short |
getShort(@NotNull String path)
Gets the short value at the given path.
|
short |
getShort(@NotNull String path,
short def)
Gets the short value at the given path.
|
@NotNull List<Short> |
getShortList(@NotNull String path)
Gets the list of shorts at the given path.
|
@Nullable String |
getString(@NotNull String path)
Gets the string value at the given path.
|
@Nullable String |
getString(@NotNull String path,
@Nullable String def)
Gets the string value at the given path.
|
@NotNull List<String> |
getStringList(@NotNull String path)
Gets the list of strings at the given path.
|
@NotNull @UnmodifiableView Map<String,Object> |
getValues(boolean deep)
Gets a map containing a copy of all keys and their respective values for
this configuration section.
|
boolean |
isBoolean(@NotNull String path)
Checks if the value at the given path is a boolean.
|
boolean |
isByte(@NotNull String path)
Checks if the value at the given path is a byte.
|
boolean |
isChar(@NotNull String path)
Checks if the value at the given path is a char.
|
boolean |
isConfigurationSection(@NotNull String path)
Checks if the value at the given path is a configuration section.
|
boolean |
isDouble(@NotNull String path)
Checks if the value at the given path is a double.
|
boolean |
isFloat(@NotNull String path)
Checks if the value at the given path is a float.
|
boolean |
isInt(@NotNull String path)
Checks if the value at the given path is an int.
|
boolean |
isList(@NotNull String path)
Checks if the value at the given path is a generic list.
|
boolean |
isLong(@NotNull String path)
Checks if the value at the given path is a long.
|
boolean |
isNumber(@NotNull String path)
Checks if the value at the given path is a number.
|
boolean |
isSet(@NotNull String path)
Checks if this configuration section has a value set for the given path.
|
boolean |
isShort(@NotNull String path)
Checks if the value at the given path is a short.
|
boolean |
isString(@NotNull String path)
Checks if the value at the given path is a string.
|
void |
set(@NotNull String path,
@Nullable Object value)
Sets the given path to the given value.
|
void |
setComments(@NotNull String path,
@Nullable List<String> comments)
Sets the comments at the given path.
|
void |
setInlineComments(@NotNull String path,
@Nullable List<String> inlineComments)
Sets the inline comments at the given path.
|
@NotNull String |
toString()
Creates a string representation of this memory section.
|
protected MemorySection()
throws IllegalStateException
NOTE: If the new memory section is not a configuration, an illegal argument exception will be thrown, as a configuration section cannot be orphaned by default, and all configuration sections must contain a root configuration.
IllegalStateException - If the new memory section is not a
configuration.@NotNull public final @NotNull @UnmodifiableView Set<String> getKeys(boolean deep)
If deep is set to true, then the set will contain all
keys within this configuration section as well as the keys of any
children sections of this section, working recursively down through each
child's potential children. As a result, all the keys will be the
fully-qualified paths.
If deep is set to false, then the set will contain only
the keys of any values of this configuration section, even if those
values themselves are children configuration sections.
In either case, the set will be unmodifiable, and any updates to the keys of this configuration section will not be reflected in the returned set.
getKeys in interface ConfigurationSectiondeep - true if the set is to contain the keys of the
children configuration section(s) of this section
(recursive), false otherwise.@NotNull public final @NotNull @UnmodifiableView Map<String,Object> getValues(boolean deep)
If deep is set to true, then the map will contain all
key-value pairings within this configuration section, as well as the
key-value pairings of any children sections of this section, working
recursively down through each child's potential children. As a result,
all the keys will be the fully-qualified paths.
If deep is set to false, then the map will contain only
the key-value pairings of this configuration section, even if those
values themselves are children configuration sections.
In either case, the map will be unmodifiable, and any updates to the keys, values, or the pairings of this configuration section will not be reflected in the returned set.
getValues in interface ConfigurationSectiondeep - true if the map is to contain the key-value pairings
of the children configuration section(s) of this section
(recursive), false otherwise.@NotNull public final @NotNull String getCurrentPath()
If this configuration section is a configuration itself, this will return an empty string.
If this configuration section is no longer contained within a root
configuration for any reason, such as being replaced with a different
value, this may return null.
This will return the fully-qualified path of this section. If only the
final part of the path of this section is desired, please use
ConfigurationSection.getName().
getCurrentPath in interface ConfigurationSectionnull if this section is
orphaned.@NotNull public final @NotNull String getName()
This will always be the final part of
ConfigurationSection.getCurrentPath(), unless this configuration
section is orphaned.
getName in interface ConfigurationSection@Nullable public final @Nullable Configuration getRoot()
If this configuration section is itself a configuration, this will return this section.
If this configuration section is no longer contained within a root
configuration for any reason, such as being replaced with a different
value, this may return null.
getRoot in interface ConfigurationSectionnull if this section is orphaned.@Nullable public @Nullable ConfigurationSection getParent()
If this configuration section is itself a configuration, this will return
null.
If this configuration section is no longer contained within a root
configuration for any reason, such as being replaced with a different
value, this may return null.
getParent in interface ConfigurationSectionnull if this section does not have a parent.@Nullable public final @Nullable ConfigurationSection getDefaultSection()
ConfigurationSection.getRoot().
If the root configuration contains no defaults, or the defaults do not
contain a value for this configuration section's path, or the value at
this path is not itself a configuration section, this will return
null.
getDefaultSection in interface ConfigurationSectionnull if one does not exist or is not
the correct type.public void addDefault(@NotNull
@NotNull String path,
@Nullable
@Nullable Object value)
If no source configuration was provided as a default collection, then a new memory configuration will be created to hold the given 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 configuration section at the path, replacing
anything that may have existed there previously.
addDefault in interface ConfigurationSectionpath - The path of the default value to set.value - The value to set the default to.@NotNull public final @NotNull @UnmodifiableView List<String> getComments(@NotNull @NotNull String path)
If no comments exist, and empty list will be returned. A null
entry represents an empty line and an empty string represents an empty
comment line (# with nothing after it).
The returned list will be unmodifiable, and any changes to the underlying comments in this configuration section will not be reflected in the returned list.
getComments in interface ConfigurationSectionpath - The path of the comments to get.@NotNull public final @NotNull @UnmodifiableView List<String> getInlineComments(@NotNull @NotNull String path)
If no comments exist, an empty list will be returned. A null
entry represents an empty line and an empty string represents an empty
comment line (# with nothing after it).
The returned list will be unmodifiable, and any changes to the underlying inline comments in this configuration section will not be reflected in the returned list.
getInlineComments in interface ConfigurationSectionpath - The path of the comments to get.public final void setComments(@NotNull
@NotNull String path,
@Nullable
@Nullable List<String> comments)
If the given list is null itself, any existing comments will be
removed. Otherwise, the existing comments will be replaced with the
contents of the given list, regardless of the previous comment values.
A null entry in the list will result in an empty line, and an
empty string as an entry will result in an empty comment line (#
with nothing after it).
setComments in interface ConfigurationSectionpath - The path of the comments to set.comments - The new comments to set at the given path, where every
entry in the list represents one line. null to
remove any existing comments.public final void setInlineComments(@NotNull
@NotNull String path,
@Nullable
@Nullable List<String> inlineComments)
If the given list is null itself, any existing inline comments
will be removed. Otherwise, the existing inline comments will be replaced
with the contents of the given list, regardless of the previous comment
values.
A null entry in the list will result in an empty line, and an
empty string as an entry will result in an empty comment line (#
with nothing after it).
setInlineComments in interface ConfigurationSectionpath - The path of the inline comments to set.inlineComments - The new inline comments to set at the given path,
where every entry in the list represents one line.
null to remove any existing inline
comments.@NotNull public final @NotNull ConfigurationSection createSection(@NotNull @NotNull String path)
Any value that was previously set at this path will be overwritten. If the previous value was a configuration section itself, that section will be orphaned.
createSection in interface ConfigurationSectionpath - The path to create the configuration section at.@NotNull public final @NotNull ConfigurationSection createSection(@NotNull @NotNull String path, @NotNull @NotNull Map<?,?> map)
Any value that was previously set at this path will be overwritten. If the previous value was a configuration section itself, that section will be orphaned.
createSection in interface ConfigurationSectionpath - The path to create the configuration section at.map - The key-value pairings to place in the newly-created
configuration section.public final boolean isSet(@NotNull
@NotNull String path)
If the value for the given path does not exist but a default value has
been set, this will still return false. If the status of a
default value is desired, please use
ConfigurationSection.contains(String).
isSet in interface ConfigurationSectionpath - The path to check for existence.true if this configuration section contains the given
path, regardless of having a default, false otherwise.ConfigurationSection.contains(String)public final void set(@NotNull
@NotNull String path,
@Nullable
@Nullable Object value)
If the given value is null, the entry will be removed.
The given value may not be a configuration or a configuration section. If
a new configuration section is desired, please use
ConfigurationSection.createSection(String).
set in interface ConfigurationSectionpath - The path to the given value.value - The new value to store at the given path.public final boolean contains(@NotNull
@NotNull String path)
If the value for the given path does not exist but a default value has
been set, this will return true. If the existence of a default
value is to be ignored, please use
ConfigurationSection.contains(String, boolean), where
ignoreDefault is true.
contains in interface ConfigurationSectionpath - The path to check for existence.true if this configuration section contains the given
path, either via an actual value or default value being set,
false otherwise.ConfigurationSection.contains(String, boolean)public final boolean contains(@NotNull
@NotNull String path,
boolean ignoreDefault)
If true is given for ignoreDefault, then this will
return true only if a value has been set for the given path.
If false is given for ignoreDefaults, then this will
return true if a value has been set for the given path, or if a
default value has been set for the given path.
contains in interface ConfigurationSectionpath - The path to check for existence.ignoreDefault - true if any default values should be ignored
when checking for a value at the path, false
otherwise.true if this configuration section contains an actual
value at the given path, or if a default value has been set
and ignoreDefault is false, false
otherwise.@Nullable public final @Nullable Object get(@NotNull @NotNull String path)
If a value has not been set at the given path, but a default value has
been set, this will return the default value. If no value and no default
value have been set, this will return null.
get in interface ConfigurationSectionpath - The path of the value to retrieve.@Contract(value="_, !null -> !null") @Nullable public final @Nullable Object get(@NotNull @NotNull String path, @Nullable @Nullable Object def)
If a value has not been set at the given path, the given default value will be returned, regardless of whether a default value exists in the root configuration.
get in interface ConfigurationSectionpath - The path of the value to retrieve.def - The value to use as a default.public final boolean isBoolean(@NotNull
@NotNull String path)
If the value exists at the given path but is not a boolean, this will
return false.
If the value does not exist at the given path but a default value has been set, this will check the default value and return appropriately.
isBoolean in interface ConfigurationSectionpath - The path of the boolean to check.true if a boolean value exists, or if there is no value,
a default has been set, and it is a boolean, false
otherwise.public final boolean getBoolean(@NotNull
@NotNull String path)
If the value exists at the given path but is not a boolean, this will
return false.
If the value does not exist at the given path, but a default value has been set, this will check that value and return similar to the above.
getBoolean in interface ConfigurationSectionpath - The path of the boolean to retrieve.public final boolean getBoolean(@NotNull
@NotNull String path,
boolean def)
If the value exists at the given path but is not a boolean, or if the value does not exist at the given path, this will return the given default.
If a default value has been set in the root configuration, it will be ignored, even if the given path does not have a set value.
getBoolean in interface ConfigurationSectionpath - The path of the boolean to retrieve.def - The boolean to use as the default.public final boolean isNumber(@NotNull
@NotNull String path)
If the value exists at the given path but is not a number, this will
return false.
If the value does not exist at the give path but a default value has been set, this will check that value and return appropriately.
This method is meant to be a more generic check than the specific
number-based checks below, such as
ConfigurationSection.isByte(String), or
ConfigurationSection.isDouble(String). Those methods check
to see if the requested value (or default) is of the exact type, whereas
this method will simply check for a number.
isNumber in interface ConfigurationSectionpath - The path of the number to check.true if a number value exists, or if there is no value,
a default has been set, and it is a number, false
otherwise.ConfigurationSection.isByte(String),
ConfigurationSection.isShort(String),
ConfigurationSection.isInt(String),
ConfigurationSection.isLong(String),
ConfigurationSection.isFloat(String),
ConfigurationSection.isDouble(String)public final boolean isByte(@NotNull
@NotNull String path)
If the value exists at the given path but is not a byte, this will
return false.
If the value does not exist at the given path but a default value has been set, this will check that value and return appropriately.
This method will check to see if the requested value (or default) is
specifically a byte. If the value is another type of number, this will
return false. To check for a generic number please use
ConfigurationSection.isNumber(String).
isByte in interface ConfigurationSectionpath - The path of the byte to check.true if a byte value exists, or if there is no value, a
default has been set, and it is a byte, false otherwise.ConfigurationSection.isNumber(String)public final byte getByte(@NotNull
@NotNull String path)
If the value exists at the given path but is not a byte, this will return
(byte) 0.
If the value does not exist at the given path, but a default value has been set, this will check that value and return similar to the above.
getByte in interface ConfigurationSectionpath - The path of the byte to retrieve.public final byte getByte(@NotNull
@NotNull String path,
byte def)
If the value exists at the given path but is not a byte, or if the value does not exist at the given path, this will return the given default.
If a default value has been set in the root configuration, it will be ignored, even if the given path does not have a set value.
getByte in interface ConfigurationSectionpath - The path of the byte to retrieve.def - The byte to use as the default.public final boolean isShort(@NotNull
@NotNull String path)
If the value exists at the given path but is not a short, this will
return false.
If the value does not exist at the given path but a default value has been set, this will check that value and return appropriately.
This method will check to see if the requested value (or default) is
specifically a short. If the value is another type of number, this will
return false. To check for a generic number, please use
ConfigurationSection.isNumber(String).
isShort in interface ConfigurationSectionpath - The path of the short to check.true if a short value exists, or if there is no value, a
default has been set, and it is a short, false otherwise.ConfigurationSection.isNumber(String)public final short getShort(@NotNull
@NotNull String path)
If the value exists at the given path but is not a short, this will
return (short) 0.
If the value does not exist at the given path, but a default value has been set, this will check that value and return similar to the above.
getShort in interface ConfigurationSectionpath - The path of the short to retrieve.public final short getShort(@NotNull
@NotNull String path,
short def)
If the value exists at the given path but is not a short, or if the value does not exist at the given path, this will return the given default.
If a default value has been set in the root configuration, it will be ignored, even if the given path does not have a set value.
getShort in interface ConfigurationSectionpath - The path of the short to retrieve.def - The short to use as the default.public final boolean isInt(@NotNull
@NotNull String path)
If the value exists at the given path but is not an int, this will return
false.
If the value does not exist at the given path but a default value has been set, this will check that value and return appropriately.
This method will check to see if the requested value (or default) is
specifically an int. If the value is another type of number, this will
return false. To check for a generic number, please use
ConfigurationSection.isNumber(String).
isInt in interface ConfigurationSectionpath - The path of the int to check.true if an int value exists, or if there is no value, a
default has been set, and it is an int, false otherwise.ConfigurationSection.isNumber(String)public final int getInt(@NotNull
@NotNull String path)
If the value exists at the given path but is not an int, this will return
0.
If the value does not exist at the given path, but a default value has been set, this will check that value and return similar to the above.
getInt in interface ConfigurationSectionpath - The path of the int to retrieve.public final int getInt(@NotNull
@NotNull String path,
int def)
If the value exists at the given path but is not an int, or if the value does not exist at the given path, this will return the given default.
If a default value has been set in the root Configuration, it
will be ignored, even if the given path does not have a set value.
getInt in interface ConfigurationSectionpath - The path of the int to retrieve.def - The int to use as the default.public final boolean isLong(@NotNull
@NotNull String path)
If the value exists at the given path but is not a long, this will return
false.
If the value does not exist at the given path but a default value has been set, this will check that value and return appropriately.
This method will check to see if the requested value (or default) is
specifically a long. If the value is another type of number, this will
return false. To check for a generic number, please use
ConfigurationSection.isNumber(String).
isLong in interface ConfigurationSectionpath - The path of the long to check.true if a long value exists, or if there is no value, a
default has been set, and it is a long, false otherwise.ConfigurationSection.isNumber(String)public final long getLong(@NotNull
@NotNull String path)
If the value exists at the given path but is not a long, this will return
0L.
If the value does not exist at the given path, but a default value has been set, this will check that value and return similar to the above.
getLong in interface ConfigurationSectionpath - The path of the long to retrieve.public final long getLong(@NotNull
@NotNull String path,
long def)
If the value exists at the given path but is not a long, or if the value does not exist at the given path, this will return the given default.
If a default value has been set in the root configuration, it will be ignored, even if the given path does not have a set value.
getLong in interface ConfigurationSectionpath - The path of the long to retrieve.def - The long to use as the default.public final boolean isFloat(@NotNull
@NotNull String path)
If the value exists at the given path but is not a float, this will
return false.
If the value does not exist at the given path but a default value has been set, this will check that value and return appropriately.
This method will check to see if the requested value (or default) is
specifically a float. If the value is another type of number, this will
return false. To check for a generic number, please use
ConfigurationSection.isNumber(String).
isFloat in interface ConfigurationSectionpath - The path of the float to check.true if a float value exists, or if there is no value, a
default has been set, and it is a float, false otherwise.ConfigurationSection.isNumber(String)public final float getFloat(@NotNull
@NotNull String path)
If the value exists at the given path but is not a float, this will
return 0.0F.
If the value does not exist at the given path, but a default value has been set, this will check that value and return similar to the above.
getFloat in interface ConfigurationSectionpath - The path of the float to retrieve.public final float getFloat(@NotNull
@NotNull String path,
float def)
If the value exists at the given path but is not a float, or if the value does not exist at the given path, this will return the given default.
If a default value has been set in the root configuration, it will be ignored, even if the given path does not have a set value.
getFloat in interface ConfigurationSectionpath - The path of the float to retrieve.def - The float to use as the default.public final boolean isDouble(@NotNull
@NotNull String path)
If the value exists at the given path but is not a double, this will
return false.
If the value does not exist at the given path but a default value has been set, this will check that value and return appropriately.
This method will check to see if the requested value (or default) is
specifically a double. If the value is another type of number, this will
return false. To check for a generic number, please use
ConfigurationSection.isNumber(String).
isDouble in interface ConfigurationSectionpath - The path of the double to check.true if a double value exists, or if there is no value, a
default has been set, and it is a double, false
otherwise.ConfigurationSection.isNumber(String)public final double getDouble(@NotNull
@NotNull String path)
If the value exists at the given path but is not a double, this will
return 0.0D.
If the value does not exist at the given path, but a default value has been set, this will check that value and return similar to the above.
getDouble in interface ConfigurationSectionpath - The path of the double to retrieve.public final double getDouble(@NotNull
@NotNull String path,
double def)
If the value exists at the given path but is not a double, or if the value does not exist at the given path, this will return the given default.
If a default value has been set in the root configuration, it will be ignored, even if the given path does not have a set value.
getDouble in interface ConfigurationSectionpath - The path of the double to retrieve.def - The double to use as the default.public final boolean isChar(@NotNull
@NotNull String path)
If the value exists at the given path but is not a char, this will return
false.
If the value does not exist at the given path but a default value has been set, this will check that value and return appropriately.
isChar in interface ConfigurationSectionpath - The path of the char to check.true if a char value exists, or if there is no value, a
default has been set, and it is a char, false otherwise.public final char getChar(@NotNull
@NotNull String path)
If the value exists at the given path but is not a char, this will return
.
If the value does not exist at the given path, but a default value has been set, this will check that value and return similar to the above.
getChar in interface ConfigurationSectionpath - The path of the char to retrieve.public final char getChar(@NotNull
@NotNull String path,
char def)
If the value exists at the given path but is not a char, or if the value does not exist at the given path, this will return the given default.
If a default value has been set in the root configuration, it will be ignored, even if the given path does not have a set value.
getChar in interface ConfigurationSectionpath - The path of the char to retrieve.def - The char to use as the default.public final boolean isString(@NotNull
@NotNull String path)
If the value exists at the given path but is not a string, this will
return false.
If the value does not exist at the given path but a default value has been set, this will check that value and return appropriately.
isString in interface ConfigurationSectionpath - The path of the string to check.true if a string value exists, or if there is no value, a
default has been set, and it is a string, false otherwise.@Nullable public final @Nullable String getString(@NotNull @NotNull String path)
If the value exists at the given path but is not a string, this will
return null.
If the value does not exist at the given path, but a default value has been set, this will check that value and return similar to the above.
getString in interface ConfigurationSectionpath - The path of the string to retrieve.@Contract(value="_, !null -> !null") @Nullable public final @Nullable String getString(@NotNull @NotNull String path, @Nullable @Nullable String def)
If the value exists at the given path but is not a string, or if the value does not exist at the given path, this will return the given default.
If a default value has been set in the root configuration, it will be ignored, even if the given path does not have a set value.
getString in interface ConfigurationSectionpath - The path of the string to retrieve.def - The string to use as the default.public final boolean isList(@NotNull
@NotNull String path)
If the value exists at the given path but is not a list, this will return
false.
If the value does not exist at the given path but a default value has been set, this will check that value and return appropriately.
isList in interface ConfigurationSectionpath - The path of the list to check.true if a list value exists, or if there is no value, a
default has been set, and it is a list, false otherwise.@Nullable public final @Nullable List<?> getList(@NotNull @NotNull String path)
If the value exists at the given path but is not a list, this will return
null.
If the value does not exist at the given path, but a default value has been set, this will check that value and return similar to the above.
getList in interface ConfigurationSectionpath - The path of the list to retrieve.@Contract(value="_, !null -> !null") @Nullable public final @Nullable List<?> getList(@NotNull @NotNull String path, @Nullable @Nullable List<?> def)
If the value exists at the given path but is not a list, or if the value does not exist at the given path, this will return the given default.
If a default value has been set in the root configuration, it will be ignored, even if the given path does not have a set value.
getList in interface ConfigurationSectionpath - The path of the list to retrieve.def - The list to use as the default.public final boolean isConfigurationSection(@NotNull
@NotNull String path)
If the value exists at the given path but is not a configuration section,
this will return false.
If the value does not exist at the given path but a default value has been set, this will check that value and return appropriately.
isConfigurationSection in interface ConfigurationSectionpath - The path of the configuration section to check.true if a configuration section value exists, or if there
is no value, a default has been set, and it is a configuration
section. false otherwise.@Nullable public final @Nullable ConfigurationSection getConfigurationSection(@NotNull @NotNull String path)
If the value exists at the given path but is not a configuration section,
this will return null.
If the value does not exist at the given path, but a default value has been set, this will check that value and return similar to the above.
getConfigurationSection in interface ConfigurationSectionpath - The path of the configuration section to retrieve.@Nullable
public final <T> T getObject(@NotNull
@NotNull String path,
@NotNull
@NotNull Class<T> clazz)
T at the given path.
If the value exists at the given path but is not of type T, this
will return null.
If the value does not exist at the given path, but a default value has been set, this will check that value and return similar to the above.
Note: Using this method to get a string is not the same as
ConfigurationSection.getString(String), as the latter internally
converts all non-strings to strings, whereas this method will only give
the requested value if it is an instance of T. The same applies
to any number, as they are cast to a number internally, and then the
correct value is returned.
getObject in interface ConfigurationSectionT - The type of the requested value.path - The path of the value of type T to retrieve.clazz - The class of type T of the requested value.T.@Contract(value="_, _, !null -> !null")
@Nullable
public final <T> T getObject(@NotNull
@NotNull String path,
@NotNull
@NotNull Class<T> clazz,
@Nullable
T def)
T at the given path.
If the value exists at the given path but is not of type T, or if
the value does not exist at the given path, this will return the given
default.
If a default value has been set in the root configuration, it will be ignored, even if the given path does not have a set value.
Note: Using this method to get a string is not the same as
ConfigurationSection.getString(String), as the latter internally
converts all non-strings to strings, whereas this method will only give
the requested value if it is an instance of T. The same applies
to any number, as they are cast to a number internally, and then the
correct value is returned.
getObject in interface ConfigurationSectionT - The type of the requested value.path - The path of the value of type T to retrieve.clazz - The class of type T of the requested value.def - The value of type T to use as the default.T.@Nullable public final <T extends ConfigurationSerializable> T getSerializable(@NotNull @NotNull String path, @NotNull @NotNull Class<T> clazz)
T at the given
path.
If the value exists at the given path but is not a configuration
serializable of type T, this will return null.
If the value does not exist at the given path, but a default value has been set, this will check that value and return similar to the above.
getSerializable in interface ConfigurationSectionT - The type of the requested configuration serializable.path - The path of the configuration serializable value of type
T to retrieve.clazz - The class of type T of the requested configuration
serializable.T.@Contract(value="_, _, !null -> !null") @Nullable public final <T extends ConfigurationSerializable> T getSerializable(@NotNull @NotNull String path, @NotNull @NotNull Class<T> clazz, @Nullable T def)
T value at the
given path.
If the value exists at the given path but is not a configuration
serializable value of type T, or if the value does not exist at
the given path, this will return the given default.
If a default value has been set in the root configuration, it will be ignored, even if the given path does not have a set value.
getSerializable in interface ConfigurationSectionT - The type of the requested configuration serializable.path - The path of the configuration serializable value of type
T to retrieve.clazz - The class of type T of the requested configuration
serializable.def - The configuration serializable value of type T to use
as the default.T.@NotNull public final @NotNull List<Boolean> getBooleanList(@NotNull @NotNull String path)
If the value exists at the given path but is not a list of booleans, this will attempt to cast any values into a boolean, if possible. It may miss on any values that are not compatible.
If the value does not exist at the given path, but a default value has been set, this will check that value and return similar to the above.
If the value does not exist at the given path and no default value has been set, this will return an empty list.
getBooleanList in interface ConfigurationSectionpath - The path of the list of booleans to retrieve.@NotNull public final @NotNull List<Byte> getByteList(@NotNull @NotNull String path)
If the value exists at the given path but is not a list of bytes, this will attempt to cast any values into a byte, if possible. It may miss on any values that are not compatible.
If the value does not exist at the given path, but a default value has been set, this will check that value and return similar to the above.
If the value does not exist at the given path and no default value has been set, this will return an empty list.
getByteList in interface ConfigurationSectionpath - The path of the list of bytes to retrieve.@NotNull public final @NotNull List<Short> getShortList(@NotNull @NotNull String path)
If the value exists at the given path but is not a list of shorts, this will attempt to cast any values into a short, if possible. It may miss on any values that are not compatible.
If the value does not exist at the given path, but a default value has been set, this will check that value and return similar to the above.
If the value does not exist at the given path and no default value has been set, this will return an empty list.
getShortList in interface ConfigurationSectionpath - The path of the list of shorts to retrieve.@NotNull public final @NotNull List<Integer> getIntList(@NotNull @NotNull String path)
If the value exists at the given path but is not a list of ints, this will attempt to cast any values into an int, if possible. It may miss on any values that are not compatible.
If the value does not exist at the given path, but a default value has been set, this will check that value and return similar to the above.
If the value does not exist at the given path and no default value has been set, this will return an empty list.
getIntList in interface ConfigurationSectionpath - The path of the list of ints to retrieve.@NotNull public final @NotNull List<Long> getLongList(@NotNull @NotNull String path)
If the value exists at the given path but is not a list of longs, this will attempt to cast any values into a long, if possible. It may miss on any values that are not compatible.
If the value does not exist at the given path, but a default value has been set, this will check that value and return similar to the above.
If the value does not exist at the given path and no default value has been set, this will return an empty list.
getLongList in interface ConfigurationSectionpath - The path of the list of longs to retrieve.@NotNull public final @NotNull List<Float> getFloatList(@NotNull @NotNull String path)
If the value exists at the given path but is not a list of floats, this will attempt to cast any values into a float, if possible. It may miss on any values that are not compatible.
If the value does not exist at the given path, but a default value has been set, this will check that value and return similar to the above.
If the value does not exist at the given path and no default value has been set, this will return an empty list.
getFloatList in interface ConfigurationSectionpath - The path of the list of floats to retrieve.@NotNull public final @NotNull List<Double> getDoubleList(@NotNull @NotNull String path)
If the value exists at the given path but is not a list of doubles, this will attempt to cast any values into a double, if possible. It may miss on any values that are not compatible.
If the value does not exist at the given path, but a default value has been set, this will check that value and return similar to the above.
If the value does not exist at the given path and no default value has been set, this will return an empty list.
getDoubleList in interface ConfigurationSectionpath - The path of the list of doubles to retrieve.@NotNull public final @NotNull List<Character> getCharList(@NotNull @NotNull String path)
If the value exists at the given path but is not a list of chars, this will attempt to cast any values into a char, if possible. It may miss on any values that are not compatible.
If the value does not exist at the given path, but a default value has been set, this will check that value and return similar to the above.
If the value does not exist at the given path and no default value has been set, this will return an empty list.
getCharList in interface ConfigurationSectionpath - The path of the list of chars to retrieve.@NotNull public final @NotNull List<String> getStringList(@NotNull @NotNull String path)
If the value exists at the given path but is not a list of strings, this will attempt to cast any values into a string, if possible. It may miss on any values that are not compatible.
If the value does not exist at the given path, but a default value has been set, this will check that value and return similar to the above.
If the value does not exist at the given path and no default value has been set, this will return an empty list.
getStringList in interface ConfigurationSectionpath - The path of the list of strings to retrieve.@NotNull public final @NotNull List<Map<?,?>> getMapList(@NotNull @NotNull String path)
If the value exists at the given path but is not a list of maps, this will attempt to cast any values into a map, if possible. It may miss on any values that are not compatible.
If the value does not exist at the given path, but a default value has been set, this will check that value and return similar to the above.
If the value does not exist at the given path and no default value has been set, this will return an empty list.
getMapList in interface ConfigurationSectionpath - The path of the list of maps to retrieve.protected final void clear()
@NotNull public final @NotNull String toString()
@NotNull public static @NotNull String createPath(@NotNull @NotNull ConfigurationSection section, @Nullable @Nullable String key)
You may use this method for any given configuration section, not only this memory section.
section - The configuration section to create a path for.key - The name of the given configuration section.@NotNull public static @NotNull String createPath(@NotNull @NotNull ConfigurationSection section, @Nullable @Nullable String key, @Nullable @Nullable ConfigurationSection relative)
You may use this method for any given configuration section, not only this memory section.
section - The configuration section to create a path for.key - The name of the given configuration section.relative - The configuration section to create the path relative to.Copyright © 2024 BSPF Systems, LLC. All rights reserved.