org.bspfsystems.yamlconfiguration.configuration

Interface ConfigurationSection

All Known Subinterfaces:

Configuration

All Known Implementing Classes:

FileConfiguration, MemoryConfiguration, MemorySection, YamlConfiguration

public interface ConfigurationSection

Represents a section of a Configuration. Synchronized with the commit on 20-December-2021.

Method Summary

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.
boolean	contains(@NotNull String path) Checks if this ConfigurationSection contains the given path.
boolean	contains(@NotNull String path, boolean ignoreDefault) Checks if this ConfigurationSection contains the given path.
@NotNull ConfigurationSection	createSection(@NotNull String path) Creates an empty ConfigurationSection at the specified path.
@NotNull ConfigurationSection	createSection(@NotNull String path, @NotNull Map<?,?> map) Creates a ConfigurationSection at the specified path, with the specified values.
@Nullable Object	get(@NotNull String path) Gets the Object at the given path.
@Nullable Object	get(@NotNull String path, @Nullable Object def) Gets the Object at the given path, returning the given default value if none has 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 Characters at the given path.
@NotNull List<String>	getComments(@NotNull String path) Gets the requested comment List by path.
@Nullable ConfigurationSection	getConfigurationSection(@NotNull String path) Gets the ConfigurationSection value at the given path.
@Nullable String	getCurrentPath() Gets the path of this ConfigurationSection from its root Configuration
@Nullable ConfigurationSection	getDefaultSection() Gets the equivalent ConfigurationSection from the default Configuration defined in 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 List<String>	getInLineComments(@NotNull String path) Gets the requested inline comment List 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 Integers at the given path.
@NotNull Set<String>	getKeys(boolean deep) Gets a Set containing all keys in this ConfigurationSection.
@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 ConfigurationSection, in the path.
<T> T	getObject(@NotNull String path, @NotNull Class<T> clazz) Gets the Object value of type T at the given path.
<T> T	getObject(@NotNull String path, @NotNull Class<T> clazz, T def) Gets the Object value of type T at the given path.
@Nullable ConfigurationSection	getParent() Gets the parent ConfigurationSection that directly contains this ConfigurationSection.
@Nullable Configuration	getRoot() Gets the root Configuration that contains this ConfigurationSection
<T extends ConfigurationSerializable> T	getSerializable(@NotNull String path, @NotNull Class<T> clazz) Gets the ConfigurationSerializable value of type T at the given path.
<T extends ConfigurationSerializable> T	getSerializable(@NotNull String path, @NotNull Class<T> clazz, T def) Gets the ConfigurationSerializable 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 Map<String,Object>	getValues(boolean deep) Gets a Map containing all keys and their values for this ConfigurationSection.
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 ConfigurationSection.
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 List.
boolean	isLong(@NotNull String path) Checks if the value at the given path is a long.
boolean	isSet(@NotNull String path) Checks if this ConfigurationSection 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 specified path to the given value.
void	setComments(@NotNull String path, @Nullable List<String> comments) Sets the comment List at the specified path.
void	setInLineComments(@NotNull String path, @Nullable List<String> inLineComments) Sets the inline comment List at the specified path.

Method Detail

getKeys

@NotNull
@NotNull Set<String> getKeys(boolean deep)

Gets a Set containing all keys in this ConfigurationSection.

If deep is set to true, then the Set will contain all keys within any child ConfigurationSection(s) (and their respective children, etc.) contained within this ConfigurationSection. The keys will be in a valid path notation for use.

If deep is set to false, then the Set will contain only the keys of any direct children, and not any of those children's children.

Parameters:

deep - true if the Set is to contain the keys of the children ConfigurationSection(s) of this ConfigurationSection, false otherwise.

Returns:

The Set of keys contained within this ConfigurationSection.

getValues

@NotNull
@NotNull Map<String,Object> getValues(boolean deep)

Gets a Map containing all keys and their values for this ConfigurationSection.

