Package org.bukkit.configuration

Interface ConfigurationSection

All Known Subinterfaces:
Configuration
All Known Implementing Classes:
FileConfiguration, MemoryConfiguration, MemorySection, YamlConfiguration
public interface ConfigurationSection
Represents a section of a Configuration

  • Method Summary

    Modifier and Type Method Description
    void addDefault​(@NotNull java.lang.String path, @Nullable java.lang.Object value)
    Sets the default value in the root at the given path as provided.
    boolean contains​(@NotNull java.lang.String path)
    Checks if this ConfigurationSection contains the given path.
    boolean contains​(@NotNull java.lang.String path, boolean ignoreDefault)
    Checks if this ConfigurationSection contains the given path.
    @NotNull ConfigurationSection createSection​(@NotNull java.lang.String path)
    Creates an empty ConfigurationSection at the specified path.
    @NotNull ConfigurationSection createSection​(@NotNull java.lang.String path, @NotNull java.util.Map<?,​?> map)
    Creates a ConfigurationSection at the specified path, with specified values.
    @Nullable java.lang.Object get​(@NotNull java.lang.String path)
    Gets the requested Object by path.
    @Nullable java.lang.Object get​(@NotNull java.lang.String path, @Nullable java.lang.Object def)
    Gets the requested Object by path, returning a default value if not found.
    boolean getBoolean​(@NotNull java.lang.String path)
    Gets the requested boolean by path.
    boolean getBoolean​(@NotNull java.lang.String path, boolean def)
    Gets the requested boolean by path, returning a default value if not found.
    @NotNull java.util.List<java.lang.Boolean> getBooleanList​(@NotNull java.lang.String path)
    Gets the requested List of Boolean by path.
    @NotNull java.util.List<java.lang.Byte> getByteList​(@NotNull java.lang.String path)
    Gets the requested List of Byte by path.
    @NotNull java.util.List<java.lang.Character> getCharacterList​(@NotNull java.lang.String path)
    Gets the requested List of Character by path.
    @Nullable ConfigurationSection getConfigurationSection​(@NotNull java.lang.String path)
    Gets the requested ConfigurationSection by path.
    @Nullable java.lang.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 java.lang.String path)
    Gets the requested double by path.
    double getDouble​(@NotNull java.lang.String path, double def)
    Gets the requested double by path, returning a default value if not found.
    @NotNull java.util.List<java.lang.Double> getDoubleList​(@NotNull java.lang.String path)
    Gets the requested List of Double by path.
    @NotNull java.util.List<java.lang.Float> getFloatList​(@NotNull java.lang.String path)
    Gets the requested List of Float by path.
    int getInt​(@NotNull java.lang.String path)
    Gets the requested int by path.
    int getInt​(@NotNull java.lang.String path, int def)
    Gets the requested int by path, returning a default value if not found.
    @NotNull java.util.List<java.lang.Integer> getIntegerList​(@NotNull java.lang.String path)
    Gets the requested List of Integer by path.
    @NotNull java.util.Set<java.lang.String> getKeys​(boolean deep)
    Gets a set containing all keys in this section.
    @Nullable java.util.List<?> getList​(@NotNull java.lang.String path)
    Gets the requested List by path.
    @Nullable java.util.List<?> getList​(@NotNull java.lang.String path, @Nullable java.util.List<?> def)
    Gets the requested List by path, returning a default value if not found.
    long getLong​(@NotNull java.lang.String path)
    Gets the requested long by path.
    long getLong​(@NotNull java.lang.String path, long def)
    Gets the requested long by path, returning a default value if not found.
    @NotNull java.util.List<java.lang.Long> getLongList​(@NotNull java.lang.String path)
    Gets the requested List of Long by path.
    @NotNull java.util.List<java.util.Map<?,​?>> getMapList​(@NotNull java.lang.String path)
    Gets the requested List of Maps by path.
    @NotNull java.lang.String getName()
    Gets the name of this individual ConfigurationSection, in the path.
    <T> T getObject​(@NotNull java.lang.String path, @NotNull java.lang.Class<T> clazz)
    Gets the requested object at the given path.
    <T> T getObject​(@NotNull java.lang.String path, @NotNull java.lang.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 java.lang.String path, @NotNull java.lang.Class<T> clazz)
    Gets the requested ConfigurationSerializable object at the given path.
    <T extends ConfigurationSerializable>
    T    		 getSerializable​(@NotNull java.lang.String path, @NotNull java.lang.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.
    @NotNull java.util.List<java.lang.Short> getShortList​(@NotNull java.lang.String path)
    Gets the requested List of Short by path.
    @Nullable java.lang.String getString​(@NotNull java.lang.String path)
    Gets the requested String by path.
    @Nullable java.lang.String getString​(@NotNull java.lang.String path, @Nullable java.lang.String def)
    Gets the requested String by path, returning a default value if not found.
    @NotNull java.util.List<java.lang.String> getStringList​(@NotNull java.lang.String path)
    Gets the requested List of String by path.
    @NotNull java.util.Map<java.lang.String,​java.lang.Object> getValues​(boolean deep)
    Gets a Map containing all keys and their values for this section.
    boolean isBoolean​(@NotNull java.lang.String path)
    Checks if the specified path is a boolean.
    boolean isConfigurationSection​(@NotNull java.lang.String path)
    Checks if the specified path is a ConfigurationSection.
    boolean isDouble​(@NotNull java.lang.String path)
    Checks if the specified path is a double.
    boolean isInt​(@NotNull java.lang.String path)
    Checks if the specified path is an int.
    boolean isList​(@NotNull java.lang.String path)
    Checks if the specified path is a List.
    boolean isLong​(@NotNull java.lang.String path)
    Checks if the specified path is a long.
    boolean isSet​(@NotNull java.lang.String path)
    Checks if this ConfigurationSection has a value set for the given path.
    boolean isString​(@NotNull java.lang.String path)
    Checks if the specified path is a String.
    void set​(@NotNull java.lang.String path, @Nullable java.lang.Object value)
    Sets the specified path to the given value.

  • Method Details

    • getKeys

      @NotNull @NotNull java.util.Set<java.lang.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

      @NotNull @NotNull java.util.Map<java.lang.String,​java.lang.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.

    • contains

      boolean contains​(@NotNull @NotNull java.lang.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:
      java.lang.IllegalArgumentException - Thrown when path is null.

    • contains

      boolean contains​(@NotNull @NotNull java.lang.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.

      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.
      Throws:
      java.lang.IllegalArgumentException - Thrown when path is null.

    • isSet

      boolean isSet​(@NotNull @NotNull java.lang.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:
      java.lang.IllegalArgumentException - Thrown when path is null.

    • getCurrentPath

      @Nullable @Nullable java.lang.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

      @NotNull @NotNull java.lang.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

      @Nullable @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.

      Returns:
      Root configuration containing this section.

    • getParent

      @Nullable @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.

      Returns:
      Parent section containing this section.

    • get

      @Nullable @Nullable java.lang.Object get​(@NotNull @NotNull java.lang.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

      @Nullable @Nullable java.lang.Object get​(@NotNull @NotNull java.lang.String path, @Nullable @Nullable java.lang.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​(@NotNull @NotNull java.lang.String path, @Nullable @Nullable java.lang.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(java.lang.String) for that.

      Parameters:
      path - Path of the object to set.
      value - New value to set the path to.

    • createSection

      @NotNull @NotNull ConfigurationSection createSection​(@NotNull @NotNull java.lang.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

      @NotNull @NotNull ConfigurationSection createSection​(@NotNull @NotNull java.lang.String path, @NotNull @NotNull java.util.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

      @Nullable @Nullable java.lang.String getString​(@NotNull @NotNull java.lang.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

      @Nullable @Nullable java.lang.String getString​(@NotNull @NotNull java.lang.String path, @Nullable @Nullable java.lang.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​(@NotNull @NotNull java.lang.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​(@NotNull @NotNull java.lang.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​(@NotNull @NotNull java.lang.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​(@NotNull @NotNull java.lang.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​(@NotNull @NotNull java.lang.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​(@NotNull @NotNull java.lang.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​(@NotNull @NotNull java.lang.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​(@NotNull @NotNull java.lang.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​(@NotNull @NotNull java.lang.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​(@NotNull @NotNull java.lang.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​(@NotNull @NotNull java.lang.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​(@NotNull @NotNull java.lang.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​(@NotNull @NotNull java.lang.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

      @Nullable @Nullable java.util.List<?> getList​(@NotNull @NotNull java.lang.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

      @Nullable @Nullable java.util.List<?> getList​(@NotNull @NotNull java.lang.String path, @Nullable @Nullable java.util.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​(@NotNull @NotNull java.lang.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

      @NotNull @NotNull java.util.List<java.lang.String> getStringList​(@NotNull @NotNull java.lang.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

      @NotNull @NotNull java.util.List<java.lang.Integer> getIntegerList​(@NotNull @NotNull java.lang.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

      @NotNull @NotNull java.util.List<java.lang.Boolean> getBooleanList​(@NotNull @NotNull java.lang.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

      @NotNull @NotNull java.util.List<java.lang.Double> getDoubleList​(@NotNull @NotNull java.lang.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

      @NotNull @NotNull java.util.List<java.lang.Float> getFloatList​(@NotNull @NotNull java.lang.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

      @NotNull @NotNull java.util.List<java.lang.Long> getLongList​(@NotNull @NotNull java.lang.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

      @NotNull @NotNull java.util.List<java.lang.Byte> getByteList​(@NotNull @NotNull java.lang.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

      @NotNull @NotNull java.util.List<java.lang.Character> getCharacterList​(@NotNull @NotNull java.lang.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

      @NotNull @NotNull java.util.List<java.lang.Short> getShortList​(@NotNull @NotNull java.lang.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

      @NotNull @NotNull java.util.List<java.util.Map<?,​?>> getMapList​(@NotNull @NotNull java.lang.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.

    • getObject

      @Nullable <T> T getObject​(@NotNull @NotNull java.lang.String path, @NotNull @NotNull java.lang.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.
      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

      @Nullable <T> T getObject​(@NotNull @NotNull java.lang.String path, @NotNull @NotNull java.lang.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.
      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 <T extends ConfigurationSerializable> T getSerializable​(@NotNull @NotNull java.lang.String path, @NotNull @NotNull java.lang.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.
      Type Parameters:
      T - the type of ConfigurationSerializable
      Parameters:
      path - the path to the object.
      clazz - the type of ConfigurationSerializable
      Returns:
      Requested ConfigurationSerializable object

    • getSerializable

      @Nullable <T extends ConfigurationSerializable> T getSerializable​(@NotNull @NotNull java.lang.String path, @NotNull @NotNull java.lang.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.
      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

    • getConfigurationSection

      @Nullable @Nullable ConfigurationSection getConfigurationSection​(@NotNull @NotNull java.lang.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​(@NotNull @NotNull java.lang.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

      @Nullable @Nullable 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​(@NotNull @NotNull java.lang.String path, @Nullable @Nullable java.lang.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:
      java.lang.IllegalArgumentException - Thrown if path is null.