org.bspfsystems.yamlconfiguration.configuration

Class MemorySection

java.lang.Object

org.bspfsystems.yamlconfiguration.configuration.MemorySection

All Implemented Interfaces:

ConfigurationSection

Direct Known Subclasses:

MemoryConfiguration

public class MemorySection
extends Object
implements ConfigurationSection

A type of ConfigurationSection that is stored in memory. Synchronized with the commit on 21-December-2019.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	map

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MemorySection() Creates an empty MemorySection for use as a root Configuration section.
protected	MemorySection(@NotNull ConfigurationSection parent, @NotNull String path) Creates an empty MemorySection with the specified parent and path.

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.
static @NotNull String	createPath(@NotNull ConfigurationSection section, @Nullable String key) Creates a full path to the given ConfigurationSection from its root Configuration.
static @NotNull String	createPath(@NotNull ConfigurationSection section, @Nullable String key, @Nullable ConfigurationSection relative) Creates a relative path to the given ConfigurationSection from the given relative section.
@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 specified values.
@Nullable Object	get(@NotNull String path) Gets the requested Object by path.
@Nullable Object	get(@NotNull String path, @Nullable Object def) Gets the requested Object by path, returning a default value if not found.
boolean	getBoolean(@NotNull String path) Gets the requested boolean by path.
boolean	getBoolean(@NotNull String path, boolean def) Gets the requested boolean by path, returning a default value if not found.
@NotNull List<Boolean>	getBooleanList(@NotNull String path) Gets the requested List of Boolean by path.
byte	getByte(@NotNull String path) Gets the requested byte by path.
byte	getByte(@NotNull String path, byte def) Gets the requested byte by path, returning a default value if not found.
@NotNull List<Byte>	getByteList(@NotNull String path) Gets the requested List of Byte by path.
char	getChar(@NotNull String path) Gets the requested char by path.
char	getChar(@NotNull String path, char def) Gets the requested char by path, returning a default value if not found.
@NotNull List<Character>	getCharList(@NotNull String path) Gets the requested List of Character by path.
@Nullable ConfigurationSection	getConfigurationSection(@NotNull String path) Gets the requested ConfigurationSection by path.
@NotNull String	getCurrentPath() Gets the path of this ConfigurationSection from its root Configuration
protected @Nullable Object	getDefault(@NotNull String path) Gets the default Object for the given path.
@Nullable ConfigurationSection	getDefaultSection() Gets the equivalent ConfigurationSection from the default Configuration defined in ConfigurationSection.getRoot().
double	getDouble(@NotNull String path) Gets the requested double by path.
double	getDouble(@NotNull String path, double def) Gets the requested double by path, returning a default value if not found.
@NotNull List<Double>	getDoubleList(@NotNull String path) Gets the requested List of Double by path.
float	getFloat(@NotNull String path) Gets the requested float by path.
float	getFloat(@NotNull String path, float def) Gets the requested float by path, returning a default value if not found.
@NotNull List<Float>	getFloatList(@NotNull String path) Gets the requested List of Float by path.
int	getInt(@NotNull String path) Gets the requested int by path.
int	getInt(@NotNull String path, int def) Gets the requested int by path, returning a default value if not found.
@NotNull List<Integer>	getIntList(@NotNull String path) Gets the requested List of Integer by path.
@NotNull Set<String>	getKeys(boolean deep) Gets a set containing all keys in this section.
@Nullable List<?>	getList(@NotNull String path) Gets the requested List by path.
@Nullable List<?>	getList(@NotNull String path, @Nullable List<?> def) Gets the requested List by path, returning a default value if not found.
long	getLong(@NotNull String path) Gets the requested long by path.
long	getLong(@NotNull String path, long def) Gets the requested long by path, returning a default value if not found.
@NotNull List<Long>	getLongList(@NotNull String path) Gets the requested List of Long by path.
@NotNull List<Map<?,?>>	getMapList(@NotNull String path) Gets the requested List of Maps by 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 requested object at the given path.
<T> T	getObject(@NotNull String path, @NotNull Class<T> clazz, T def) Gets the requested 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.
@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 requested ConfigurationSerializable object at the given path.
<T extends ConfigurationSerializable> T	getSerializable(@NotNull String path, @NotNull 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.
short	getShort(@NotNull String path) Gets the requested short by path.
short	getShort(@NotNull String path, short def) Gets the requested short by path, returning a default value if not found.
@NotNull List<Short>	getShortList(@NotNull String path) Gets the requested List of Short by path.
@Nullable String	getString(@NotNull String path) Gets the requested String by path.
@Nullable String	getString(@NotNull String path, @Nullable String def) Gets the requested String by path, returning a default value if not found.
@NotNull List<String>	getStringList(@NotNull String path) Gets the requested List of String by path.
@NotNull Map<String,Object>	getValues(boolean deep) Gets a Map containing all keys and their values for this section.
boolean	isBoolean(@NotNull String path) Checks if the specified path is a boolean.
boolean	isByte(@NotNull String path) Checks if the specified path is an byte.
boolean	isChar(@NotNull String path) Checks if the specified path is a char.
boolean	isConfigurationSection(@NotNull String path) Checks if the specified path is a ConfigurationSection.
boolean	isDouble(@NotNull String path) Checks if the specified path is a double.
boolean	isFloat(@NotNull String path) Checks if the specified path is a float.
boolean	isInt(@NotNull String path) Checks if the specified path is an int.
boolean	isList(@NotNull String path) Checks if the specified path is a List.
boolean	isLong(@NotNull String path) Checks if the specified 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 specified path is an short.
boolean	isString(@NotNull String path) Checks if the specified path is a String.
protected void	mapChildrenKeys(@NotNull Set<String> output, @NotNull ConfigurationSection section, boolean deep) Maps the keys of the given child ConfigurationSection.
protected void	mapChildrenValues(@NotNull Map<String,Object> output, @NotNull ConfigurationSection section, boolean deep) Maps the key-value pairs of the given child ConfigurationSection.
void	set(@NotNull String path, @Nullable Object value) Sets the specified path to the given value.
String	toString() Creates a String representation of this MemorySection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

map

protected final Map<String,Object> map

Constructor Detail

MemorySection

protected MemorySection()

Creates an empty MemorySection for use as a root Configuration section.

Note that calling this without being yourself a Configuration will throw an exception!

Throws:

IllegalStateException - Thrown if this is not a Configuration root.

MemorySection

protected MemorySection(@NotNull
                        @NotNull ConfigurationSection parent,
                        @NotNull
                        @NotNull String path)

Creates an empty MemorySection with the specified parent and path.

Parameters:

parent - Parent section that contains this own section.

path - Path that you may access this section from via the root Configuration.

Throws:

IllegalArgumentException - Thrown is parent or path is null, or if parent contains no root Configuration.

Method Detail

getKeys

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

Gets a set containing all keys in this section.

If deep is set to true, then this will contain all the keys within any child ConfigurationSections (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.

Specified by:

getKeys in interface ConfigurationSection

Parameters:

deep - Whether or not to get a deep list, as opposed to a shallow list.

Returns:

Set of keys contained within this ConfigurationSection.

getValues

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

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

If deep is set to true, then this will contain all the keys and values within any child ConfigurationSections (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.

Specified by:

getValues in interface ConfigurationSection

Parameters:

deep - Whether or not to get a deep list, as opposed to a shallow list.

Returns:

Map of keys and values of this section.

getCurrentPath

@NotNull
public @NotNull String getCurrentPath()

Gets the path of this 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 ConfigurationSection.getName().

Specified by:

getCurrentPath in interface ConfigurationSection

Returns:

Path of this section relative to its root

getName

@NotNull
public @NotNull String getName()

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

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

Specified by:

getName in interface ConfigurationSection

Returns:

Name of this section

getRoot

@Nullable
public @Nullable Configuration getRoot()

Gets the root 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.

Specified by:

getRoot in interface ConfigurationSection

Returns:

Root configuration containing this section.

getParent

@Nullable
public @Nullable ConfigurationSection getParent()

Gets the parent 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.

Specified by:

getParent in interface ConfigurationSection

Returns:

Parent section containing this section.

getDefaultSection

@Nullable
public @Nullable ConfigurationSection getDefaultSection()

Gets the equivalent ConfigurationSection from the default Configuration defined in ConfigurationSection.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.

Specified by:

getDefaultSection in interface ConfigurationSection

Returns:

Equivalent section in root configuration

addDefault

public 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 ConfigurationSection.getDefaultSection() is null, then this will create a new section at the path, replacing anything that may have existed there previously.

Specified by:

addDefault in interface ConfigurationSection

Parameters:

path - Path of the value to set.

value - Value to set the default to.

createSection

@NotNull
public @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.

Specified by:

createSection in interface ConfigurationSection

Parameters:

path - Path to create the section at.

Returns:

Newly created section

createSection

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

Creates a 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.

Specified by:

createSection in interface ConfigurationSection

Parameters:

path - Path to create the section at.

map - The values to used.

Returns:

Newly created section

isSet

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

Specified by:

isSet in interface ConfigurationSection

Parameters:

path - Path to check for existence.

Returns:

True if this section contains the requested path, regardless of having a default.

set

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

Sets the specified path to the given 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 Configurations or ConfigurationSections, please use ConfigurationSection.createSection(java.lang.String) for that.

Specified by:

set in interface ConfigurationSection

Parameters:

path - Path of the object to set.

value - New value to set the path to.

contains

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

Specified by:

contains in interface ConfigurationSection

Parameters:

path - Path to check for existence.

Returns:

True if this section contains the requested path, either via default or being set.

contains

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

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

Specified by:

contains in interface ConfigurationSection

Parameters:

path - Path to check for existence.

ignoreDefault - Whether or not to ignore if a default value for the specified path exists.

Returns:

True if this section contains the requested path, or if a default value exist and the boolean parameter for this method is true.

get

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

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

Specified by:

get in interface ConfigurationSection

Parameters:

path - Path of the Object to get.

Returns:

Requested Object.

get

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

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

Specified by:

get in interface ConfigurationSection

Parameters:

path - Path of the Object to get.

def - The default value to return if the path is not found.

Returns:

Requested Object.

isBoolean

public boolean isBoolean(@NotNull
                         @NotNull String path)

Checks if the specified path is a boolean.

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.

Specified by:

isBoolean in interface ConfigurationSection

Parameters:

path - Path of the boolean to check.

Returns:

Whether or not the specified path is a boolean.

getBoolean

public boolean getBoolean(@NotNull
                          @NotNull String path)

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

Specified by:

getBoolean in interface ConfigurationSection

Parameters:

path - Path of the boolean to get.

Returns:

Requested boolean.

getBoolean

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

Gets the requested boolean by path, returning a default value if not found.

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.

Specified by:

getBoolean in interface ConfigurationSection

Parameters:

path - Path of the boolean to get.

def - The default value to return if the path is not found or is not a boolean.

Returns:

Requested boolean.

isByte

public boolean isByte(@NotNull
                      @NotNull String path)

Checks if the specified path is an byte.

If the path exists but is not a byte, 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 byte and return appropriately.

Specified by:

isByte in interface ConfigurationSection

Parameters:

path - Path of the byte to check.

Returns:

Whether or not the specified path is an byte.

getByte

public byte getByte(@NotNull
                    @NotNull String path)

Gets the requested byte by path.

If the byte does not exist but a default value has been specified, this will return the default value. If the byte does not exist and no default value was specified, this will return (byte) 0.

Specified by:

getByte in interface ConfigurationSection

Parameters:

path - Path of the byte to get.

Returns:

Requested byte.

getByte

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

Gets the requested byte by path, returning a default value if not found.

If the byte does not exist then the specified default value will returned regardless of if a default has been identified in the root Configuration.

Specified by:

getByte in interface ConfigurationSection

Parameters:

path - Path of the byte to get.

def - The default value to return if the path is not found or is not an byte.

Returns:

Requested byte.

isShort

public boolean isShort(@NotNull
                       @NotNull String path)

Checks if the specified path is an short.

If the path exists but is not a short, 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 short and return appropriately.

Specified by:

isShort in interface ConfigurationSection

Parameters:

path - Path of the short to check.

Returns:

Whether or not the specified path is an short.

getShort

public short getShort(@NotNull
                      @NotNull String path)

Gets the requested short by path.

If the short does not exist but a default value has been specified, this will return the default value. If the short does not exist and no default value was specified, this will return (short) 0.

Specified by:

getShort in interface ConfigurationSection

Parameters:

path - Path of the short to get.

Returns:

Requested short.

getShort

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

Gets the requested short by path, returning a default value if not found.

If the short does not exist then the specified default value will returned regardless of if a default has been identified in the root Configuration.

Specified by:

getShort in interface ConfigurationSection

Parameters:

path - Path of the short to get.

def - The default value to return if the path is not found or is not an short.

Returns:

Requested short.

isInt

public boolean isInt(@NotNull
                     @NotNull String path)

Checks if the specified path is an int.

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.

Specified by:

isInt in interface ConfigurationSection

Parameters:

path - Path of the int to check.

Returns:

Whether or not the specified path is an int.

getInt

public int getInt(@NotNull
                  @NotNull String path)

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

Specified by:

getInt in interface ConfigurationSection

Parameters:

path - Path of the int to get.

Returns:

Requested int.

getInt

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

Gets the requested int by path, returning a default value if not found.

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.

Specified by:

getInt in interface ConfigurationSection

Parameters:

path - Path of the int to get.

def - The default value to return if the path is not found or is not an int.

Returns:

Requested int.

isLong

public boolean isLong(@NotNull
                      @NotNull String path)

Checks if the specified path is a long.

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.

Specified by:

isLong in interface ConfigurationSection

Parameters:

path - Path of the long to check.

Returns:

Whether or not the specified path is a long.

getLong

public long getLong(@NotNull
                    @NotNull String path)

Gets the requested long by 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 0L.

Specified by:

getLong in interface ConfigurationSection

Parameters:

path - Path of the long to get.

Returns:

Requested long.

getLong

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

Gets the requested long by path, returning a default value if not found.

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.

Specified by:

getLong in interface ConfigurationSection

Parameters:

path - Path of the long to get.

def - The default value to return if the path is not found or is not a long.

Returns:

Requested long.

isFloat

public boolean isFloat(@NotNull
                       @NotNull String path)

Checks if the specified path is a float.

If the path exists but is not a float, 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 float and return appropriately.

Specified by:

isFloat in interface ConfigurationSection

Parameters:

path - Path of the float to check.

Returns:

Whether or not the specified path is a float.

getFloat

public float getFloat(@NotNull
                      @NotNull String path)

Gets the requested float by path.

If the float does not exist but a default value has been specified, this will return the default value. If the float does not exist and no default value was specified, this will return 0.0F.

Specified by:

getFloat in interface ConfigurationSection

Parameters:

path - Path of the float to get.

Returns:

Requested float.

getFloat

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

Gets the requested float by path, returning a default value if not found.

If the float does not exist then the specified default value will returned regardless of if a default has been identified in the root Configuration.

Specified by:

getFloat in interface ConfigurationSection

Parameters:

path - Path of the float to get.

def - The default value to return if the path is not found or is not a float.

Returns:

Requested float.

isDouble

public boolean isDouble(@NotNull
                        @NotNull String path)

Checks if the specified path is a double.

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.

Specified by:

isDouble in interface ConfigurationSection

Parameters:

path - Path of the double to check.

Returns:

Whether or not the specified path is a double.

getDouble

public double getDouble(@NotNull
                        @NotNull String path)

Gets the requested double by 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.0D.

Specified by:

getDouble in interface ConfigurationSection

Parameters:

path - Path of the double to get.

Returns:

Requested double.

getDouble

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

Gets the requested double by path, returning a default value if not found.

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.

Specified by:

getDouble in interface ConfigurationSection

Parameters:

path - Path of the double to get.

def - The default value to return if the path is not found or is not a double.

Returns:

Requested double.

isChar

public boolean isChar(@NotNull
                      @NotNull String path)

Checks if the specified path is a char.

If the path exists but is not a char, 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 char and return appropriately.

Specified by:

isChar in interface ConfigurationSection

Parameters:

path - Path of the double to check.

Returns:

Whether or not the specified path is a char.

getChar

public char getChar(@NotNull
                    @NotNull String path)

Gets the requested char by path.

If the char does not exist but a default value has been specified, this will return the default value. If the char does not exist and no default value was specified, this will return .

Specified by:

getChar in interface ConfigurationSection

Parameters:

path - Path of the char to get.

Returns:

Requested char.

getChar

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

Gets the requested char by path, returning a default value if not found.

If the char does not exist then the specified default value will returned regardless of if a default has been identified in the root Configuration.

Specified by:

getChar in interface ConfigurationSection

Parameters:

path - Path of the char to get.

def - The default value to return if the path is not found or is not a char.

Returns:

Requested char.

isString

public boolean isString(@NotNull
                        @NotNull String path)

Checks if the specified path is a String.

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.

Specified by:

isString in interface ConfigurationSection

Parameters:

path - Path of the String to check.

Returns:

Whether or not the specified path is a String.

getString

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

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

Specified by:

getString in interface ConfigurationSection

Parameters:

path - Path of the String to get.

Returns:

Requested String.

getString

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

Gets the requested String by path, returning a default value if not found.

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.

Specified by:

getString in interface ConfigurationSection

Parameters:

path - Path of the String to get.

def - The default value to return if the path is not found or is not a String.

Returns:

Requested String.

isList

public boolean isList(@NotNull
                      @NotNull String path)

Checks if the specified path is a List.

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.

Specified by:

isList in interface ConfigurationSection

Parameters:

path - Path of the List to check.

Returns:

Whether or not the specified path is a List.

getList

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

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

Specified by:

getList in interface ConfigurationSection

Parameters:

path - Path of the List to get.

Returns:

Requested List.

getList

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

Gets the requested List by path, returning a default value if not found.

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.

Specified by:

getList in interface ConfigurationSection

Parameters:

path - Path of the List to get.

def - The default value to return if the path is not found or is not a List.

Returns:

Requested List.

isConfigurationSection

public boolean isConfigurationSection(@NotNull
                                      @NotNull String path)

Checks if the specified path is a ConfigurationSection.

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.

Specified by:

isConfigurationSection in interface ConfigurationSection

Parameters:

path - Path of the ConfigurationSection to check.

Returns:

Whether or not the specified path is a ConfigurationSection.

getConfigurationSection

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

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

Specified by:

getConfigurationSection in interface ConfigurationSection

Parameters:

path - Path of the ConfigurationSection to get.

Returns:

Requested ConfigurationSection.

getObject

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

Gets the requested 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. Note: For example #getObject(path, String.class) is not equivalent to #getString(path) because #getString(path) converts internally all Objects to Strings. However, #getObject(path, Boolean.class) is equivalent to #getBoolean(path) for example.

Specified by:

getObject in interface ConfigurationSection

Type Parameters:

T - the type of the requested object

Parameters:

path - the path to the object.

clazz - the type of the requested object

Returns:

Requested object

getObject

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

Gets the requested 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. Note: For example #getObject(path, String.class, def) is not equivalent to #getString(path, def) because #getString(path, def) converts internally all Objects to Strings. However, #getObject(path, Boolean.class, def) is equivalent to #getBoolean(path, def) for example.

Specified by:

getObject in interface ConfigurationSection

Type Parameters:

T - the type of the requested object

Parameters:

path - the path to the object.

clazz - the type of the requested object

def - the default object to return if the object is not present at the path

Returns:

Requested object

getSerializable

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

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

Specified by:

getSerializable in interface ConfigurationSection

Type Parameters:

T - the type of ConfigurationSerializable

Parameters:

path - the path to the object.

clazz - the type of ConfigurationSerializable

Returns:

Requested ConfigurationSerializable object

getSerializable

@Contract(value="_, _, !null -> !null")
 @Nullable
public <T extends ConfigurationSerializable> T getSerializable(@NotNull
                                                                                                                  @NotNull String path,
                                                                                                                  @NotNull
                                                                                                                  @NotNull Class<T> clazz,
                                                                                                                  @Nullable
                                                                                                                  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.

Specified by:

getSerializable in interface ConfigurationSection

Type Parameters:

T - the type of ConfigurationSerializable

Parameters:

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 path

Returns:

Requested ConfigurationSerializable object

getBooleanList

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

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

Specified by:

getBooleanList in interface ConfigurationSection

Parameters:

path - Path of the List to get.

Returns:

Requested List of Boolean.

getByteList

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

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

Specified by:

getByteList in interface ConfigurationSection

Parameters:

path - Path of the List to get.

Returns:

Requested List of Byte.

getShortList

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

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

Specified by:

getShortList in interface ConfigurationSection

Parameters:

path - Path of the List to get.

Returns:

Requested List of Short.

getIntList

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

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

Specified by:

getIntList in interface ConfigurationSection

Parameters:

path - Path of the List to get.

Returns:

Requested List of Integer.

getLongList

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

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

Specified by:

getLongList in interface ConfigurationSection

Parameters:

path - Path of the List to get.

Returns:

Requested List of Long.

getFloatList

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

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

Specified by:

getFloatList in interface ConfigurationSection

Parameters:

path - Path of the List to get.

Returns:

Requested List of Float.

getDoubleList

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

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

Specified by:

getDoubleList in interface ConfigurationSection

Parameters:

path - Path of the List to get.

Returns:

Requested List of Double.

getCharList

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

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

Specified by:

getCharList in interface ConfigurationSection

Parameters:

path - Path of the List to get.

Returns:

Requested List of Character.

getStringList

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

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

Specified by:

getStringList in interface ConfigurationSection

Parameters:

path - Path of the List to get.

Returns:

Requested List of String.

getMapList

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

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

Specified by:

getMapList in interface ConfigurationSection

Parameters:

path - Path of the List to get.

Returns:

Requested List of Maps.

getDefault

@Nullable
protected @Nullable Object getDefault(@NotNull
                                                @NotNull String path)

Gets the default Object for the given path.

Parameters:

path - The path to retrieve the default Object from.

Returns:

The default Object, or null if the default is null.

mapChildrenKeys

protected void mapChildrenKeys(@NotNull
                               @NotNull Set<String> output,
                               @NotNull
                               @NotNull ConfigurationSection section,
                               boolean deep)

Maps the keys of the given child ConfigurationSection.

Parameters:

output - The mapped keys.

section - The child ConfigurationSection.

deep - If true, any children of the given ConfigurationSection will have their keys mapped. If false, only the given ConfigurationSection's keys will be mapped.

mapChildrenValues

protected void mapChildrenValues(@NotNull
                                 @NotNull Map<String,Object> output,
                                 @NotNull
                                 @NotNull ConfigurationSection section,
                                 boolean deep)

Maps the key-value pairs of the given child ConfigurationSection.

Parameters:

output - The mapped key-value pairs.

section - The child ConfigurationSection.

deep - If true, any children of the given ConfigurationSection will have their key-value pairs mapped. If false, only the given ConfigurationSection's key-value pairs will be mapped.

toString

public String toString()

Creates a String representation of this MemorySection.

Overrides:

toString in class Object

Returns:

A String representation of this MemorySection.

createPath

@NotNull
public static @NotNull String createPath(@NotNull
                                                  @NotNull ConfigurationSection section,
                                                  @Nullable
                                                  @Nullable String key)

Creates a full path to the given ConfigurationSection from its root Configuration.

You may use this method for any given ConfigurationSection, not only MemorySection.

Parameters:

section - Section to create a path for.

key - Name of the specified section.

Returns:

Full path of the section from its root.

createPath

@NotNull
public static @NotNull String createPath(@NotNull
                                                  @NotNull ConfigurationSection section,
                                                  @Nullable
                                                  @Nullable String key,
                                                  @Nullable
                                                  @Nullable ConfigurationSection relative)

Creates a relative path to the given ConfigurationSection from the given relative section.

You may use this method for any given ConfigurationSection, not only MemorySection.

Parameters:

section - Section to create a path for.

key - Name of the specified section.

relative - Section to create the path relative to.

Returns:

Full path of the section from its root.