If deep is set to true, then the Map will contain all keys and their respective values within any child ConfigurationSection(s) (and their respective children, etc.) contained in this ConfigurationSection. The keys will be in a valid path notation for use.

If deep is set to false, then the Map will contain only the keys and respective values of any direct children, and not any of those children's children.

Parameters:

deep - true if the Map is to contain the keys and respective values of the children ConfigurationSection(s) of this ConfigurationSection, false otherwise.

Returns:

A Map of keys and their respective values contained within this ConfigurationSection.

getCurrentPath

@Nullable
@Nullable String getCurrentPath()

Gets the path of this ConfigurationSection from its root Configuration

For any Configuration themselves, this will return an empty String.

If this ConfigurationSection 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().

Returns:

Path of this ConfigurationSection relative to its root.

getName

@NotNull
@NotNull String getName()

Gets the name of this individual ConfigurationSection, in the path.

This will always be the final part of getCurrentPath(), unless this ConfigurationSection is orphaned.

Returns:

Name of this ConfigurationSection.

getRoot

@Nullable
@Nullable Configuration getRoot()

Gets the root Configuration that contains this ConfigurationSection

For any Configuration themselves, this will return its own object.

If this ConfigurationSection is no longer contained within its root for any reason, such as being replaced with a different value, this may return null.

Returns:

The root Configuration containing this ConfigurationSection.

getParent

@Nullable
@Nullable ConfigurationSection getParent()

Gets the parent ConfigurationSection that directly contains this ConfigurationSection.

For any Configuration themselves, this will return null.

If this ConfigurationSection is no longer contained within its parent for any reason, such as being replaced with a different value, this may return null.

Returns:

The parent ConfigurationSection containing this ConfigurationSection.

getDefaultSection

@Nullable
@Nullable ConfigurationSection getDefaultSection()

Gets the equivalent ConfigurationSection from the default Configuration defined in getRoot().

If the root contains no defaults, or the defaults do not contain a value for this path, or the value at this path is not a ConfigurationSection, then this will return null.

Returns:

The equivalent ConfigurationSection in the default ConfigurationSection.

addDefault

void addDefault(@NotNull
                @NotNull String path,
                @Nullable
                @Nullable Object value)

Sets the default value in the root at the given path as provided.

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 ConfigurationSection at the path, replacing anything that may have existed there previously.

Parameters:

path - The path of the value to set.

value - The value to set the default to.

getComments

@NotNull
@NotNull List<String> getComments(@NotNull
                                           @NotNull String path)

Gets the requested comment List by 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.

Parameters:

path - Path of the comments to get.

Returns:

An unmodifiable List of the requested comments, where every entry represents one line.

getInLineComments

@NotNull
@NotNull List<String> getInLineComments(@NotNull
                                                 @NotNull String path)

Gets the requested inline comment List by 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 ine.

Parameters:

path - Path of the comments to get.

Returns:

An unmodifiable List of the requested comments, where every entry represents one line.

setComments

void setComments(@NotNull
                 @NotNull String path,
                 @Nullable
                 @Nullable List<String> comments)

Sets the comment List at the specified path.

If value is null, the comments will be removed. A null entry is an empty line and an empty String entry is an empty comment line. If the path does not exist, no comments will be set. Any existing comments will be replaced, regardless of what the new comments are.

Some implementations may have limitations on what persists. See their individual javadocs for details.

Parameters:

path - Path of the comments to set.

comments - New comments to set at the path, every entry represents one line.

setInLineComments

void setInLineComments(@NotNull
                       @NotNull String path,
                       @Nullable
                       @Nullable List<String> inLineComments)

Sets the inline comment List at the specified path.

If value is null, the comments will be removed. A null entry is an empty line and an empty String entry is an empty comment line. If the path does not exist, no comment will be set. Any existing comments will be replaced, regardless of what the new comments are.

Some implementations may have limitations on what persists. See their individual javadocs for details.

Parameters:

path - Path of the comments to set.

