Section (ConfigPlus Plugin 1.2.0 API)

java.lang.Object
- nl.taico.configplus.interfaces.CSection
- - nl.taico.configplus.Section

All Implemented Interfaces:

IBasicSection, ISection

Direct Known Subclasses:

BukkitSection
```
public class Section
extends CSection
```
A Section is a part of a config file.
It is basically just a path.
Example config.yml:

Simple Value 1: True Simple Value 2: 20 Simple Value 3: 10.01 Simple Value 4: This is a simple string Simple Value 5: "Quotes \" are required \'" Short List 1: ["10", "Hey", "Yes"] List 2: - Yes - 20 - 10.01 - This is a simple string Section 1: A value: 10 Subsection 1: A value: 20 A list: - 20 - 30 Section 2: Subsection: A value: true
Example Code:
Config config = Config.getNewConfig(getLogger(), new File(""), "config.yml"); ISection section1 = config.getSection("Section 1"); config.getKeys("section1", false); //[Section1.A value, Section1.Subsection 1, Section1.A list] section1.getKeys(false); //[A value, Subsection 1, A list] section1.getKeys(true); //[A value, Subsection 1, Subsection 1.A value, A list] //(Returned order can be different) config.getString("Section1.A value"); //10 section1.getString("A value"); //10 section1.set("A list", new int[] {20, 30}); config.getIntegerList("Section1.A list"); //[20, 30] config.getDoubleList("Section1.A list"); //[20.0, 30.0] section1.getStringList("A list"); //["20", "30"] section1.set("A list", new double[] {11.0, 12.9, 9.9999999}); section1.getIntegerList("A list"); //[11, 12, 9] section1.getStringList("A list"); //["11.0", "12.9", "9.99999"] (rounded to 5 decimals)

Author:

Taico

Field Summary

Fields
Modifier and Type Field and Description

protected ISection parent

protected String path

Fields
Modifier and Type	Field and Description
`protected ISection`	`parent`
`protected String`	`path`

Constructor Summary

Constructors
Constructor and Description

Section(ISection parent, String path)

Constructors
Constructor and Description
`Section(ISection parent, String path)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCommentsAbove(String path, boolean belowExistingComments, String... comments)` Adds the given comments above the Entry at the given path.
`void`	`addCommentsBelow(String path, boolean belowExistingComments, String... comments)` Adds the given comments below the Entry at the given path.
`void`	`addEntry(Line line)`
`boolean`	`contains(String path)` Returns if this section contains a list or single value for the given path.
`Line`	`get(String path)` Gets the line with the given path. Returns `null` if no line with the given path exists.
`List<Line>`	`getEntries()`
`List<Line>`	`getEntries(String path)`
`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 Sections (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.
`Set<String>`	`getKeys(String path, boolean deep)` Gets a set containing all keys that start with the given path in this section. If deep is set to true, then this will contain all the keys within any child Sections (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.
`String`	`getName()` Returns the name of this Section.
`ISection`	`getParent()`
`String`	`getPath()` Returns the path of this Section, relative to the main config.
`protected String`	`getPathTo(String path)`
`ISection`	`getSection(String path)` Gets the requested `Section` by path. Returns an empty section if it didn't exist.
`boolean`	`remove(String path, boolean renew)` Removes a Single value, List or Section from the config.
`boolean`	`removeEntry(Line line)`
`void`	`renew()` Refreshes the cached values. After entries have been inserted or removed (through `set`, `setList` or `remove` with renew set to false), this method has to be called for those changes to actually have an effect.
`boolean`	`saveConfig()`
`boolean`	`set(String path, boolean renew, Object value)` Sets the value of the item at the given path to the given value. If value is `null`, the entry is removed. NOTE: Calling this method WILL affect the actual config, but the changes may or may not be reflected in this IConfigSection. (Removals and Insertions will not affect `SectionSnapshots`, but will affect the config.)
`boolean`	`setList(String path, boolean removeComments, boolean renew, Iterable<?> value)` Sets the entry at the specified path to a list with the given value. If this path defines an already existing list entry, it is changed. If this path defines an already existing single entry, it will be changed into a list. If this path defines a non existant entry, it and required sections are created and inserted at the right position in the config.
`protected static void`	`validatePath(String path)`

Methods inherited from class nl.taico.configplus.interfaces.CSection
getBoolean, getBoolean, getBooleanList, getByte, getByte, getByteList, getChar, getChar, getCharacterList, getDouble, getDouble, getDoubleList, getFloat, getFloat, getFloatList, getInt, getInt, getIntegerList, getLong, getLong, getLongList, getMixedList, getObject, getObject, getShort, getShort, getShortList, getString, getString, getStringList, getT, getT, getTList, isBoolean, isByte, isChar, isDouble, isFloat, isInt, isLong, isShort, isString, isT, remove, removeBatch, removeBatch, setList, setList, setList

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

- Field Detail
  - path
```
protected String path
```
  - parent
```
protected ISection parent
```
- Constructor Detail
  - Section
```
public Section(ISection parent,
       String path)
```
    Parameters:
    path -
    
    Throws:
    
    IllegalArgumentException - If path is null or ends with a dot.
- Method Detail
  - getParent
```
public ISection getParent()
```
  - getSection
```
public ISection getSection(String path)
```
    Description copied from interface: ISection
    
    Gets the requested Section by path.
    Returns an empty section if it didn't exist.
    
    Parameters:
    path - - Path of the Section to get.
    
    Returns:
    Requested Section
  - getKeys
```
public Set<String> getKeys(boolean deep)
```
    Description copied from interface: ISection
    
    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 Sections (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 Section.
  - getKeys
```
public Set<String> getKeys(String path,
                  boolean deep)
