ConfigSection (TridentSDK 0.4-SNAPSHOT API)

java.lang.Object
- net.tridentsdk.config.ConfigSection

Direct Known Subclasses:

Config
```
@ThreadSafe
public class ConfigSection
extends Object
```
Represents a section of the Config file

Since:

0.3-alpha-DP

Author:

The TridentSDK Team

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ConfigSection()` Instantiated by subclasses only
`protected`	`ConfigSection(ConfigSection parent, com.google.gson.JsonObject obj)` Creates a config section for the parent section

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<V> List<V>`	`addList(String tag, Class<V> type)` Adds an empty list into the tag
`static <V> ConfigSection`	`addToList(Collection<V> list)` Gets a config section with the elements defined in the specified collection
`com.google.gson.JsonObject`	`asJsonObject()` As JSON form
`boolean`	`contains(String tag)` Checks to see if the section contains the tag
`Set<Map.Entry<String,com.google.gson.JsonElement>>`	`entries()` Obtains the set of the topmost key-value entries
`BigDecimal`	`getBigDecimal(String tag)` Gets a BigDecimal at the specified tag
`BigDecimal`	`getBigDecimal(String tag, BigDecimal def)` Gets a BigDecimal at the specified tag, defaulting to the fallback if not found
`BigInteger`	`getBigInteger(String tag)` Gets the BigInteger at the tag
`BigInteger`	`getBigInteger(String tag, BigInteger def)` Gets a BigInteger from the section, defaulting the the fallback if not found
`boolean`	`getBoolean(String tag)` Gets a boolean from the config with the given tag
`boolean`	`getBoolean(String tag, boolean def)` Gets a boolean from the config with the given tag, defaulting to the fallback if the tag is not found
`byte`	`getByte(String tag)` Gets a character from the config with the given tag
`byte`	`getByte(String tag, byte def)` Gets a byte from the config with the given tag, defaulting to the fallback if the tag is not found
`char`	`getChar(String tag)` Gets a character from the config with the given tag
`char`	`getChar(String tag, char def)` Gets a character from the config with the given tag, or defaults to the fallback if the tag is not found
`ConfigSection`	`getConfigSection(String tag)` Gets a sub section which has the current section as a parent
`double`	`getDouble(String tag)` Gets a double from the config with the given tag
`double`	`getDouble(String tag, double def)` Gets a double from the config with the given tag, or defaults to the fallback if the tag is not found
`float`	`getFloat(String tag)` Gets an float from the config with the given tag
`float`	`getFloat(String tag, float def)` Gets a float from the config with the given tag, or defaults to the fallback if the tag is not found
`int`	`getInt(String tag)` Gets an integer from the config with the given tag
`int`	`getInt(String tag, int def)` Gets an integer from the config with the given tag, or defaults to the fallback if the tag is not found
`<V> List<V>`	`getList(String tag, Class<V> type)` Gets the list at the tag
`<V> V`	`getObject(String tag, Class<V> clazz)` Gets the Object at the specified tag
`String`	`getString(String tag)`
`String`	`getString(String tag, String def)` Gets the string at the specified tag, defaulting to the specified default if not found
`Set<String>`	`keys()` Returns all of the topmost keys.
`ConfigSection`	`parentSection()` The section parent
`void`	`remove(String tag)` Removes the tag from the configuration
`Config`	`rootSection()` The JSON root from the parent
`void`	`save()` Saves the parent data
`void`	`setBigDecimal(String tag, BigDecimal bd)` Sets the `BigDecimal` the specified tag
`void`	`setBigInteger(String s, BigInteger bi)` Sets the `BigInteger` the specified tag
`void`	`setBoolean(String tag, boolean b)` Sets the boolean the specified tag
`void`	`setByte(String tag, byte b)` Sets the byte the specified tag
`void`	`setChar(String tag, char c)` Sets a character at the tag to the specified character
`void`	`setDouble(String tag, double d)` Sets a double at the tag to a specified double
`void`	`setFloat(String tag, float f)` Sets the float at the tag to a specified float
`void`	`setInt(String tag, int in)` Sets the value at the tag to a specified integer
`void`	`setObject(String tag, Object object)` Sets the object at the specified tag
`void`	`setString(String tag, String s)` Sets the string the specified tag
`Collection<com.google.gson.JsonElement>`	`values()` Returns the topmost values

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ConfigSection
```
protected ConfigSection()
```
    Instantiated by subclasses only
  - ConfigSection
```
protected ConfigSection(ConfigSection parent,
                        com.google.gson.JsonObject obj)
```
    Creates a config section for the parent section
    
    Parameters:
    
    parent - the section to be sub-sectioned under
    
    obj - the section handler, used to store values
- Method Detail
  - addToList
```
public static <V> ConfigSection addToList(Collection<V> list)
```
    Gets a config section with the elements defined in the specified collection
    
    Type Parameters:
    
    V - the type in the collection
    
    Parameters:
    
    list - the collection of objects to serialize to a config section
    
    Returns:
    
    the config section with all the values in the list
  - getInt