inLineComments - New comments to set at the path, every entry represents one line.

createSection

@NotNull
@NotNull ConfigurationSection createSection(@NotNull
                                                     @NotNull String path)

Creates an empty 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.

Parameters:

path - The path to create the ConfigurationSection at.

Returns:

The newly-created ConfigurationSection.

createSection

@NotNull
@NotNull ConfigurationSection createSection(@NotNull
                                                     @NotNull String path,
                                                     @NotNull
                                                     @NotNull Map<?,?> map)

Creates a ConfigurationSection at the specified path, with the 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.

Parameters:

path - The path to create the ConfigurationSection at.

map - The key-value pairs to place in the ConfigurationSection.

Returns:

The newly-created ConfigurationSection.

isSet

boolean isSet(@NotNull
              @NotNull String path)

Checks if this 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.

Parameters:

path - The path to check for existence.

Returns:

true if this ConfigurationSection contains the requested path, regardless of having a default. false otherwise

set

void set(@NotNull
         @NotNull String path,
         @Nullable
         @Nullable Object value)

Sets the specified path to the given value.

If the 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 a Configuration or a ConfigurationSection, please use createSection(String) for that.

Parameters:

path - The path to the given value.

value - The (new) value stored at the given path.

contains

boolean contains(@NotNull
                 @NotNull String path)

Checks if this 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.

Parameters:

path - The path to check for existence.

Returns:

true if this ConfigurationSection contains the requested path, either via default or being set. false otherwise.

contains

boolean contains(@NotNull
                 @NotNull String path,
                 boolean ignoreDefault)

Checks if this ConfigurationSection contains the given path.

If true is specified for ignoreDefaults, then this will return true only if a value has been set for the given path.

If false is specified 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.

Parameters:

path - 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.

Returns:

true if this ConfigurationSection contains a value at the requested path, or if a default value has been set and ignoreDefaults is false. false otherwise.

get

@Nullable
@Nullable Object get(@NotNull
                               @NotNull String path)

Gets the Object at the given 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.

Parameters:

path - The path of the Object to retrieve.

Returns:

The requested Object.

get

@Contract(value="_, !null -> !null")
 @Nullable
@Nullable Object get(@NotNull
                                                                     @NotNull String path,
                                                                     @Nullable
                                                                     @Nullable Object def)

Gets the Object at the given path, returning the given default value if none has been set.

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.

Parameters:

path - The path of the Object to retrieve.

def - The Object to use as a default value.

Returns:

The requested Object.

isBoolean

boolean isBoolean(@NotNull
                  @NotNull String path)

Checks if the value at the given path is a boolean.

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 appropriately.

Parameters:

path - The path of the boolean to check.

Returns:

true if a boolean value exists, or if there is no value, a default has been set, and it is a boolean. false otherwise.

getBoolean

boolean getBoolean(@NotNull
                   @NotNull String path)

Gets the boolean value at the given 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.

Parameters:

path - The path of the boolean to retrieve.

Returns:

The requested boolean.

getBoolean

boolean getBoolean(@NotNull
                   @NotNull String path,
                   boolean def)

Gets the boolean value at the given path.

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.

Parameters:

path - The path of the boolean to retrieve.

def - The boolean to use as the default.

Returns:

The requested boolean.

isByte

boolean isByte(@NotNull
               @NotNull String path)

Checks if the value at the given path is a byte.

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.

Parameters:

path - The path of the byte to check.

Returns:

true if a byte value exists, or if there is no value, a default has been set, and it is a byte. false otherwise.

getByte

byte getByte(@NotNull
             @NotNull String path)

Gets the byte value at the given 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.

Parameters:

path - The path of the byte to retrieve.

Returns:

The requested byte.

getByte

byte getByte(@NotNull
             @NotNull String path,
             byte def)

Gets the byte value at the given path.

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.

Parameters:

path - The path of the byte to retrieve.

def - The byte to use as the default.

Returns:

The requested byte.

