nl.taico.configplus.bukkit

Class BukkitConfig

java.lang.Object

nl.taico.configplus.interfaces.CSection

nl.taico.configplus.Config

nl.taico.configplus.bukkit.BukkitConfig

All Implemented Interfaces:

IBukkitSection, IBasicSection, IConfig, ISection, org.bukkit.configuration.ConfigurationSection

public class BukkitConfig
extends Config
implements IBukkitSection

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
• If you like the Bukkit API: most of it is implemented. Feel free to cast to a Bukkit ConfigurationSection if you like.

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 Config.renew() is called.

For easy usage, see getNewConfig(Plugin, String)

Field Summary

Fields inherited from class nl.taico.configplus.Config

file, lines, lines2, lock, logger, map

Constructor Summary

Constructors

Constructor and Description
BukkitConfig(org.bukkit.plugin.Plugin plugin, File file)
BukkitConfig(org.bukkit.plugin.Plugin plugin, String filename)

Method Summary

Methods

Modifier and Type	Method and Description
void	addDefault(String path, Object value) Deprecated.
protected String	convert(Object value) Convenience method for overriding classes :)
org.bukkit.configuration.ConfigurationSection	createSection(String path) Deprecated.
org.bukkit.configuration.ConfigurationSection	createSection(String path, Map<?,?> map) Deprecated.
Object	get(String path, Object def)
org.bukkit.Color	getColor(String path)
org.bukkit.Color	getColor(String path, org.bukkit.Color def)
String	getColoredString(String path)
String	getColoredString(String path, String def)
List<String>	getColoredStringList(String path)
List<org.bukkit.Color>	getColorList(String path)
IBukkitSection	getConfigurationSection(String path)
String	getCurrentPath()
org.bukkit.configuration.ConfigurationSection	getDefaultSection() Deprecated.
org.bukkit.inventory.ItemStack	getItemStack(String path) Gets the requested ItemStack by path. If the ItemStack does not exist or the value at this path is not an ItemStack, this will return null. WARNING: Only saves the ID, Damage and Amount.
org.bukkit.inventory.ItemStack	getItemStack(String path, org.bukkit.inventory.ItemStack def) Gets the requested ItemStack by path. If the ItemStack does not exist or the value at this path is not an ItemStack, this will return def. WARNING: Only saves the ID, Damage and Amount.
List<?>	getList(String path)
List<?>	getList(String path, List<?> def)
org.bukkit.Location	getLocation(String path)
org.bukkit.Location	getLocation(String path, org.bukkit.Location def)
org.bukkit.Location	getLocation(String path, org.bukkit.World world)
org.bukkit.Location	getLocation(String path, org.bukkit.World world, org.bukkit.Location def)
List<org.bukkit.Location>	getLocationList(String path) Gets the List of Locations at the given path Will convert all applicable values into Locations (world|x|y|z or world|x|y|z|yaw|pitch format). If no values are applicable, this will return an empty list.
List<org.bukkit.Location>	getLocationList(String path, org.bukkit.World world) Gets the List of Locations at the given path Will convert all applicable values into Locations (x|y|z or x|y|z|yaw|pitch format). If no values are applicable, this will return an empty list.
List<Map<?,?>>	getMapList(String path) Deprecated.
static BukkitConfig	getNewConfig(org.bukkit.plugin.Plugin plugin, 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 onLoad(){ config = Config.getNewConfig(this, "config.yml"); } You can then get values by doing: String str = config.getString("path.to.str"); int i = config.getInt("path.to.i"); Location loc = config.getLocation("path.to.location"); List<Boolean> booleans = config.getBooleanList("path.to.list"); IConfigSection 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 BukkitListLine	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 Config.parse() :)
protected BukkitValueLine	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 Config.parse() :)
org.bukkit.OfflinePlayer	getOfflinePlayer(String path)
org.bukkit.OfflinePlayer	getOfflinePlayer(String path, org.bukkit.OfflinePlayer def)
BukkitConfig	getParent()
org.bukkit.configuration.Configuration	getRoot()
IBukkitSection	getSection(String path) Gets the requested Section by path. Returns an empty section if it didn't exist.
IBukkitSection	getSectionSnapshot(String path) Deprecated. Not all functions work as you would expect them to. Please use getSection(String) instead.
Map<String,Object>	getValues(boolean deep) Deprecated.
org.bukkit.util.Vector	getVector(String path) Deprecated.
org.bukkit.util.Vector	getVector(String path, org.bukkit.util.Vector def) Deprecated.
boolean	isColor(String path)
boolean	isConfigurationSection(String path) Deprecated.
boolean	isItemStack(String path)
boolean	isList(String path)
boolean	isLocation(String path)
boolean	isLocationNoWorld(String path)
boolean	isOfflinePlayer(String path)
boolean	isSet(String path)
boolean	isVector(String path) Deprecated.
void	set(String path, Object value) Sets the value of the item at the given path to the given value. If value is null, the entry is removed. This is a shortcut for set(path, true, value)

