Package org.bukkit.configuration.file

Class YamlConfiguration

java.lang.Object

org.bukkit.configuration.MemorySection

org.bukkit.configuration.MemoryConfiguration

org.bukkit.configuration.file.FileConfiguration

org.bukkit.configuration.file.YamlConfiguration

All Implemented Interfaces:

Configuration, ConfigurationSection

public class YamlConfiguration
extends FileConfiguration

An implementation of Configuration which saves all files in Yaml. Note that this implementation is not synchronized.

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	BLANK_CONFIG
protected static java.lang.String	COMMENT_PREFIX

Fields inherited from class org.bukkit.configuration.MemoryConfiguration

defaults, options

Fields inherited from class org.bukkit.configuration.MemorySection

map

Constructor Summary

Constructors

Constructor	Description
YamlConfiguration()

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	buildHeader()	Compiles the header for this FileConfiguration and returns the result.
protected void	convertMapsToSections(java.util.Map<?,?> input, ConfigurationSection section)
static YamlConfiguration	loadConfiguration(java.io.File file)	Creates a new YamlConfiguration, loading from the given file.
static YamlConfiguration	loadConfiguration(java.io.InputStream stream)	Deprecated. does not properly consider encoding
static YamlConfiguration	loadConfiguration(java.io.Reader reader)	Creates a new YamlConfiguration, loading from the given reader.
void	loadFromString(java.lang.String contents)	Loads this FileConfiguration from the specified string, as opposed to from file.
YamlConfigurationOptions	options()	Gets the ConfigurationOptions for this Configuration.
protected java.lang.String	parseHeader(java.lang.String input)
java.lang.String	saveToString()	Saves this FileConfiguration to a string, and returns it.

Methods inherited from interface org.bukkit.configuration.ConfigurationSection

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

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

load, 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, contains, createPath, createPath, createSection, createSection, get, get, getBoolean, getBoolean, getBooleanList, getByteList, getCharacterList, getColor, getColor, getConfigurationSection, getCurrentPath, getDefault, 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, isPrimitiveWrapper, isSet, isString, isVector, mapChildrenKeys, mapChildrenValues, set, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COMMENT_PREFIX

protected static final java.lang.String COMMENT_PREFIX

See Also:

Constant Field Values

BLANK_CONFIG

protected static final java.lang.String BLANK_CONFIG

See Also:

Constant Field Values

Constructor Detail

YamlConfiguration

public YamlConfiguration()

Method Detail

saveToString

public java.lang.String saveToString()

Description copied from class: FileConfiguration

Saves this FileConfiguration to a string, and returns it.

Specified by:

saveToString in class FileConfiguration

Returns:

String containing this configuration.

loadFromString

public void loadFromString(java.lang.String contents)
                    throws InvalidConfigurationException

Description copied from class: FileConfiguration

Loads this FileConfiguration from the specified string, as opposed to from file.

All the values contained within this configuration will be removed, leaving only settings and defaults, and the new values will be loaded from the given string.

If the string is invalid in any way, an exception will be thrown.

Specified by:

loadFromString in class FileConfiguration

Parameters:

contents - Contents of a Configuration to load.

Throws:

InvalidConfigurationException - Thrown if the specified string is invalid.

convertMapsToSections

protected void convertMapsToSections(java.util.Map<?,?> input,
                                     ConfigurationSection section)

parseHeader

protected java.lang.String parseHeader(java.lang.String input)

buildHeader

protected java.lang.String buildHeader()

Description copied from class: FileConfiguration

Compiles the header for this FileConfiguration and returns the result.

This will use the header from FileConfiguration.options() -> FileConfigurationOptions.header(), respecting the rules of FileConfigurationOptions.copyHeader() if set.

Specified by:

buildHeader in class FileConfiguration

Returns:

Compiled header

options

public YamlConfigurationOptions options()

Description copied from interface: Configuration

Gets the ConfigurationOptions for this Configuration.

All setters through this method are chainable.

Specified by:

options in interface Configuration

Overrides:

options in class FileConfiguration

Returns:

Options for this configuration

loadConfiguration

public static YamlConfiguration loadConfiguration(java.io.File file)

Creates a new YamlConfiguration, loading from the given file.

Any errors loading the Configuration will be logged and then ignored. If the specified input is not a valid config, a blank config will be returned.

The encoding used may follow the system dependent default.

Parameters:

file - Input file

Returns:

Resulting configuration

Throws:

java.lang.IllegalArgumentException - Thrown if file is null

loadConfiguration

@Deprecated
public static YamlConfiguration loadConfiguration(java.io.InputStream stream)

Deprecated. does not properly consider encoding

Creates a new YamlConfiguration, loading from the given stream.

Any errors loading the Configuration will be logged and then ignored. If the specified input is not a valid config, a blank config will be returned.

Parameters:

stream - Input stream

Returns:

Resulting configuration

Throws:

java.lang.IllegalArgumentException - Thrown if stream is null

See Also:

FileConfiguration.load(InputStream), loadConfiguration(Reader)

loadConfiguration

public static YamlConfiguration loadConfiguration(java.io.Reader reader)

Creates a new YamlConfiguration, loading from the given reader.

Any errors loading the Configuration will be logged and then ignored. If the specified input is not a valid config, a blank config will be returned.

Parameters:

reader - input

Returns:

resulting configuration

Throws:

java.lang.IllegalArgumentException - Thrown if stream is null