isShort

boolean isShort(@NotNull
                @NotNull String path)

Checks if the value at the given path is a short.

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.

Parameters:

path - The path of the short to check.

Returns:

true if a short value exists, or if there is no value, a default has been set, and it is a short. false otherwise.

getShort

short getShort(@NotNull
               @NotNull String path)

Gets the short value at the given 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.

Parameters:

path - The path of the short to retrieve.

Returns:

The requested short.

getShort

short getShort(@NotNull
               @NotNull String path,
               short def)

Gets the short value at the given path.

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.

Parameters:

path - The path of the short to retrieve.

def - The short to use as the default.

Returns:

The requested short.

isInt

boolean isInt(@NotNull
              @NotNull String path)

Checks if the value at the given path is an int.

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.

Parameters:

path - The path of the int to check.

Returns:

true if an int value exists, or if there is no value, a default has been set, and it is an int. false otherwise.

getInt

int getInt(@NotNull
           @NotNull String path)

Gets the int value at the given 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.

Parameters:

path - The path of the int to retrieve.

Returns:

The requested int.

getInt

int getInt(@NotNull
           @NotNull String path,
           int def)

Gets the int value at the given path.

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.

Parameters:

path - The path of the int to retrieve.

def - The int to use as the default.

Returns:

The requested int.

isLong

boolean isLong(@NotNull
               @NotNull String path)

Checks if the value at the given path is a long.

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.

Parameters:

path - The path of the long to check.

Returns:

true if a long value exists, or if there is no value, a default has been set, and it is a long. false otherwise.

getLong

long getLong(@NotNull
             @NotNull String path)

Gets the long value at the given 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.

Parameters:

path - The path of the long to retrieve.

Returns:

The requested long.

getLong

long getLong(@NotNull
             @NotNull String path,
             long def)

Gets the long value at the given path.

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.

Parameters:

path - The path of the long to retrieve.

def - The long to use as the default.

Returns:

The requested long.

isFloat

boolean isFloat(@NotNull
                @NotNull String path)

Checks if the value at the given path is a float.

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.

Parameters:

path - The path of the float to check.

Returns:

true if a float value exists, or if there is no value, a default has been set, and it is a float. false otherwise.

getFloat

float getFloat(@NotNull
               @NotNull String path)

Gets the float value at the given 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.

Parameters:

path - The path of the float to retrieve.

Returns:

The requested float.

getFloat

float getFloat(@NotNull
               @NotNull String path,
               float def)

Gets the float value at the given path.

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.

Parameters:

path - The path of the float to retrieve.

def - The float to use as the default.

Returns:

The requested float.

isDouble

boolean isDouble(@NotNull
                 @NotNull String path)

Checks if the value at the given path is a double.

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.

Parameters:

path - The path of the double to check.

Returns:

true if a double value exists, or if there is no value, a default has been set, and it is a double. false otherwise.

getDouble

double getDouble(@NotNull
                 @NotNull String path)

Gets the double value at the given 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.

Parameters:

path - The path of the double to retrieve.

Returns:

The requested double.

getDouble

double getDouble(@NotNull
                 @NotNull String path,
                 double def)

Gets the double value at the given path.

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.

Parameters:

path - The path of the double to retrieve.

def - The double to use as the default.

Returns:

The requested double.

isChar

boolean isChar(@NotNull
               @NotNull String path)

Checks if the value at the given path is a char.

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.

Parameters:

path - The path of the char to check.

Returns:

true if a char value exists, or if there is no value, a default has been set, and it is a char. false otherwise.

getChar

char getChar(@NotNull
             @NotNull String path)

Gets the char value at the given 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.

Parameters:

path - The path of the char to retrieve.

Returns:

The requested char.

getChar

char getChar(@NotNull
             @NotNull String path,
             char def)

Gets the char value at the given path.

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.

Parameters:

path - The path of the char to retrieve.

def - The char to use as the default.

Returns:

The requested char.

isString

