public interface ConfigurationSection
Configuration
Modifier and Type | Method and Description |
---|---|
void |
addDefault(String path,
Object value)
Sets the default value in the root at the given path as provided.
|
boolean |
contains(String path)
Checks if this
ConfigurationSection contains the given path. |
boolean |
contains(String path,
boolean ignoreDefault)
Checks if this
ConfigurationSection contains the given path. |
ConfigurationSection |
createSection(String path)
Creates an empty
ConfigurationSection at the specified path. |
ConfigurationSection |
createSection(String path,
Map<?,?> map)
Creates a
ConfigurationSection at the specified path, with
specified values. |
Object |
get(String path)
Gets the requested Object by path.
|
Object |
get(String path,
Object def)
Gets the requested Object by path, returning a default value if not
found.
|
boolean |
getBoolean(String path)
Gets the requested boolean by path.
|
boolean |
getBoolean(String path,
boolean def)
Gets the requested boolean by path, returning a default value if not
found.
|
List<Boolean> |
getBooleanList(String path)
Gets the requested List of Boolean by path.
|
List<Byte> |
getByteList(String path)
Gets the requested List of Byte by path.
|
List<Character> |
getCharacterList(String path)
Gets the requested List of Character by path.
|
Color |
getColor(String path)
Gets the requested Color by path.
|
Color |
getColor(String path,
Color def)
Gets the requested
Color by path, returning a default value if
not found. |
ConfigurationSection |
getConfigurationSection(String path)
Gets the requested ConfigurationSection by path.
|
String |
getCurrentPath()
Gets the path of this
ConfigurationSection from its root Configuration |
ConfigurationSection |
getDefaultSection()
|
double |
getDouble(String path)
Gets the requested double by path.
|
double |
getDouble(String path,
double def)
Gets the requested double by path, returning a default value if not
found.
|
List<Double> |
getDoubleList(String path)
Gets the requested List of Double by path.
|
List<Float> |
getFloatList(String path)
Gets the requested List of Float by path.
|
int |
getInt(String path)
Gets the requested int by path.
|
int |
getInt(String path,
int def)
Gets the requested int by path, returning a default value if not found.
|
List<Integer> |
getIntegerList(String path)
Gets the requested List of Integer by path.
|
ItemStack |
getItemStack(String path)
Gets the requested ItemStack by path.
|
ItemStack |
getItemStack(String path,
ItemStack def)
Gets the requested
ItemStack by path, returning a default value
if not found. |
Set<String> |
getKeys(boolean deep)
Gets a set containing all keys in this section.
|
List<?> |
getList(String path)
Gets the requested List by path.
|
List<?> |
getList(String path,
List<?> def)
Gets the requested List by path, returning a default value if not
found.
|
long |
getLong(String path)
Gets the requested long by path.
|
long |
getLong(String path,
long def)
Gets the requested long by path, returning a default value if not
found.
|
List<Long> |
getLongList(String path)
Gets the requested List of Long by path.
|
List<Map<?,?>> |
getMapList(String path)
Gets the requested List of Maps by path.
|
String |
getName()
Gets the name of this individual
ConfigurationSection , in the
path. |
OfflinePlayer |
getOfflinePlayer(String path)
Gets the requested OfflinePlayer by path.
|
OfflinePlayer |
getOfflinePlayer(String path,
OfflinePlayer def)
Gets the requested
OfflinePlayer by path, returning a default
value if not found. |
ConfigurationSection |
getParent()
Gets the parent
ConfigurationSection that directly contains
this ConfigurationSection . |
Configuration |
getRoot()
Gets the root
Configuration that contains this ConfigurationSection |
<T extends ConfigurationSerializable> |
getSerializable(String path,
Class<T> clazz)
Gets the requested
ConfigurationSerializable object at the given
path. |
<T extends ConfigurationSerializable> |
getSerializable(String path,
Class<T> clazz,
T def)
Gets the requested
ConfigurationSerializable object at the given
path, returning a default value if not found
If the Object does not exist then the specified default value will
returned regardless of if a default has been identified in the root
Configuration . |
List<Short> |
getShortList(String path)
Gets the requested List of Short by path.
|
String |
getString(String path)
Gets the requested String by path.
|
String |
getString(String path,
String def)
Gets the requested String by path, returning a default value if not
found.
|
List<String> |
getStringList(String path)
Gets the requested List of String by path.
|
Map<String,Object> |
getValues(boolean deep)
Gets a Map containing all keys and their values for this section.
|
Vector |
getVector(String path)
Gets the requested Vector by path.
|
Vector |
getVector(String path,
Vector def)
Gets the requested
Vector by path, returning a default value if
not found. |
boolean |
isBoolean(String path)
Checks if the specified path is a boolean.
|
boolean |
isColor(String path)
Checks if the specified path is a Color.
|
boolean |
isConfigurationSection(String path)
Checks if the specified path is a ConfigurationSection.
|
boolean |
isDouble(String path)
Checks if the specified path is a double.
|
boolean |
isInt(String path)
Checks if the specified path is an int.
|
boolean |
isItemStack(String path)
Checks if the specified path is an ItemStack.
|
boolean |
isList(String path)
Checks if the specified path is a List.
|
boolean |
isLong(String path)
Checks if the specified path is a long.
|
boolean |
isOfflinePlayer(String path)
Checks if the specified path is an OfflinePlayer.
|
boolean |
isSet(String path)
Checks if this
ConfigurationSection has a value set for the
given path. |
boolean |
isString(String path)
Checks if the specified path is a String.
|
boolean |
isVector(String path)
Checks if the specified path is a Vector.
|
void |
set(String path,
Object value)
Sets the specified path to the given value.
|
Set<String> getKeys(boolean deep)
If deep is set to true, then this will contain all the keys within any
child ConfigurationSection
s (and their children, etc). These
will be in a valid path notation for you to use.
If deep is set to false, then this will contain only the keys of any direct children, and not their own children.
deep
- Whether or not to get a deep list, as opposed to a shallow
list.Map<String,Object> getValues(boolean deep)
If deep is set to true, then this will contain all the keys and values
within any child ConfigurationSection
s (and their children,
etc). These keys will be in a valid path notation for you to use.
If deep is set to false, then this will contain only the keys and values of any direct children, and not their own children.
deep
- Whether or not to get a deep list, as opposed to a shallow
list.boolean contains(String path)
ConfigurationSection
contains the given path.
If the value for the requested path does not exist but a default value has been specified, this will return true.
path
- Path to check for existence.IllegalArgumentException
- Thrown when path is null.boolean contains(String path, boolean ignoreDefault)
ConfigurationSection
contains the given path.
If the value for the requested path does not exist, the boolean parameter of true has been specified, a default value for the path exists, this will return true.
If a boolean parameter of false has been specified, true will only be returned if there is a set value for the specified path.
path
- Path to check for existence.ignoreDefault
- Whether or not to ignore if a default value for the
specified path exists.IllegalArgumentException
- Thrown when path is null.boolean isSet(String path)
ConfigurationSection
has a value set for the
given path.
If the value for the requested path does not exist but a default value has been specified, this will still return false.
path
- Path to check for existence.IllegalArgumentException
- Thrown when path is null.String getCurrentPath()
ConfigurationSection
from its root Configuration
For any Configuration
themselves, this will return an empty
string.
If the section is no longer contained within its root for any reason, such as being replaced with a different value, this may return null.
To retrieve the single name of this section, that is, the final part of
the path returned by this method, you may use getName()
.
String getName()
ConfigurationSection
, in the
path.
This will always be the final part of getCurrentPath()
, unless
the section is orphaned.
Configuration getRoot()
Configuration
that contains this ConfigurationSection
For any Configuration
themselves, this will return its own
object.
If the section is no longer contained within its root for any reason, such as being replaced with a different value, this may return null.
ConfigurationSection getParent()
ConfigurationSection
that directly contains
this ConfigurationSection
.
For any Configuration
themselves, this will return null.
If the section is no longer contained within its parent for any reason, such as being replaced with a different value, this may return null.
Object get(String path)
If the Object does not exist but a default value has been specified, this will return the default value. If the Object does not exist and no default value was specified, this will return null.
path
- Path of the Object to get.Object get(String path, Object def)
If the Object does not exist then the specified default value will
returned regardless of if a default has been identified in the root
Configuration
.
path
- Path of the Object to get.def
- The default value to return if the path is not found.void set(String path, Object value)
If value is null, the entry will be removed. Any existing entry will be replaced, regardless of what the new value is.
Some implementations may have limitations on what you may store. See
their individual javadocs for details. No implementations should allow
you to store Configuration
s or ConfigurationSection
s,
please use createSection(java.lang.String)
for that.
path
- Path of the object to set.value
- New value to set the path to.ConfigurationSection createSection(String path)
ConfigurationSection
at the specified path.
Any value that was previously set at this path will be overwritten. If
the previous value was itself a ConfigurationSection
, it will
be orphaned.
path
- Path to create the section at.ConfigurationSection createSection(String path, Map<?,?> map)
ConfigurationSection
at the specified path, with
specified values.
Any value that was previously set at this path will be overwritten. If
the previous value was itself a ConfigurationSection
, it will
be orphaned.
path
- Path to create the section at.map
- The values to used.String getString(String path)
If the String does not exist but a default value has been specified, this will return the default value. If the String does not exist and no default value was specified, this will return null.
path
- Path of the String to get.String getString(String path, String def)
If the String does not exist then the specified default value will
returned regardless of if a default has been identified in the root
Configuration
.
path
- Path of the String to get.def
- The default value to return if the path is not found or is
not a String.boolean isString(String path)
If the path exists but is not a String, this will return false. If the path does not exist, this will return false. If the path does not exist but a default value has been specified, this will check if that default value is a String and return appropriately.
path
- Path of the String to check.int getInt(String path)
If the int does not exist but a default value has been specified, this will return the default value. If the int does not exist and no default value was specified, this will return 0.
path
- Path of the int to get.int getInt(String path, int def)
If the int does not exist then the specified default value will
returned regardless of if a default has been identified in the root
Configuration
.
path
- Path of the int to get.def
- The default value to return if the path is not found or is
not an int.boolean isInt(String path)
If the path exists but is not a int, this will return false. If the path does not exist, this will return false. If the path does not exist but a default value has been specified, this will check if that default value is a int and return appropriately.
path
- Path of the int to check.boolean getBoolean(String path)
If the boolean does not exist but a default value has been specified, this will return the default value. If the boolean does not exist and no default value was specified, this will return false.
path
- Path of the boolean to get.boolean getBoolean(String path, boolean def)
If the boolean does not exist then the specified default value will
returned regardless of if a default has been identified in the root
Configuration
.
path
- Path of the boolean to get.def
- The default value to return if the path is not found or is
not a boolean.boolean isBoolean(String path)
If the path exists but is not a boolean, this will return false. If the path does not exist, this will return false. If the path does not exist but a default value has been specified, this will check if that default value is a boolean and return appropriately.
path
- Path of the boolean to check.double getDouble(String path)
If the double does not exist but a default value has been specified, this will return the default value. If the double does not exist and no default value was specified, this will return 0.
path
- Path of the double to get.double getDouble(String path, double def)
If the double does not exist then the specified default value will
returned regardless of if a default has been identified in the root
Configuration
.
path
- Path of the double to get.def
- The default value to return if the path is not found or is
not a double.boolean isDouble(String path)
If the path exists but is not a double, this will return false. If the path does not exist, this will return false. If the path does not exist but a default value has been specified, this will check if that default value is a double and return appropriately.
path
- Path of the double to check.long getLong(String path)
If the long does not exist but a default value has been specified, this will return the default value. If the long does not exist and no default value was specified, this will return 0.
path
- Path of the long to get.long getLong(String path, long def)
If the long does not exist then the specified default value will
returned regardless of if a default has been identified in the root
Configuration
.
path
- Path of the long to get.def
- The default value to return if the path is not found or is
not a long.boolean isLong(String path)
If the path exists but is not a long, this will return false. If the path does not exist, this will return false. If the path does not exist but a default value has been specified, this will check if that default value is a long and return appropriately.
path
- Path of the long to check.List<?> getList(String path)
If the List does not exist but a default value has been specified, this will return the default value. If the List does not exist and no default value was specified, this will return null.
path
- Path of the List to get.List<?> getList(String path, List<?> def)
If the List does not exist then the specified default value will
returned regardless of if a default has been identified in the root
Configuration
.
path
- Path of the List to get.def
- The default value to return if the path is not found or is
not a List.boolean isList(String path)
If the path exists but is not a List, this will return false. If the path does not exist, this will return false. If the path does not exist but a default value has been specified, this will check if that default value is a List and return appropriately.
path
- Path of the List to check.List<String> getStringList(String path)
If the List does not exist but a default value has been specified, this will return the default value. If the List does not exist and no default value was specified, this will return an empty List.
This method will attempt to cast any values into a String if possible, but may miss any values out if they are not compatible.
path
- Path of the List to get.List<Integer> getIntegerList(String path)
If the List does not exist but a default value has been specified, this will return the default value. If the List does not exist and no default value was specified, this will return an empty List.
This method will attempt to cast any values into a Integer if possible, but may miss any values out if they are not compatible.
path
- Path of the List to get.List<Boolean> getBooleanList(String path)
If the List does not exist but a default value has been specified, this will return the default value. If the List does not exist and no default value was specified, this will return an empty List.
This method will attempt to cast any values into a Boolean if possible, but may miss any values out if they are not compatible.
path
- Path of the List to get.List<Double> getDoubleList(String path)
If the List does not exist but a default value has been specified, this will return the default value. If the List does not exist and no default value was specified, this will return an empty List.
This method will attempt to cast any values into a Double if possible, but may miss any values out if they are not compatible.
path
- Path of the List to get.List<Float> getFloatList(String path)
If the List does not exist but a default value has been specified, this will return the default value. If the List does not exist and no default value was specified, this will return an empty List.
This method will attempt to cast any values into a Float if possible, but may miss any values out if they are not compatible.
path
- Path of the List to get.List<Long> getLongList(String path)
If the List does not exist but a default value has been specified, this will return the default value. If the List does not exist and no default value was specified, this will return an empty List.
This method will attempt to cast any values into a Long if possible, but may miss any values out if they are not compatible.
path
- Path of the List to get.List<Byte> getByteList(String path)
If the List does not exist but a default value has been specified, this will return the default value. If the List does not exist and no default value was specified, this will return an empty List.
This method will attempt to cast any values into a Byte if possible, but may miss any values out if they are not compatible.
path
- Path of the List to get.List<Character> getCharacterList(String path)
If the List does not exist but a default value has been specified, this will return the default value. If the List does not exist and no default value was specified, this will return an empty List.
This method will attempt to cast any values into a Character if possible, but may miss any values out if they are not compatible.
path
- Path of the List to get.List<Short> getShortList(String path)
If the List does not exist but a default value has been specified, this will return the default value. If the List does not exist and no default value was specified, this will return an empty List.
This method will attempt to cast any values into a Short if possible, but may miss any values out if they are not compatible.
path
- Path of the List to get.List<Map<?,?>> getMapList(String path)
If the List does not exist but a default value has been specified, this will return the default value. If the List does not exist and no default value was specified, this will return an empty List.
This method will attempt to cast any values into a Map if possible, but may miss any values out if they are not compatible.
path
- Path of the List to get.<T extends ConfigurationSerializable> T getSerializable(String path, Class<T> clazz)
ConfigurationSerializable
object at the given
path.
If the Object does not exist but a default value has been specified, this
will return the default value. If the Object does not exist and no
default value was specified, this will return null.T
- the type of ConfigurationSerializable
path
- the path to the object.clazz
- the type of ConfigurationSerializable
ConfigurationSerializable
object<T extends ConfigurationSerializable> T getSerializable(String path, Class<T> clazz, T def)
ConfigurationSerializable
object at the given
path, returning a default value if not found
If the Object does not exist then the specified default value will
returned regardless of if a default has been identified in the root
Configuration
.T
- the type of ConfigurationSerializable
path
- the path to the object.clazz
- the type of ConfigurationSerializable
def
- the default object to return if the object is not present at
the pathConfigurationSerializable
objectVector getVector(String path)
If the Vector does not exist but a default value has been specified, this will return the default value. If the Vector does not exist and no default value was specified, this will return null.
path
- Path of the Vector to get.Vector getVector(String path, Vector def)
Vector
by path, returning a default value if
not found.
If the Vector does not exist then the specified default value will
returned regardless of if a default has been identified in the root
Configuration
.
path
- Path of the Vector to get.def
- The default value to return if the path is not found or is
not a Vector.boolean isVector(String path)
If the path exists but is not a Vector, this will return false. If the path does not exist, this will return false. If the path does not exist but a default value has been specified, this will check if that default value is a Vector and return appropriately.
path
- Path of the Vector to check.OfflinePlayer getOfflinePlayer(String path)
If the OfflinePlayer does not exist but a default value has been specified, this will return the default value. If the OfflinePlayer does not exist and no default value was specified, this will return null.
path
- Path of the OfflinePlayer to get.OfflinePlayer getOfflinePlayer(String path, OfflinePlayer def)
OfflinePlayer
by path, returning a default
value if not found.
If the OfflinePlayer does not exist then the specified default value
will returned regardless of if a default has been identified in the
root Configuration
.
path
- Path of the OfflinePlayer to get.def
- The default value to return if the path is not found or is
not an OfflinePlayer.boolean isOfflinePlayer(String path)
If the path exists but is not a OfflinePlayer, this will return false. If the path does not exist, this will return false. If the path does not exist but a default value has been specified, this will check if that default value is a OfflinePlayer and return appropriately.
path
- Path of the OfflinePlayer to check.ItemStack getItemStack(String path)
If the ItemStack does not exist but a default value has been specified, this will return the default value. If the ItemStack does not exist and no default value was specified, this will return null.
path
- Path of the ItemStack to get.ItemStack getItemStack(String path, ItemStack def)
ItemStack
by path, returning a default value
if not found.
If the ItemStack does not exist then the specified default value will
returned regardless of if a default has been identified in the root
Configuration
.
path
- Path of the ItemStack to get.def
- The default value to return if the path is not found or is
not an ItemStack.boolean isItemStack(String path)
If the path exists but is not a ItemStack, this will return false. If the path does not exist, this will return false. If the path does not exist but a default value has been specified, this will check if that default value is a ItemStack and return appropriately.
path
- Path of the ItemStack to check.Color getColor(String path)
If the Color does not exist but a default value has been specified, this will return the default value. If the Color does not exist and no default value was specified, this will return null.
path
- Path of the Color to get.Color getColor(String path, Color def)
Color
by path, returning a default value if
not found.
If the Color does not exist then the specified default value will
returned regardless of if a default has been identified in the root
Configuration
.
path
- Path of the Color to get.def
- The default value to return if the path is not found or is
not a Color.boolean isColor(String path)
If the path exists but is not a Color, this will return false. If the path does not exist, this will return false. If the path does not exist but a default value has been specified, this will check if that default value is a Color and return appropriately.
path
- Path of the Color to check.ConfigurationSection getConfigurationSection(String path)
If the ConfigurationSection does not exist but a default value has been specified, this will return the default value. If the ConfigurationSection does not exist and no default value was specified, this will return null.
path
- Path of the ConfigurationSection to get.boolean isConfigurationSection(String path)
If the path exists but is not a ConfigurationSection, this will return false. If the path does not exist, this will return false. If the path does not exist but a default value has been specified, this will check if that default value is a ConfigurationSection and return appropriately.
path
- Path of the ConfigurationSection to check.ConfigurationSection getDefaultSection()
ConfigurationSection
from the default
Configuration
defined in getRoot()
.
If the root contains no defaults, or the defaults doesn't contain a
value for this path, or the value at this path is not a ConfigurationSection
then this will return null.
void addDefault(String path, Object value)
If no source Configuration
was provided as a default
collection, then a new MemoryConfiguration
will be created to
hold the new default value.
If value is null, the value will be removed from the default Configuration source.
If the value as returned by getDefaultSection()
is null, then
this will create a new section at the path, replacing anything that may
have existed there previously.
path
- Path of the value to set.value
- Value to set the default to.IllegalArgumentException
- Thrown if path is null.Copyright © 2021. All rights reserved.