Methods inherited from class nl.taico.configplus.Config

addCommentsAbove, addCommentsBelow, addEntry, changeTo, clear, contains, get, getConfigFile, getEntries, getEntries, getKeys, getKeys, getKeys, getLogger, getName, getNewConfig, getPath, insertCorrectly, load, load, reloadConfig, remove, removeComment, removeEntry, renew, saveConfig, saveDefaultConfig, set, setList

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

addCommentsAbove, addCommentsBelow, addEntry, contains, get, getEntries, getEntries, getKeys, getKeys, getName, getPath, remove, remove, removeBatch, removeBatch, removeEntry, renew, saveConfig, set, setList, 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

Methods inherited from interface org.bukkit.configuration.ConfigurationSection

contains, get, getBoolean, getBoolean, getBooleanList, getByteList, getCharacterList, getDouble, getDouble, getDoubleList, getFloatList, getInt, getInt, getIntegerList, getKeys, getLong, getLong, getLongList, getName, getShortList, getString, getString, getStringList, isBoolean, isDouble, isInt, isLong, isString

Constructor Detail

BukkitConfig

public BukkitConfig(org.bukkit.plugin.Plugin plugin,
            String filename)

BukkitConfig

public BukkitConfig(org.bukkit.plugin.Plugin plugin,
            File file)

Method Detail

getNewConfig

public static BukkitConfig getNewConfig(org.bukkit.plugin.Plugin plugin,
                        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 onLoad(){
config = Config.getNewConfig(this, "config.yml");
}

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

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

plugin - - The plugin this config belongs to.

name - - The name of this config.

Throws:

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

IllegalArgumentException - If plugin is null.

getNewListLine

protected BukkitListLine getNewListLine(String path,
                            boolean shorttype)

Description copied from class: Config

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

Overrides:

getNewListLine in class Config

Returns:

new ListLine(path, shorttype);

getNewValueLine

protected BukkitValueLine getNewValueLine(String path,
                              String value)

Description copied from class: Config

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

Overrides:

getNewValueLine in class Config

Returns:

new ValueLine(path, value);

convert

protected String convert(Object value)

Description copied from class: Config

Convenience method for overriding classes :)

Overrides:

convert in class Config

set

public void set(String path,
       Object value)

Sets the value of the item at the given path to the given value.
If value is null, the entry is removed.

This is a shortcut for set(path, true, value)

Specified by:

set in interface org.bukkit.configuration.ConfigurationSection

Parameters:

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

getSection

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

Specified by:

getSection in interface ISection

Overrides:

getSection in class Config

Parameters:

path - - Path of the Section to get.

Returns:

Requested Section

getSectionSnapshot

public IBukkitSection getSectionSnapshot(String path)

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

Description copied from class: Config

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.