```
    Description copied from interface: ISection
    
    Gets a set containing all keys that start with the given path in this section.
    If deep is set to true, then this will contain all the keys within any child Sections (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:
    path - - The path the key has to start with to be included in the returned set.
    deep - - Whether or not to get a deep list, as opposed to a shallow list.
    
    Returns:
    Set of keys contained within this Section, that start with the given path.
  - getPath
```
public String getPath()
```
    Description copied from interface: ISection
    
    Returns the path of this Section, relative to the main config.
    
    Returns:
    The path of this Section.
  - getName
```
public String getName()
```
    Description copied from interface: ISection
    
    Returns the name of this Section. This is generally the last part in this section's path sequence.
    
    Returns:
    The name of this Section.
  - get
```
public Line get(String path)
```
    Description copied from interface: ISection
    
    Gets the line with the given path.
    Returns null if no line with the given path exists.
    
    Specified by:
    
    get in interface ISection
    
    Specified by:
    
    get in class CSection
    
    Parameters:
    path - - The path of the Line to get.
    
    Returns:
    The line with the given path or null if it doesn't exist.
  - contains
```
public boolean contains(String path)
```
    Description copied from interface: ISection
    
    Returns if this section contains a list or single value for the given path.
    
    Parameters:
    path - - The path to check.
    
    Returns:
    If this section contains a list or single value for the given path.
  - remove
```
public boolean remove(String path,
             boolean renew)
```
    Description copied from interface: ISection
    
    Removes a Single value, List or Section from the config. This includes all comments inside lists and sections.
    
    NOTE: When removing a section, all entries in that section are also removed.
    
    When calling a batch of methods that change the config, its better not to update constantly, but to update once when you are done by calling ISection.renew(). For removals, this can easily be achieved by calling removeBatch(String...).
    
    WARNING: If path is "", this function will CLEAR the config.
    
    Parameters:
    path - - The path to remove.
    renew - - If the configuration should be updated to reflect the changes.
    
    Returns:
    If the config changed as a result of this method.
  - setList
```
public boolean setList(String path,
              boolean removeComments,
              boolean renew,
              Iterable<?> value)
```
    Description copied from interface: ISection
    
    Sets the entry at the specified path to a list with the given value.
    
    If this path defines an already existing list entry, it is changed.
    If this path defines an already existing single entry, it will be changed into a list.
    If this path defines a non existant entry, it and required sections are created and inserted at the right position in the config.
    
    Parameters:
    path - - The path of the list to set.
    removeComments - - If the list already exists, should comments in it be removed?
    renew - - If the map should be renewed (when applicable).
    value - - The values this list should have.
    
    Returns:
    If the config changed as a result of calling this method.
  - set
```
public boolean set(String path,
          boolean renew,
          Object value)
```
    Description copied from interface: ISection
    
    Sets the value of the item at the given path to the given value.
    If value is null, the entry is removed.
    
    NOTE: Calling this method WILL affect the actual config, but the changes may or may not be reflected in this IConfigSection.
    (Removals and Insertions will not affect SectionSnapshots, but will affect the config.)
    
    Parameters:
    path - - The path of the entry you want to change.
    renew - - If the config should be updated. Only applies for removals and insertions.
    
    Returns:
    If the config changed as a result of this call.
  - renew
```
public void renew()
```
    Description copied from interface: ISection
    
    Refreshes the cached values.
    After entries have been inserted or removed (through set, setList or remove with renew set to false), this method has to be called for those changes to actually have an effect.
  - getEntries
```
public List<Line> getEntries()
```
  - getEntries
```
public List<Line> getEntries(String path)
```
  - addEntry
```
public void addEntry(Line line)
```
  - removeEntry
```
public boolean removeEntry(Line line)
```
  - getPathTo
```
protected String getPathTo(String path)
```
  - validatePath
```
protected static void validatePath(String path)
```
  - saveConfig
```
public boolean saveConfig()
```
  - addCommentsAbove
```
public void addCommentsAbove(String path,
                    boolean belowExistingComments,
                    String... comments)
```
    Description copied from interface: ISection
    
    Adds the given comments above the Entry at the given path.
    
    Parameters:
    path - - The path of the entry to add the comments above. If path is empty, comments will be added at the top.
    belowExistingComments - - Should the given comments be added below existing ones?
    comments - - The comments to add
  - addCommentsBelow
```
public void addCommentsBelow(String path,
                    boolean belowExistingComments,
                    String... comments)
```
    Description copied from interface: ISection
    
    Adds the given comments below the Entry at the given path.
    
    Parameters:
    path - - The path of the entry to add the comments below. If path is empty, comments will be added at the top.
    belowExistingComments - - Should the given comments be added below existing ones?
    comments - - The comments to add

Class Section

Field Summary

Constructor Summary

Method Summary

Methods inherited from class nl.taico.configplus.interfaces.CSection

Methods inherited from class java.lang.Object

Field Detail

path

parent

Constructor Detail

Section

Method Detail

getParent

getSection

getKeys

getKeys

getPath

getName

get

contains

remove

setList

set

renew

getEntries

getEntries

addEntry

removeEntry

getPathTo

validatePath

saveConfig

addCommentsAbove

addCommentsBelow