Configuration

All Known Subinterfaces:

EditableConfiguration

All Known Implementing Classes:

JsonConfiguration
```
public interface Configuration
```
A configuration object holds different configuration objects indexable by strings.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default java.lang.Object`	`get(java.lang.String name)` Get a property's object from this configuration if it exists.
`ConfigurationArray`	`getArray(java.lang.String name)` Get an ConfigurationArray from this configuration if it exists.
`boolean`	`getBoolean(java.lang.String name)` Get a boolean property from this configuration if it exists.
`Configuration`	`getInner(java.lang.String name)` Get an inner Configuration object from this configuration if it exists.
`java.lang.Number`	`getNumber(java.lang.String name)` Get a number property from this configuration if it exists.
`java.util.Collection<java.lang.String>`	`getProperties()` Returns a collection of the property names available in this configuration.
`default java.util.Map<java.lang.String,java.lang.Object>`	`getRawData()` Gets a copy of the raw data of this configuration.
`java.lang.String`	`getString(java.lang.String name)` Get a String property from this configuration if it exists.
`default boolean`	`hasArray(java.lang.String name)` Returns whether this configuration has an Object[] property of the given name.
`default boolean`	`hasBoolean(java.lang.String name)` Returns whether this configuration has a boolean property of the given name.
`default boolean`	`hasInner(java.lang.String name)` Returns whether this configuration has a Configuration property of the given name.
`default boolean`	`hasNumber(java.lang.String name)` Returns whether this configuration has a number property of the given name.
`default boolean`	`hasString(java.lang.String name)` Returns whether this configuration has a String property of the given name.
`default java.util.Optional<java.lang.Object>`	`tryGet(java.lang.String name)` Tries to get an Object from this configuration.
`default java.util.Optional<ConfigurationArray>`	`tryGetArray(java.lang.String name)` Tries to get an ConfigurationArray property from this configuration.
`default java.util.Optional<java.lang.Boolean>`	`tryGetBoolean(java.lang.String name)` Tries to get a boolean property from this configuration.
`default java.util.Optional<Configuration>`	`tryGetInner(java.lang.String name)` Tries to get a Configuration property from this configuration.
`default java.util.Optional<java.lang.Number>`	`tryGetNumber(java.lang.String name)` Tries to get a number property from this configuration.
`default java.util.Optional<java.lang.String>`	`tryGetString(java.lang.String name)` Tries to get a String property from this configuration.

- Method Detail
  - getNumber
```
java.lang.Number getNumber(java.lang.String name)
                    throws NoSuchPropertyException
```
    Get a number property from this configuration if it exists. For a safe way of getting the number, see tryGetNumber(String).
    
    Parameters:
    
    name - The name of the property
    
    Returns:
    
    The number property stored under the given name
    
    Throws:
    
    NoSuchPropertyException - If there is no property with the given name, or if there is a property with the given name, but of a different type.
  - tryGetNumber
```
default java.util.Optional<java.lang.Number> tryGetNumber(java.lang.String name)
```
    Tries to get a number property from this configuration. Returns an empty optional instead of throwing an exception if there is none.
    
    Parameters:
    
    name - The name of the property
    
    Returns:
    
    The number property stored under the given name, or an empty optional if there is no number property with the given name.
  - hasNumber
```
default boolean hasNumber(java.lang.String name)
```
    Returns whether this configuration has a number property of the given name. If true, getNumber(String) is guaranteed not to throw an exception, and tryGetNumber(String) is guaranteed to contain an object and not be empty.
    
    Parameters:
    
    name - The name of the property.
    
    Returns:
    
    Whether this configuration has a number property of the given name.
  - getBoolean
```
boolean getBoolean(java.lang.String name)
            throws NoSuchPropertyException
```
    Get a boolean property from this configuration if it exists. For a safe way of getting the boolean, see tryGetBoolean(String) .
    
    Parameters:
    
    name - The name of the property
    
    Returns:
    
    The boolean property stored under the given name
    
    Throws:
    
    NoSuchPropertyException - If there is no property with the given name, or if there is a property with the given name, but of a different type.
  - tryGetBoolean
```
default java.util.Optional<java.lang.Boolean> tryGetBoolean(java.lang.String name)
```
    Tries to get a boolean property from this configuration. Returns an empty optional instead of throwing an exception if there is none.
    
    Parameters:
    
    name - The name of the property
    
    Returns:
    
    The boolean property stored under the given name, or an empty optional if there is no boolean property with the given name.
  - hasBoolean
```
default boolean hasBoolean(java.lang.String name)
```
    Returns whether this configuration has a boolean property of the given name. If true, getBoolean(String) is guaranteed not to throw an exception, and tryGetBoolean(String) is guaranteed to contain an object and not be empty.
    
    Parameters:
    
    name - The name of the property.
    
    Returns:
    
    Whether this configuration has a boolean property of the given name.
  - getString
```
java.lang.String getString(java.lang.String name)
                    throws NoSuchPropertyException