Overrides:

getSectionSnapshot in class Config

Parameters:

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

Returns:

A snapshot of the requested section.

getParent

public BukkitConfig getParent()

Specified by:

getParent in interface IBukkitSection

Specified by:

getParent in interface ISection

Specified by:

getParent in interface org.bukkit.configuration.ConfigurationSection

Overrides:

getParent in class Config

addDefault

@Deprecated
public void addDefault(String path,
                         Object value)

Deprecated.

Specified by:

addDefault in interface org.bukkit.configuration.ConfigurationSection

createSection

@Deprecated
public org.bukkit.configuration.ConfigurationSection createSection(String path)

Deprecated.

Specified by:

createSection in interface org.bukkit.configuration.ConfigurationSection

createSection

@Deprecated
public org.bukkit.configuration.ConfigurationSection createSection(String path,
                                                                     Map<?,?> map)

Deprecated.

Specified by:

createSection in interface org.bukkit.configuration.ConfigurationSection

get

public Object get(String path,
         Object def)

Specified by:

get in interface org.bukkit.configuration.ConfigurationSection

getColor

public final org.bukkit.Color getColor(String path)

Specified by:

getColor in interface org.bukkit.configuration.ConfigurationSection

getColor

public org.bukkit.Color getColor(String path,
                        org.bukkit.Color def)

Specified by:

getColor in interface org.bukkit.configuration.ConfigurationSection

getColorList

public List<org.bukkit.Color> getColorList(String path)

getConfigurationSection

public IBukkitSection getConfigurationSection(String path)

Specified by:

getConfigurationSection in interface IBukkitSection

Specified by:

getConfigurationSection in interface org.bukkit.configuration.ConfigurationSection

getCurrentPath

public String getCurrentPath()

Specified by:

getCurrentPath in interface org.bukkit.configuration.ConfigurationSection

getDefaultSection

@Deprecated
public org.bukkit.configuration.ConfigurationSection getDefaultSection()

Deprecated.

Specified by:

getDefaultSection in interface org.bukkit.configuration.ConfigurationSection

getLocation

public org.bukkit.Location getLocation(String path)

Specified by:

getLocation in interface IBukkitSection

getLocation

public org.bukkit.Location getLocation(String path,
                              org.bukkit.Location def)

Specified by:

getLocation in interface IBukkitSection

getLocationList

public List<org.bukkit.Location> getLocationList(String path)

Description copied from interface: IBukkitSection

Gets the List of Locations at the given path
Will convert all applicable values into Locations (world|x|y|z or world|x|y|z|yaw|pitch format).
If no values are applicable, this will return an empty list.

Specified by:

getLocationList in interface IBukkitSection

Returns:

Requested List of Location.

isLocation

public boolean isLocation(String path)

Specified by:

isLocation in interface IBukkitSection

getLocation

public org.bukkit.Location getLocation(String path,
                              org.bukkit.World world)

Specified by:

getLocation in interface IBukkitSection

getLocation

public org.bukkit.Location getLocation(String path,
                              org.bukkit.World world,
                              org.bukkit.Location def)

Specified by:

getLocation in interface IBukkitSection

getLocationList

public List<org.bukkit.Location> getLocationList(String path,
                                        org.bukkit.World world)

Description copied from interface: IBukkitSection

Gets the List of Locations at the given path
Will convert all applicable values into Locations (x|y|z or x|y|z|yaw|pitch format).
If no values are applicable, this will return an empty list.

Specified by:

getLocationList in interface IBukkitSection

world - - The world that the locations should use.

Returns:

Requested List of Location.

isLocationNoWorld

public boolean isLocationNoWorld(String path)

Specified by:

isLocationNoWorld in interface IBukkitSection

getColoredString

public String getColoredString(String path)

Specified by:

getColoredString in interface IBukkitSection

getColoredString

public String getColoredString(String path,
                      String def)