boolean isString(@NotNull
                 @NotNull String path)

Checks if the value at the given path is a String.

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.

Parameters:

path - The path of the String to check.

Returns:

true if a String value exists, or if there is no value, a default has been set, and it is a String. false otherwise.

getString

@Nullable
@Nullable String getString(@NotNull
                                     @NotNull String path)

Gets the String value at the given 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.

Parameters:

path - The path of the String to retrieve.

Returns:

The requested String.

getString

@Contract(value="_, !null -> !null")
 @Nullable
@Nullable String getString(@NotNull
                                                                           @NotNull String path,
                                                                           @Nullable
                                                                           @Nullable String def)

Gets the String value at the given path.

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.

Parameters:

path - The path of the String to retrieve.

def - The String to use as the default.

Returns:

The requested String.

isList

boolean isList(@NotNull
               @NotNull String path)

Checks if the value at the given path is a List.

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.

Parameters:

path - The path of the List to check.

Returns:

true if a List value exists, or if there is no value, a default has been set, and it is a List. false otherwise.

getList

@Nullable
@Nullable List<?> getList(@NotNull
                                    @NotNull String path)

Gets the List value at the given 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.

Parameters:

path - The path of the List to retrieve.

Returns:

The requested List.

getList

@Contract(value="_, !null -> !null")
 @Nullable
@Nullable List<?> getList(@NotNull
                                                                          @NotNull String path,
                                                                          @Nullable
                                                                          @Nullable List<?> def)

Gets the List value at the given path.

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.

Parameters:

path - The path of the List to retrieve.

def - The List to use as the default.

Returns:

The requested List.

isConfigurationSection

boolean isConfigurationSection(@NotNull
                               @NotNull String path)

Checks if the value at the given path is a ConfigurationSection.

If the value exists at the given path but is not a ConfigurationSection, 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.

Parameters:

path - The path of the ConfigurationSection to check.

Returns:

true if a ConfigurationSection value exists, or if there is no value, a default has been set, and it is a ConfigurationSection. false otherwise.

getConfigurationSection

@Nullable
@Nullable ConfigurationSection getConfigurationSection(@NotNull
                                                                 @NotNull String path)

Gets the ConfigurationSection value at the given path.

If the value exists at the given path but is not a ConfigurationSection, 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.

Parameters:

path - The path of the ConfigurationSection to retrieve.

Returns:

The requested ConfigurationSection.

getObject

@Nullable
<T> T getObject(@NotNull
                          @NotNull String path,
                          @NotNull
                          @NotNull Class<T> clazz)

Gets the Object value of type T at the given path.

If the value exists at the given path but is not a Object 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 getString(String), as the latter internally converts all non-Strings to Strings, whereas this method will only give the requested Object 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.

Type Parameters:

T - The type of the requested Object.

Parameters:

path - The path of the Object of type T to retrieve.

clazz - The Class of type T of the requested Object.

Returns:

The requested Object of type T.

getObject

@Contract(value="_, _, !null -> !null")
 @Nullable
<T> T getObject(@NotNull
                                                                   @NotNull String path,
                                                                   @NotNull
                                                                   @NotNull Class<T> clazz,
                                                                   @Nullable
                                                                   T def)

Gets the Object value of type T at the given path.

If the value exists at the given path but is not a Object 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.

Note: Using this method to get a String is not the same as getString(String, String), as the latter internally converts all non-Strings to Strings, whereas this method will only give the requested Object 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.

Type Parameters:

T - The type of the requested Object.

Parameters:

path - The path of the Object value of type T to retrieve.

clazz - The Class of type T of the requested Object.

def - The Object value of type T to use as the default.

Returns:

The requested Object value of type T.

getSerializable

@Nullable
<T extends ConfigurationSerializable> T getSerializable(@NotNull
                                                                  @NotNull String path,
                                                                  @NotNull
                                                                  @NotNull Class<T> clazz)

Gets the ConfigurationSerializable value of type T at the given path.

