ConfigurationSection (Simple-YAML 1.8.4 API)

All Known Subinterfaces:

Configuration

All Known Implementing Classes:

FileConfiguration, MemoryConfiguration, MemorySection, YamlConfiguration, YamlFile
```
public interface ConfigurationSection
```
Represents a section of a Configuration

Author:

Bukkit

See Also:

Bukkit Source

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`addDefault(String path, Object value)` Sets the default value in the root at the given path as provided.
`boolean`	`contains(String path)` Checks if this `ConfigurationSection` contains the given path.
`ConfigurationSection`	`createSection(String path)` Creates an empty `ConfigurationSection` at the specified path.
`ConfigurationSection`	`createSection(String path, Map<?,?> map)` Creates a `ConfigurationSection` at the specified path, with specified values.
`Object`	`get(String path)` Gets the requested Object by path.
`Object`	`get(String path, Object def)` Gets the requested Object by path, returning a default value if not found.
`boolean`	`getBoolean(String path)` Gets the requested boolean by path.
`boolean`	`getBoolean(String path, boolean def)` Gets the requested boolean by path, returning a default value if not found.
`List<Boolean>`	`getBooleanList(String path)` Gets the requested List of Boolean by path.
`List<Byte>`	`getByteList(String path)` Gets the requested List of Byte by path.
`List<Character>`	`getCharacterList(String path)` Gets the requested List of Character by path.
`ConfigurationSection`	`getConfigurationSection(String path)` Gets the requested ConfigurationSection by path.
`String`	`getCurrentPath()` Gets the path of this `ConfigurationSection` from its root `Configuration` For any `Configuration` themselves, this will return an empty string.
`ConfigurationSection`	`getDefaultSection()` Gets the equivalent `ConfigurationSection` from the default `Configuration` defined in `getRoot()`.
`double`	`getDouble(String path)` Gets the requested double by path.
`double`	`getDouble(String path, double def)` Gets the requested double by path, returning a default value if not found.
`List<Double>`	`getDoubleList(String path)` Gets the requested List of Double by path.
`List<Float>`	`getFloatList(String path)` Gets the requested List of Float by path.
`int`	`getInt(String path)` Gets the requested int by path.
`int`	`getInt(String path, int def)` Gets the requested int by path, returning a default value if not found.
`List<Integer>`	`getIntegerList(String path)` Gets the requested List of Integer by path.
`Set<String>`	`getKeys(boolean deep)` Gets a set containing all keys in this section.
`List<?>`	`getList(String path)` Gets the requested List by path.
`List<?>`	`getList(String path, List<?> def)` Gets the requested List by path, returning a default value if not found.
`long`	`getLong(String path)` Gets the requested long by path.
`long`	`getLong(String path, long def)` Gets the requested long by path, returning a default value if not found.
`List<Long>`	`getLongList(String path)` Gets the requested List of Long by path.
`List<Map<?,?>>`	`getMapList(String path)` Gets the requested List of Maps by path.
`Map<String,Object>`	`getMapValues(boolean deep)` Gets a Map containing all keys and their values for this section.
`String`	`getName()` Gets the name of this individual `ConfigurationSection`, in the path.
`ConfigurationSection`	`getParent()` Gets the parent `ConfigurationSection` that directly contains this `ConfigurationSection`.
`Configuration`	`getRoot()` Gets the root `Configuration` that contains this `ConfigurationSection` For any `Configuration` themselves, this will return its own object.
`List<Short>`	`getShortList(String path)` Gets the requested List of Short by path.
`String`	`getString(String path)` Gets the requested String by path.
`String`	`getString(String path, String def)` Gets the requested String by path, returning a default value if not found.
`List<String>`	`getStringList(String path)` Gets the requested List of String by path.
`Map<String,Object>`	`getValues(boolean deep)` Gets a Map containing all keys and their values for this section.
`boolean`	`isBoolean(String path)` Checks if the specified path is a boolean.
`boolean`	`isConfigurationSection(String path)` Checks if the specified path is a ConfigurationSection.
`boolean`	`isDouble(String path)` Checks if the specified path is a double.
`boolean`	`isEmpty()` Gets if this configuration section is empty.
`boolean`	`isInt(String path)` Checks if the specified path is an int.
`boolean`	`isList(String path)` Checks if the specified path is a List.
`boolean`	`isLong(String path)` Checks if the specified path is a long.
`boolean`	`isSet(String path)` Checks if this `ConfigurationSection` has a value set for the given path.
`boolean`	`isString(String path)` Checks if the specified path is a String.
`default void`	`remove(String path)` Removes the specified path if it exists.
`void`	`set(String path, Object value)` Sets the specified path to the given value.
`int`	`size()` Gets the size of this configuration section.

