nl.taico.configplus

Class Config

java.lang.Object

nl.taico.configplus.interfaces.CSection

nl.taico.configplus.Config

All Implemented Interfaces:

IBasicSection, IConfig, ISection

Direct Known Subclasses:

BukkitConfig

public class Config
extends CSection
implements IConfig

Represents a YAML Config. It may or may not be loaded.

Main advantages:

• Preserves comments and empty lines
• Preserves placement of comments as best as it can
• Does not use a YAML dependency (In fact, does not use YAML at all)
• Per line control
• Quotes are only added for Strings with leading/trailing whitespace, with quotes or with :
• Mixed lists (YAML probably has that as well)
• If you want to change a list to the short format, thats totally possible
• You can add/remove elements and sections easily.
• Thread-safe concurrent read access
• Thread-safe concurrent changing of values and lists
• Blocking removal/addition
• Non blocking reloads

Disadvantages:

• Probably not so efficient
• There are no defaults

Notes:

• Everything is a String at its core (isString() is true).
• getFloat() will work totally fine as long as the value is a Number
• Things are cached
• It is possible to add/remove elements to the config that will not be reflected in getX(String path) until renew() is called.

For easy usage, see getNewConfig(Logger, File, String)

Field Summary

Fields

Modifier and Type	Field and Description
protected File	file
protected List<String>	lines The original contents of the config file.
protected List<Line>	lines2 Holds the converted configuration.
protected ReentrantReadWriteLock	lock
protected Logger	logger
protected LinkedHashMap<String,Line>	map Allows fast, non blocking access to this configuration, only contains ValueLines and ListLines.

Constructor Summary

Constructors

Constructor and Description
Config(Logger logger, File file)
Config(Logger logger, File folder, String filename)

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)
protected boolean	changeTo(Line line, boolean renew)
void	clear() Clears the memory configuration.
boolean	contains(String path) Returns if this section contains a list or single value for the given path.
protected String	convert(Object value) Convenience method for overriding classes :)
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.
Set<String>	getKeys(String path, boolean deep, boolean strippath)
protected Logger	getLogger() Convenience for overriding classes :)
String	getName() Returns the name of this Section.
static Config	getNewConfig(Logger logger, File folder, String name) Creates a new config and loads it. If the file doesn't exist, will save the default config. Example usage: public static Config config; public void load(){ config = Config.getNewConfig(this.getLogger(), new File(""), "config.yml"); } You can then get values by doing: String str = config.getString("path.to.str"); int i = config.getInt("path.to.i"); List<Boolean> booleans = config.getBooleanList("path.to.list"); ISection section1 = config.getSection("Section1"); //Gets Section1.hey, if it doesn't exist, returns 20. int hey = section1.getInt("hey", 20); You can set values like so: config.set("Section1.tutorial", "This is a tutorial!"); config.set("Section1.tutorial", null); //removes tuturial config.remove("Section1"); //Removes Section1 and everything in it List<String> l = new ArrayList<>(); l.add("Entry 1"); l.add("Entry 2"); config.set("Section1.list", l); //You can also keep comments that were in Section1.list config.setList("Section1.list", false, l); //Don't forget to save. config.saveConfig();
protected ListLine	getNewListLine(String path, boolean shorttype) Can by overridden by classes that override this class to implement a different type of ListLine. Now you don't have to rewrite parse() :)
protected ValueLine	getNewValueLine(String path, String value) Can by overridden by classes that override this class to implement a different type of ValueLine. Now you don't have to rewrite parse() :)
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.
ISection	getSectionSnapshot(String path) Deprecated. Not all functions work as you would expect them to. Please use getSection(String) instead.
protected void	insertCorrectly(Line line, boolean renew)
boolean	load() (Re)loads this config from disk.
boolean	load(File file)
boolean	reloadConfig() Reloads this config from disk.
boolean	remove(String path, boolean renew) Removes a Single value, List or Section from the config.
int	removeComment(String comment, boolean caseSensitive, int amount) Removes matching comments from this 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() Saves this config and returns its success.
boolean	saveDefaultConfig() Saves the default config if this config file doesn't exist yet. Otherwise does nothing.
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.

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

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

remove, removeBatch, removeBatch, setList, setList, setList

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

Field Detail

lock

protected final ReentrantReadWriteLock lock

lines

protected List<String> lines

The original contents of the config file.

lines2

protected List<Line> lines2

Holds the converted configuration.

map

protected LinkedHashMap<String,Line> map

Allows fast, non blocking access to this configuration, only contains ValueLines and ListLines.

file

protected File file

logger

protected Logger logger

Constructor Detail

Config

public Config(Logger logger,
      File folder,
      String filename)

Config

public Config(Logger logger,
      File file)

Method Detail

getNewConfig

public static Config getNewConfig(Logger logger,
                  File folder,
                  String name)

Creates a new config and loads it.
If the file doesn't exist, will save the default config.

Example usage:
public static Config config;

public void load(){
config = Config.getNewConfig(this.getLogger(), new File(""), "config.yml");
}

