com.palmergames.bukkit.config

Class CommentedConfiguration

java.lang.Object

org.bukkit.configuration.MemorySection

org.bukkit.configuration.MemoryConfiguration

org.bukkit.configuration.file.FileConfiguration

org.bukkit.configuration.file.YamlConfiguration

com.palmergames.bukkit.config.CommentedConfiguration

All Implemented Interfaces:

org.bukkit.configuration.Configuration, org.bukkit.configuration.ConfigurationSection

public class CommentedConfiguration
extends org.bukkit.configuration.file.YamlConfiguration

Author:

dumptruckman

Constructor Summary

Constructors

Constructor and Description
CommentedConfiguration(java.io.File file)

Method Summary

Methods

Modifier and Type	Method and Description
void	addComment(java.lang.String path, java.lang.String... commentLines) Adds a comment just before the specified path.
boolean	load()
boolean	save()

Methods inherited from class org.bukkit.configuration.file.YamlConfiguration

loadConfiguration, loadConfiguration, loadFromString, options, saveToString

Methods inherited from class org.bukkit.configuration.file.FileConfiguration

load, load, load, save, save

Methods inherited from class org.bukkit.configuration.MemoryConfiguration

addDefault, addDefaults, addDefaults, getDefaults, getParent, setDefaults

Methods inherited from class org.bukkit.configuration.MemorySection

contains, createPath, createPath, createSection, createSection, get, get, getBoolean, getBoolean, getBooleanList, getByteList, getCharacterList, getColor, getColor, getConfigurationSection, getCurrentPath, getDefaultSection, getDouble, getDouble, getDoubleList, getFloatList, getInt, getInt, getIntegerList, getItemStack, getItemStack, getKeys, getList, getList, getLong, getLong, getLongList, getMapList, getName, getOfflinePlayer, getOfflinePlayer, getRoot, getShortList, getString, getString, getStringList, getValues, getVector, getVector, isBoolean, isColor, isConfigurationSection, isDouble, isInt, isItemStack, isList, isLong, isOfflinePlayer, isSet, isString, isVector, set, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.bukkit.configuration.ConfigurationSection

contains, createSection, createSection, get, get, getBoolean, getBoolean, getBooleanList, getByteList, getCharacterList, getColor, getColor, getConfigurationSection, getCurrentPath, getDefaultSection, getDouble, getDouble, getDoubleList, getFloatList, getInt, getInt, getIntegerList, getItemStack, getItemStack, getKeys, getList, getList, getLong, getLong, getLongList, getMapList, getName, getOfflinePlayer, getOfflinePlayer, getRoot, getShortList, getString, getString, getStringList, getValues, getVector, getVector, isBoolean, isColor, isConfigurationSection, isDouble, isInt, isItemStack, isList, isLong, isOfflinePlayer, isSet, isString, isVector, set

Constructor Detail

CommentedConfiguration

public CommentedConfiguration(java.io.File file)

Method Detail

load

public boolean load()

save

public boolean save()

addComment

public void addComment(java.lang.String path,
              java.lang.String... commentLines)

Adds a comment just before the specified path. The comment can be multiple lines. An empty string will indicate a blank line.

Parameters:

path - Configuration path to add comment.

commentLines - Comments to add. One String per line.