- Method Detail
  - getKeys
```
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.
    
    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
```
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.
    
    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.
  - getMapValues
```
Map<String,Object> getMapValues(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 Maps (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.
    
    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.
  - contains
```
boolean contains(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 - Path to check for existence.
    
    Returns:
    
    True if this section contains the requested path, either via default or being set.
    
    Throws:
    
    IllegalArgumentException - Thrown when path is null.
  - isSet
```
boolean isSet(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 - Path to check for existence.
    
    Returns:
    
    True if this section contains the requested path, regardless of having a default.
    
    Throws:
    
    IllegalArgumentException - Thrown when path is null.
  - size
```
int size()
```
    Gets the size of this configuration section.
    
    Returns:
    
    number of keys in this configuration section
  - isEmpty
```
boolean isEmpty()
```
    Gets if this configuration section is empty.
    
    Returns:
    
    if there are no keys in this configuration section
  - getCurrentPath
```
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 getName().
    
    Returns:
    
    Path of this section relative to its root
  - getName
```
String getName()
```
    Gets the name of this individual ConfigurationSection, in the path.
    This will always be the final part of getCurrentPath(), unless the section is orphaned.
    
    Returns:
    
    Name of this section
  - getRoot
```
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.
    
    Returns:
    
    Root configuration containing this section.
  - getParent
```
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.
    
    Returns:
    
    Parent section containing this section.
  - get
```
Object get(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.
    
    Parameters:
    
    path - Path of the Object to get.
    
    Returns:
    
    Requested Object.
  - get
```
Object get(String path,
           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.
    
    Parameters:
    
    path - Path of the Object to get.
    
    def - The default value to return if the path is not found.
    
    Returns:
    
    Requested Object.
  - set
```
void set(String path,
         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 createSection(String) for that.
    
    Parameters:
    
    path - Path of the object to set.
    
    value - New value to set the path to.
  - remove
```
default void remove(String path)
```
    Removes the specified path if it exists. The entry will be removed, either a value or an entire section.
    
    Parameters:
    
    path - Path of the object to remove.
  - createSection
```
ConfigurationSection createSection(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 - Path to create the section at.
    
    Returns:
    
    Newly created section
  - createSection
```
ConfigurationSection createSection(String path,
                                   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.
    
    Parameters:
    
    path - Path to create the section at.
    
    map - The values to used.
    
    Returns:
    
    Newly created section
  - getString
```
String getString(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.
    
    Parameters:
    
    path - Path of the String to get.
    
    Returns:
    
    Requested String.
  - getString
```
String getString(String path,
                 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.
    
    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.
  - isString
```
boolean isString(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.
    
    Parameters:
    
    path - Path of the String to check.
    
    Returns:
    
    Whether or not the specified path is a String.
  - getInt
```
int getInt(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.
    
    Parameters:
    
    path - Path of the int to get.
    
    Returns:
    
    Requested int.
  - getInt
```
int getInt(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.
    
    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.
  - isInt
```
boolean isInt(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.
    
    Parameters:
    
    path - Path of the int to check.
    
    Returns:
    
    Whether or not the specified path is an int.
  - getBoolean
```
boolean getBoolean(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.
    
    Parameters:
    
    path - Path of the boolean to get.
    
    Returns:
    
    Requested boolean.
  - getBoolean
```
boolean getBoolean(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.
    
    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.
  - isBoolean
```
boolean isBoolean(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.
    
    Parameters:
    
    path - Path of the boolean to check.
    
    Returns:
    
    Whether or not the specified path is a boolean.
  - getDouble
```
double getDouble(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.
    
    Parameters:
    
    path - Path of the double to get.
    
    Returns:
    
    Requested double.
  - getDouble
```
double getDouble(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.
    
    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.
  - isDouble
```
boolean isDouble(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.
    
    Parameters:
    
    path - Path of the double to check.
    
    Returns:
    
    Whether or not the specified path is a double.
  - getLong
```
long getLong(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 0.
    
    Parameters:
    
    path - Path of the long to get.
    
    Returns:
    
    Requested long.
  - getLong
```
long getLong(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.
    
    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.
  - isLong
```
boolean isLong(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.
    
    Parameters:
    
    path - Path of the long to check.
    
    Returns:
    
    Whether or not the specified path is a long.
  - getList
```
List<?> getList(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.
    
    Parameters:
    
    path - Path of the List to get.
    
    Returns:
    
    Requested List.
  - getList
```
List<?> getList(String path,
                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.
    
    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.
  - isList
```
boolean isList(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.
    
    Parameters:
    
    path - Path of the List to check.
    
    Returns:
    
    Whether or not the specified path is a List.
  - getStringList
```
List<String> getStringList(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.
    
    Parameters:
    
    path - Path of the List to get.
    
    Returns:
    
    Requested List of String.
  - getIntegerList
```
List<Integer> getIntegerList(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.
    
    Parameters:
    
    path - Path of the List to get.
    
    Returns:
    
    Requested List of Integer.
  - getBooleanList
```
List<Boolean> getBooleanList(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.
    
    Parameters:
    
    path - Path of the List to get.
    
    Returns:
    
    Requested List of Boolean.
  - getDoubleList
```
List<Double> getDoubleList(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.
    
    Parameters:
    
    path - Path of the List to get.
    
    Returns:
    
    Requested List of Double.
  - getFloatList
```
List<Float> getFloatList(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.
    
    Parameters:
    
    path - Path of the List to get.
    
    Returns:
    
    Requested List of Float.
  - getLongList
```
List<Long> getLongList(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.
    
    Parameters:
    
    path - Path of the List to get.
    
    Returns:
    
    Requested List of Long.
  - getByteList
```
List<Byte> getByteList(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.
    
    Parameters:
    
    path - Path of the List to get.
    
    Returns:
    
    Requested List of Byte.
  - getCharacterList
```
List<Character> getCharacterList(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.
    
    Parameters:
    
    path - Path of the List to get.
    
    Returns:
    
    Requested List of Character.
  - getShortList
```
List<Short> getShortList(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.
    
    Parameters:
    
    path - Path of the List to get.
    
    Returns:
    
    Requested List of Short.
  - getMapList
```
List<Map<?,?>> getMapList(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.
    
    Parameters:
    
    path - Path of the List to get.
    
    Returns:
    
    Requested List of Maps.
  - getConfigurationSection
```
ConfigurationSection getConfigurationSection(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.
    
    Parameters:
    
    path - Path of the ConfigurationSection to get.
    
    Returns:
    
    Requested ConfigurationSection.
  - isConfigurationSection
```
boolean isConfigurationSection(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.
    
    Parameters:
    
    path - Path of the ConfigurationSection to check.
    
    Returns:
    
    Whether or not the specified path is a ConfigurationSection.
  - getDefaultSection
```
ConfigurationSection getDefaultSection()
```
    Gets the equivalent ConfigurationSection from the default Configuration defined in getRoot().
    If the root contains no defaults, or the defaults doesn't contain a value for this path, or the value at this path is not a ConfigurationSection then this will return null.
    
    Returns:
    
    Equivalent section in root configuration
  - addDefault
```
void addDefault(String path,
                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 section at the path, replacing anything that may have existed there previously.
    
    Parameters:
    
    path - Path of the value to set.
    
    value - Value to set the default to.
    
    Throws:
    
    IllegalArgumentException - Thrown if path is null.

Interface ConfigurationSection

Method Summary

Method Detail

getKeys

getValues

getMapValues

contains

isSet

size

isEmpty

getCurrentPath

getName

getRoot

getParent

get

get

set

remove

createSection

createSection

getString

getString

isString

getInt

getInt

isInt

getBoolean

getBoolean

isBoolean

getDouble

getDouble

isDouble

getLong

getLong

isLong

getList

getList

isList

getStringList

getIntegerList

getBooleanList

getDoubleList

getFloatList

getLongList

getByteList

getCharacterList

getShortList

getMapList

getConfigurationSection

isConfigurationSection

getDefaultSection

addDefault