nl.taico.configplus.interfaces

Interface ISection

All Superinterfaces:

IBasicSection

All Known Subinterfaces:

IBukkitSection, IConfig

All Known Implementing Classes:

BukkitConfig, BukkitSection, BukkitSectionSnapshot, Config, CSection, Section, SectionSnapshot

public interface ISection
extends IBasicSection

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.
ISection	getSection(String path) Gets the requested Section by path. Returns an empty section if it didn't exist.
boolean	remove(String path) Removes a Single value, List or Section from the config.
boolean	remove(String path, boolean renew) Removes a Single value, List or Section from the config.
boolean	removeBatch(Iterable<String> paths) Removes a batch of entries from the config.
boolean	removeBatch(String... paths) Removes a batch of entries 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.
boolean	setList(String path, boolean removeComments, boolean renew, Object... values) Converts the given values into a list and passes it to setList(String, boolean, boolean, Iterable)
boolean	setList(String path, boolean removeComments, Iterable<?> value) Shortcut for setList(path, removeComments, true, value)
boolean	setList(String path, Iterable<?> value) Shortcut for setList(path, true, true, value)

Methods inherited from interface nl.taico.configplus.interfaces.IBasicSection

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

Method Detail

getParent

ISection getParent()

getSection

ISection getSection(String path)

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

Throws:

IllegalArgumentException - if path is null or ends with a dot.

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 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

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.

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.

Throws:

IllegalArgumentException - if path is null or ends with a dot.

getPath

String getPath()

Returns the path of this Section, relative to the main config.

Returns:

The path of this Section.

getName

String getName()

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

Line get(String path)

Gets the line with the given path.
Returns null if no line with the given path exists.

Parameters:

path - - The path of the Line to get.

Returns:

The line with the given path or null if it doesn't exist.

contains

boolean contains(String path)

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.

addCommentsAbove

void addCommentsAbove(String path,
                    boolean belowExistingComments,
                    String... comments)

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

Throws:

IllegalArgumentException - if comments is empty.

IllegalArgumentException - if path is null or ends with a dot.

addCommentsBelow

void addCommentsBelow(String path,
                    boolean belowExistingComments,
                    String... comments)

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

Throws:

IllegalArgumentException - if comments is empty.

IllegalArgumentException - if path is null or ends with a dot.

remove

boolean remove(String path)

Removes a Single value, List or Section from the config. This includes all comments inside lists and sections.

See remove(String, true) for more information.

remove

boolean remove(String path,
             boolean renew)

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

removeBatch

boolean removeBatch(Iterable<String> paths)

Removes a batch of entries from the config.

Parameters:

paths - - The paths that should be removed from this config.

Returns:

If the config changed as a result of this method.

See Also:

remove(String)

removeBatch

boolean removeBatch(String... paths)

Removes a batch of entries from the config.

Parameters:

paths - - The paths that should be removed from this config.

Returns:

If the config changed as a result of this method.

See Also:

remove(String)

setList

boolean setList(String path,
              Iterable<?> value)

Shortcut for setList(path, true, true, value)

setList

boolean setList(String path,
              boolean removeComments,
              Iterable<?> value)

Shortcut for setList(path, removeComments, true, value)

setList

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.

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.

setList

boolean setList(String path,
              boolean removeComments,
              boolean renew,
              Object... values)

Converts the given values into a list and passes it to setList(String, boolean, boolean, Iterable)

See Also:

setList(String, boolean, boolean, Iterable)

set

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.)

Parameters:

path - - The path of the entry you want to change.

renew - - If the config should be updated. Only applies for removals and insertions.

value -

Returns:

If the config changed as a result of this call.

getEntries

List<Line> getEntries()

getEntries

List<Line> getEntries(String path)

addEntry

void addEntry(Line line)

removeEntry

boolean removeEntry(Line line)

renew

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.

saveConfig

boolean saveConfig()