```
public int getInt(String tag,
                  int def)
```
    Gets an integer from the config with the given tag, or defaults to the fallback if the tag is not found
    
    Parameters:
    
    tag - the tag to find the value from
    
    def - the default value if no tag is found
    
    Returns:
    
    the integer at the tag
  - getInt
```
public int getInt(String tag)
```
    Gets an integer from the config with the given tag
    Gives 0 if the value could not be found
    
    Parameters:
    
    tag - the tag to find the value from
    
    Returns:
    
    the integer at the tag
  - setInt
```
public void setInt(String tag,
                   int in)
```
    Sets the value at the tag to a specified integer
    
    Parameters:
    
    tag - the tag to set the value
    
    in - the integer value to set the tag
  - getDouble
```
public double getDouble(String tag,
                        double def)
```
    Gets a double from the config with the given tag, or defaults to the fallback if the tag is not found
    
    Parameters:
    
    tag - the tag to find the value from
    
    def - the default value if no tag is found
    
    Returns:
    
    the double at the tag
  - getDouble
```
public double getDouble(String tag)
```
    Gets a double from the config with the given tag
    Gives 0.0D if the value could not be found
    
    Parameters:
    
    tag - the tag to find the value from
    
    Returns:
    
    the double at the tag
  - setDouble
```
public void setDouble(String tag,
                      double d)
```
    Sets a double at the tag to a specified double
    
    Parameters:
    
    tag - the tag to set the value
    
    d - the double to set to the tag
  - getFloat
```
public float getFloat(String tag,
                      float def)
```
    Gets a float from the config with the given tag, or defaults to the fallback if the tag is not found
    
    Parameters:
    
    tag - the tag to find the value from
    
    def - the default value if no tag is found
    
    Returns:
    
    the float at the tag
  - getFloat
```
public float getFloat(String tag)
```
    Gets an float from the config with the given tag
    Gives 0.0F if the value could not be found
    
    Parameters:
    
    tag - the tag to find the value from
    
    Returns:
    
    the float at the tag
  - setFloat
```
public void setFloat(String tag,
                     float f)
```
    Sets the float at the tag to a specified float
    
    Parameters:
    
    tag - the tag to set the value
    
    f - the float to set the tag to
  - getChar
```
public char getChar(String tag,
                    char def)
```
    Gets a character from the config with the given tag, or defaults to the fallback if the tag is not found
    
    Parameters:
    
    tag - the tag to find the value from
    
    def - the default value if no tag is found
    
    Returns:
    
    the character at the tag
  - getChar
```
public char getChar(String tag)
```
    Gets a character from the config with the given tag
    Gives if the value could not be found
    
    Parameters:
    
    tag - the tag to find the value from
    
    Returns:
    
    the character at the tag
  - setChar
```
public void setChar(String tag,
                    char c)
```
    Sets a character at the tag to the specified character
    
    Parameters:
    
    tag - the tag to set the value
    
    c - the character to set the tag to
  - getBoolean
```
public boolean getBoolean(String tag,
                          boolean def)
```
    Gets a boolean from the config with the given tag, defaulting to the fallback if the tag is not found
    
    Parameters:
    
    tag - the tag to find the value from
    
    def - the default value if the tag is not found
    
    Returns:
    
    the boolean at the tag
  - getBoolean
```
public boolean getBoolean(String tag)
```
    Gets a boolean from the config with the given tag
    Gives false if the value could not be found
    
    Parameters:
    
    tag - the tag to find the value from
    
    Returns:
    
    the boolean at the tag
  - setBoolean
```
public void setBoolean(String tag,
                       boolean b)
```
    Sets the boolean the specified tag
    
    Parameters:
    
    tag - the tag to set the value
    
    b - the boolean to set to at the tag
  - getByte
```
public byte getByte(String tag,
                    byte def)
```
    Gets a byte from the config with the given tag, defaulting to the fallback if the tag is not found
    
    Parameters:
    
    tag - the tag to find the value from
    
    def - the default if the tag is not found
    
    Returns:
    
    the byte at the tag
  - getByte
```
public byte getByte(String tag)
```
    Gets a character from the config with the given tag
    Gives (byte) 0 if the value could not be found
    
    Parameters:
    
    tag - the tag to find the value from
    
    Returns:
    
    the character at the tag
  - setByte
```
public void setByte(String tag,
                    byte b)
```
    Sets the byte the specified tag
    
    Parameters:
    
    tag - the tag to set the value
    
    b - the byte to set to at the tag
  - getString
```
public String getString(String tag,
                        String def)
```
    Gets the string at the specified tag, defaulting to the specified default if not found
    
    Parameters:
    
    tag - the tag to set the value
    
    def - the default value to
  - getString
```
public String getString(String tag)
```
  - setString
```
public void setString(String tag,
                      String s)
```
    Sets the string the specified tag
    
    Parameters:
    
    tag - the tag to set the value
    
    s - the string to set at the tag
  - getList