Specified by:

getColoredString in interface IBukkitSection

getColoredStringList

public List<String> getColoredStringList(String path)

Specified by:

getColoredStringList in interface IBukkitSection

getItemStack

public final org.bukkit.inventory.ItemStack getItemStack(String path)

Gets the requested ItemStack by path.
If the ItemStack does not exist or the value at this path is not an ItemStack, this will return null.

WARNING: Only saves the ID, Damage and Amount. Does not preserve ItemMeta or enchantments!

Specified by:

getItemStack in interface org.bukkit.configuration.ConfigurationSection

Parameters:

path - - Path of the ItemStack to get.

Returns:

Requested ItemStack

getItemStack

public org.bukkit.inventory.ItemStack getItemStack(String path,
                                          org.bukkit.inventory.ItemStack def)

Gets the requested ItemStack by path.
If the ItemStack does not exist or the value at this path is not an ItemStack, this will return def.

WARNING: Only saves the ID, Damage and Amount. Does not preserve ItemMeta or enchantments!

Specified by:

getItemStack in interface org.bukkit.configuration.ConfigurationSection

Parameters:

path - - Path of the ItemStack to get.

def - - The value that will be returned if this value does not exist or is not an ItemStack.

Returns:

Requested ItemStack

getList

public List<?> getList(String path)

Specified by:

getList in interface org.bukkit.configuration.ConfigurationSection

getList

public List<?> getList(String path,
              List<?> def)

Specified by:

getList in interface org.bukkit.configuration.ConfigurationSection

getMapList

@Deprecated
public List<Map<?,?>> getMapList(String path)

Deprecated.

Specified by:

getMapList in interface org.bukkit.configuration.ConfigurationSection

getOfflinePlayer

public final org.bukkit.OfflinePlayer getOfflinePlayer(String path)

Specified by:

getOfflinePlayer in interface org.bukkit.configuration.ConfigurationSection

getOfflinePlayer

public org.bukkit.OfflinePlayer getOfflinePlayer(String path,
                                        org.bukkit.OfflinePlayer def)

Specified by:

getOfflinePlayer in interface org.bukkit.configuration.ConfigurationSection

getRoot

public org.bukkit.configuration.Configuration getRoot()

Specified by:

getRoot in interface org.bukkit.configuration.ConfigurationSection

getValues

@Deprecated
public Map<String,Object> getValues(boolean deep)

Deprecated.

Specified by:

getValues in interface org.bukkit.configuration.ConfigurationSection

getVector

@Deprecated
public org.bukkit.util.Vector getVector(String path)

Deprecated.

Specified by:

getVector in interface org.bukkit.configuration.ConfigurationSection

getVector

@Deprecated
public org.bukkit.util.Vector getVector(String path,
                                          org.bukkit.util.Vector def)

Deprecated.

Specified by:

getVector in interface org.bukkit.configuration.ConfigurationSection

isColor

public boolean isColor(String path)

Specified by:

isColor in interface org.bukkit.configuration.ConfigurationSection

isConfigurationSection

@Deprecated
public boolean isConfigurationSection(String path)

Deprecated.

Specified by:

isConfigurationSection in interface org.bukkit.configuration.ConfigurationSection

isItemStack

public boolean isItemStack(String path)

Specified by:

isItemStack in interface org.bukkit.configuration.ConfigurationSection

isList

public boolean isList(String path)

Specified by:

isList in interface org.bukkit.configuration.ConfigurationSection

isOfflinePlayer

public boolean isOfflinePlayer(String path)

Specified by:

isOfflinePlayer in interface org.bukkit.configuration.ConfigurationSection

isSet

public boolean isSet(String path)

Specified by:

isSet in interface org.bukkit.configuration.ConfigurationSection

isVector

@Deprecated
public boolean isVector(String path)

Deprecated.

Specified by:

isVector in interface org.bukkit.configuration.ConfigurationSection