If the value exists at the given path but is not a ConfigurationSerializable value 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.

Type Parameters:

T - The type of the requested ConfigurationSerializable.

Parameters:

path - The path of the ConfigurationSerializable value of type T to retrieve.

clazz - The Class of type T of the requested ConfigurationSerializable.

Returns:

The requested ConfigurationSerializable value of type T.

getSerializable

@Contract(value="_, _, !null -> !null")
 @Nullable
<T extends ConfigurationSerializable> T getSerializable(@NotNull
                                                                                                           @NotNull String path,
                                                                                                           @NotNull
                                                                                                           @NotNull Class<T> clazz,
                                                                                                           @Nullable
                                                                                                           T def)

Gets the ConfigurationSerializable value of type T value at the given path.

If the value exists at the given path but is not a ConfigurationSerializable 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.

Type Parameters:

T - The type of the requested ConfigurationSerializable.

Parameters:

path - The path of the ConfigurationSerializable value of type T to retrieve.

clazz - The Class of type T of the requested ConfigurationSerializable.

def - The ConfigurationSerializable value of type T to use as the default.

Returns:

The requested ConfigurationSerializable value of type T.

getBooleanList

@NotNull
@NotNull List<Boolean> getBooleanList(@NotNull
                                               @NotNull String path)

Gets the List of Booleans at the given 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.

Parameters:

path - The path of the List of Booleans to retrieve.

Returns:

The requested List of Booleans.

getByteList

@NotNull
@NotNull List<Byte> getByteList(@NotNull
                                         @NotNull String path)

Gets the List of Bytes at the given 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.

Parameters:

path - The path of the List of Bytes to retrieve.

Returns:

The requested List of Bytes.

getShortList

@NotNull
@NotNull List<Short> getShortList(@NotNull
                                           @NotNull String path)

Gets the List of Shorts at the given 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.

Parameters:

path - The path of the List of Shorts to retrieve.

Returns:

The requested List of Shorts.

getIntList

@NotNull
@NotNull List<Integer> getIntList(@NotNull
                                           @NotNull String path)

Gets the List of Integers at the given path.

If the value exists at the given path but is not a List of Integers, this will attempt to cast any values into a Integer, 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.

Parameters:

path - The path of the List of Integers to retrieve.

Returns:

The requested List of Integers.

getLongList

@NotNull
@NotNull List<Long> getLongList(@NotNull
                                         @NotNull String path)

Gets the List of Longs at the given 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.

Parameters:

path - The path of the List of Longs to retrieve.

Returns:

The requested List of Longs.

getFloatList

@NotNull
@NotNull List<Float> getFloatList(@NotNull
                                           @NotNull String path)

Gets the List of Floats at the given 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.

Parameters:

path - The path of the List of Floats to retrieve.

Returns:

The requested List of Floats.

getDoubleList

@NotNull
@NotNull List<Double> getDoubleList(@NotNull
                                             @NotNull String path)

Gets the List of Doubles at the given 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.

Parameters:

path - The path of the List of Doubles to retrieve.

Returns:

The requested List of Doubles.

getCharList

@NotNull
@NotNull List<Character> getCharList(@NotNull
                                              @NotNull String path)

Gets the List of Characters at the given path.

If the value exists at the given path but is not a List of Characters, this will attempt to cast any values into a Character, 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.

Parameters:

path - The path of the List of Characters to retrieve.

Returns:

The requested List of Characters.

getStringList

@NotNull
@NotNull List<String> getStringList(@NotNull
                                             @NotNull String path)

Gets the List of Strings at the given 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.

Parameters:

path - The path of the List of Strings to retrieve.

Returns:

The requested List of Strings.

getMapList

@NotNull
@NotNull List<Map<?,?>> getMapList(@NotNull
                                            @NotNull String path)

Gets the List of Maps at the given 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.

Parameters:

path - The path of the List of Maps to retrieve.

Returns:

The requested List of Maps.