```
public <V> List<V> getList(String tag,
                           Class<V> type)
```
    Gets the list at the tag
    
    Type Parameters:
    
    V - the list type
    
    Parameters:
    
    tag - the tag to find the value from
    
    type - the types contained in the list
    
    Returns:
    
    the list from the section
  - addList
```
public <V> List<V> addList(String tag,
                           Class<V> type)
```
    Adds an empty list into the tag
    
    Type Parameters:
    
    V - the list type
    
    Parameters:
    
    tag - the tag to set the value
    
    type - the types in the list
    
    Returns:
    
    the list added to the section
  - getBigInteger
```
public BigInteger getBigInteger(String tag,
                                BigInteger def)
```
    Gets a BigInteger from the section, defaulting the the fallback if not found
    
    Parameters:
    
    tag - the tag to find the value from
    
    def - the default value
    
    Returns:
    
    the BigInteger value at the tag
  - getBigInteger
```
public BigInteger getBigInteger(String tag)
```
    Gets the BigInteger at the tag
    Defaults to null if not found
    
    Parameters:
    
    tag - the tag to find the value from
    
    Returns:
    
    the BigInteger at the tag
  - setBigInteger
```
public void setBigInteger(String s,
                          BigInteger bi)
```
    Sets the BigInteger the specified tag
    
    Parameters:
    
    s - the tag to set the integer to
    
    bi - the BigInteger ot set the tag to
  - getBigDecimal
```
public BigDecimal getBigDecimal(String tag,
                                BigDecimal def)
```
    Gets a BigDecimal at the specified tag, defaulting to the fallback if not found
    
    Parameters:
    
    tag - the tag to find the value from
    
    def - the default value
    
    Returns:
    
    the value at the tag
  - getBigDecimal
```
public BigDecimal getBigDecimal(String tag)
```
    Gets a BigDecimal at the specified tag
    Defaults to null if the tag is not found
    
    Parameters:
    
    tag - the tag to find the value from
    
    Returns:
    
    the value of the tag
  - setBigDecimal
```
public void setBigDecimal(String tag,
                          BigDecimal bd)
```
    Sets the BigDecimal the specified tag
    
    Parameters:
    
    tag - the tag to set the value
    
    bd - the BigDecimal to set the tag to
  - getObject
```
public <V> V getObject(String tag,
                       Class<V> clazz)
```
    Gets the Object at the specified tag
    
    Type Parameters:
    
    V - the object type
    
    Parameters:
    
    tag - the tag to find the value from
    
    clazz - the type of the object
    
    Returns:
    
    the value
  - setObject
```
public void setObject(String tag,
                      Object object)
```
    Sets the object at the specified tag
    
    Parameters:
    
    tag - the tag to set the value
    
    object - the value to set the tag to
  - remove
```
public void remove(String tag)
```
    Removes the tag from the configuration
    
    Parameters:
    
    tag - the tag to remove
  - contains
```
public boolean contains(String tag)
```
    Checks to see if the section contains the tag
    
    Parameters:
    
    tag - the tag to see if contained
    
    Returns:
    
    true if the tag is in the section, false if not
  - asJsonObject
```
public com.google.gson.JsonObject asJsonObject()
```
    As JSON form
    
    Returns:
    
    the JSON version of the section
  - rootSection
```
public Config rootSection()
```
    The JSON root from the parent
    
    Returns:
    
    the parent root section
  - parentSection
```
public ConfigSection parentSection()
```
    The section parent
    
    Returns:
    
    the parent of the section
  - getConfigSection
```
public ConfigSection getConfigSection(String tag)
```
    Gets a sub section which has the current section as a parent
    A new section is created if it does not exist
    
    Parameters:
    
    tag - the tag to get the section from
    
    Returns:
    
    the section with the given tag under this section
  - keys
```
public Set<String> keys()
```
    Returns all of the topmost keys. Will not have inner section keys.
    
    Returns:
    
    the config keys
  - values
```
public Collection<com.google.gson.JsonElement> values()
```
    Returns the topmost values
    
    Returns:
    
    the values
  - entries
```
public Set<Map.Entry<String,com.google.gson.JsonElement>> entries()
```
    Obtains the set of the topmost key-value entries
    
    Returns:
    
    the key-value entry set
  - save
```
public void save()
```
    Saves the parent data

Class ConfigSection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConfigSection

ConfigSection

Method Detail

addToList

getInt

getInt

setInt

getDouble

getDouble

setDouble

getFloat

getFloat

setFloat

getChar

getChar

setChar

getBoolean

getBoolean

setBoolean

getByte

getByte

setByte

getString

getString

setString

getList

addList

getBigInteger

getBigInteger

setBigInteger

getBigDecimal

getBigDecimal

setBigDecimal

getObject

setObject

remove

contains

asJsonObject

rootSection

parentSection

getConfigSection

keys

values

entries

save