Package com.plotsquared.core.configuration.file

Class YamlConfiguration

java.lang.Object

com.plotsquared.core.configuration.MemorySection

com.plotsquared.core.configuration.MemoryConfiguration

com.plotsquared.core.configuration.file.FileConfiguration

com.plotsquared.core.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 inherited from class com.plotsquared.core.configuration.MemoryConfiguration

defaults, options

Fields inherited from class com.plotsquared.core.configuration.MemorySection

map

Constructor Summary

Constructors

Constructor	Description
YamlConfiguration()

Method Summary

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

Methods inherited from class com.plotsquared.core.configuration.file.FileConfiguration

load, load, save

Methods inherited from class com.plotsquared.core.configuration.MemoryConfiguration

addDefault, addDefaults, addDefaults, getDefaults, getParent, setDefaults

Methods inherited from class com.plotsquared.core.configuration.MemorySection

contains, createPath, createPath, createSection, createSection, get, get, getBoolean, getBoolean, getBooleanList, getByteList, getCharacterList, getConfigurationSection, getCurrentPath, getDefault, getDefaultSection, getDouble, getDouble, getDoubleList, getFloatList, getInt, getInt, getIntegerList, getKeys, getList, getList, getLong, getLong, getLongList, getMapList, getName, getRoot, getShortList, getString, getString, getStringList, getValues, isBoolean, isConfigurationSection, isDouble, isInt, isList, isLong, isPrimitiveWrapper, isSet, isString, mapChildrenKeys, mapChildrenValues, set, toDouble, toInt, toLong, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.plotsquared.core.configuration.ConfigurationSection

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

Constructor Details

YamlConfiguration

public YamlConfiguration()

Method Details

loadConfiguration

public static YamlConfiguration loadConfiguration(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

saveToString

public 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(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(Map<?,?> input,
 ConfigurationSection section)

parseHeader

protected String parseHeader(String input)

buildHeader

protected 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