```
    Get a String property from this configuration if it exists. For a safe way of getting the String, see tryGetString(String) .
    
    Parameters:
    
    name - The name of the property
    
    Returns:
    
    The String property stored under the given name
    
    Throws:
    
    NoSuchPropertyException - If there is no property with the given name, or if there is a property with the given name, but of a different type.
  - tryGetString
```
default java.util.Optional<java.lang.String> tryGetString(java.lang.String name)
```
    Tries to get a String property from this configuration. Returns an empty optional instead of throwing an exception if there is none.
    
    Parameters:
    
    name - The name of the property
    
    Returns:
    
    The String property stored under the given name, or an empty optional if there is no String property with the given name.
  - hasString
```
default boolean hasString(java.lang.String name)
```
    Returns whether this configuration has a String property of the given name. If true, getString(String) is guaranteed not to throw an exception, and tryGetString(String) is guaranteed to contain an object and not be empty.
    
    Parameters:
    
    name - The name of the property.
    
    Returns:
    
    Whether this configuration has a String property of the given name.
  - getArray
```
ConfigurationArray getArray(java.lang.String name)
                     throws NoSuchPropertyException
```
    Get an ConfigurationArray from this configuration if it exists. For a safe way of getting the ConfigurationArray, see tryGetArray(String). The returned array may be empty.
    
    Parameters:
    
    name - The name of the property
    
    Returns:
    
    The ConfigurationArray property stored under the given name
    
    Throws:
    
    NoSuchPropertyException - If there is no property with the given name, or if there is a property with the given name, but of a different type.
  - tryGetArray
```
default java.util.Optional<ConfigurationArray> tryGetArray(java.lang.String name)
```
    Tries to get an ConfigurationArray property from this configuration. Returns an empty optional instead of throwing an exception if there is none.
    
    Parameters:
    
    name - The name of the property
    
    Returns:
    
    The ConfigurationArray property stored under the given name, or an empty Object[] if there is no Object[] property with the given name.
  - hasArray
```
default boolean hasArray(java.lang.String name)
```
    Returns whether this configuration has an Object[] property of the given name. If true, getArray(String) is guaranteed not to throw an exception. However, it still may return an empty array.
    
    Parameters:
    
    name - The name of the property.
    
    Returns:
    
    Whether this configuration has an Object[] property of the given name.
  - getInner
```
Configuration getInner(java.lang.String name)
                throws NoSuchPropertyException
```
    Get an inner Configuration object from this configuration if it exists. For a safe way of getting the inner Configuration, see tryGetInner(String).
    
    Parameters:
    
    name - The name of the property
    
    Returns:
    
    The Configuration property stored under the given name
    
    Throws:
    
    NoSuchPropertyException - If there is no property with the given name, or if there is a property with the given name, but of a different type.
  - tryGetInner
```
default java.util.Optional<Configuration> tryGetInner(java.lang.String name)
```
    Tries to get a Configuration property from this configuration. Returns an an empty optional instead of throwing an exception if there is none.
    
    Parameters:
    
    name - The name of the property
    
    Returns:
    
    The Configuration property stored under the given name, or an empty optional if there is no Configuration property with the given name,
  - hasInner
```
default boolean hasInner(java.lang.String name)
```
    Returns whether this configuration has a Configuration property of the given name. If true, getInner(String) is guaranteed not to throw an exception, and tryGetInner(String) is guaranteed to contain an object and not be empty.
    
    Parameters:
    
    name - The name of the property.
    
    Returns:
    
    Whether this configuration has a Configuration property of the given name.
  - get
```
default java.lang.Object get(java.lang.String name)
                      throws NoSuchPropertyException
```
    Get a property's object from this configuration if it exists. For a safe way of getting the object, see tryGet(String). The object will be of any of the different types which can be stored in this configuration object.
    
    Parameters:
    
    name - The name of the property.
    
    Returns:
    
    The Object stored under the given name
    
    Throws:
    
    NoSuchPropertyException - If there is no property with the given name
  - tryGet
```
default java.util.Optional<java.lang.Object> tryGet(java.lang.String name)
```
    Tries to get an Object from this configuration. Returns an empty optional instead of throwing an exception if there is none.
    
    Parameters:
    
    name - The name of the property
    
    Returns:
    
    The Object stored under the given name, or an empty optional if there is no property with the given name.
  - getProperties
```
java.util.Collection<java.lang.String> getProperties()
```
    Returns a collection of the property names available in this configuration. Any element of this collection is guaranteed not to throw an exception when performing get(String) and not to return an empty optional on tryGet(String).
  - getRawData
```
default java.util.Map<java.lang.String,java.lang.Object> getRawData()
```
    Gets a copy of the raw data of this configuration. Note that changing the data in this map has no effect on the actual configuration. Each value is of one of the types supported by this configuration.
    
    Returns:
    
    A copy of the raw data contained in this configuration.

Interface Configuration

Method Summary

Method Detail

getNumber

tryGetNumber

hasNumber

getBoolean

tryGetBoolean

hasBoolean

getString

tryGetString

hasString

getArray

tryGetArray

hasArray

getInner

tryGetInner

hasInner

get

tryGet

getProperties

getRawData