You can then get values by doing:
String str = config.getString("path.to.str");
int i = config.getInt("path.to.i");
List<Boolean> booleans = config.getBooleanList("path.to.list");

ISection section1 = config.getSection("Section1");
//Gets Section1.hey, if it doesn't exist, returns 20.
int hey = section1.getInt("hey", 20);

You can set values like so:
config.set("Section1.tutorial", "This is a tutorial!");
config.set("Section1.tutorial", null); //removes tuturial
config.remove("Section1"); //Removes Section1 and everything in it

List<String> l = new ArrayList<>();
l.add("Entry 1");
l.add("Entry 2");
config.set("Section1.list", l);
//You can also keep comments that were in Section1.list
config.setList("Section1.list", false, l);

//Don't forget to save.
config.saveConfig();


Parameters:

logger - - The logger where warnings are logged.

folder - - The folder where this config should go.

name - - The name of this config.

Throws:

IllegalArgumentException - If logger is null.

IllegalArgumentException - If folder is null.

IllegalArgumentException - If name is null, empty or ends with a dot (.).

load

public boolean load()

Description copied from interface: IConfig

(Re)loads this config from disk.

Specified by:

load in interface IConfig

Returns:

True if this config was successfully loaded.

load

public boolean load(File file)

reloadConfig

public boolean reloadConfig()

Reloads this config from disk.

Specified by:

reloadConfig in interface IConfig

Returns:

Whether this config was successfully loaded.

See Also:

IConfig.load()

saveDefaultConfig

public boolean saveDefaultConfig()

Saves the default config if this config file doesn't exist yet.
Otherwise does nothing.

Specified by:

saveDefaultConfig in interface IConfig

Returns:

If the default config was saved.

saveConfig

public boolean saveConfig()

Saves this config and returns its success.

Specified by:

saveConfig in interface IConfig

Specified by:

saveConfig in interface ISection

Returns:

If the saving succeeded.

clear

public void clear()

Clears the memory configuration. (Non blocking - Concurrency Safe).

Specified by:

clear in interface IConfig

getNewValueLine

protected ValueLine getNewValueLine(String path,
                        String value)

Can by overridden by classes that override this class to implement a different type of ValueLine.
Now you don't have to rewrite parse() :)

Returns:

new ValueLine(path, value);

getNewListLine

protected ListLine getNewListLine(String path,
                      boolean shorttype)

Can by overridden by classes that override this class to implement a different type of ListLine.
Now you don't have to rewrite parse() :)

Returns:

new ListLine(path, shorttype);

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.

Specified by:

renew in interface ISection

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.

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.

Specified by:

getKeys in interface ISection

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.

Specified by:

getKeys in interface ISection

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.

getKeys

public Set<String> getKeys(String path,
                  boolean deep,
                  boolean strippath)

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.

Specified by:

getName in interface ISection

Returns:

""

getPath

public String getPath()

Description copied from interface: ISection

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

Specified by:

getPath in interface ISection

Returns:

""

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.

Specified by:

contains in interface ISection

Parameters:

path - - The path to check.

Returns:

If this section contains a list or single value for the given path.

getParent

public ISection getParent()

Specified by:

getParent in interface ISection

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.

Specified by:

getSection in interface ISection

Parameters:

path - - Path of the Section to get.

Returns:

Requested Section

getSectionSnapshot

@Deprecated
public ISection getSectionSnapshot(String path)

Deprecated. Not all functions work as you would expect them to. Please use getSection(String) instead.

Gets a Snapshot of the requested Section by path.
This snapshot will not reflect additions and removals, but will reflect changes to entries.

Returns an empty SectionSnapshot if it didn't exist.

Parameters:

path - - Path of the Section to get a SnapShot of.

Returns:

A snapshot of the requested section.

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.

Specified by:

addCommentsAbove in interface ISection

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.

Specified by:

addCommentsBelow in interface ISection

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

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.

Specified by:

remove in interface ISection

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.

removeComment

public int removeComment(String comment,
                boolean caseSensitive,
                int amount)

Removes matching comments from this Config.

Parameters:

comment - - The comment to remove.

caseSensitive - - If it should scan for comments case sensitive.

amount - - The max amount of comments to remove. -1 is infinite.

Returns:

The amount of comments that were removed.

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.

Specified by:

setList in interface ISection

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

Specified by:

set in interface ISection

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.

convert

protected String convert(Object value)

Convenience method for overriding classes :)

getEntries

public List<Line> getEntries()

Specified by:

getEntries in interface ISection

getEntries

public List<Line> getEntries(String path)

Specified by:

getEntries in interface ISection

addEntry

public void addEntry(Line line)

Specified by:

addEntry in interface ISection

removeEntry

public boolean removeEntry(Line line)

Specified by:

removeEntry in interface ISection

insertCorrectly

protected void insertCorrectly(Line line,
                   boolean renew)

changeTo

protected boolean changeTo(Line line,
               boolean renew)

getLogger

protected Logger getLogger()

Convenience for overriding classes :)