Package org.simpleyaml.configuration.file

Class YamlConfiguration

java.lang.Object

org.simpleyaml.configuration.MemorySection

org.simpleyaml.configuration.MemoryConfiguration

org.simpleyaml.configuration.file.FileConfiguration

org.simpleyaml.configuration.file.YamlConfiguration

All Implemented Interfaces:

Configuration, ConfigurationSection, LoadableConfiguration

Direct Known Subclasses:

YamlFile

public class YamlConfiguration
extends FileConfiguration

An implementation of Configuration which saves the configuration in Yaml. Note that this implementation is not synchronized.

Author:

Bukkit, Carleslc

See Also:

• Bukkit Source

Field Summary

Fields

Modifier and Type	Field	Description
protected YamlImplementation	yamlImplementation

Fields inherited from class org.simpleyaml.configuration.MemoryConfiguration

defaults, options

Fields inherited from class org.simpleyaml.configuration.MemorySection

map

Constructor Summary

Constructors

Constructor	Description
YamlConfiguration()	Creates an empty YamlConfiguration.
YamlConfiguration(Configuration defaults)	Creates an empty YamlConfiguration using the specified Configuration as a source for all default values.
YamlConfiguration(Configuration defaults, YamlImplementation yamlImplementation)
YamlConfiguration(YamlImplementation yamlImplementation)

Method Summary

Modifier and Type	Method	Description
String	dump()	Dump the configuration values without the header to a string.
void	dump(Writer writer)	Dump the configuration values without the header.
Object	get(String path, Object def)	Gets the requested Object by path, returning a default value if not found.
YamlImplementation	getImplementation()
void	load(File file)	Loads this configuration from the specified file.
void	load(InputStream stream)	Deprecated. this method loads the entire file into memory, for larger files please use load(SupplierIO.InputStream)
void	load(Reader reader)	Deprecated. this method loads the entire file into memory, for larger files please use load(SupplierIO.Reader)
void	load(SupplierIO.InputStream streamSupplier)	Loads this configuration from the specified stream.
void	load(SupplierIO.Reader readerSupplier)	Loads this YamlConfiguration from the specified reader.
static YamlConfiguration	loadConfiguration(File file)	Creates a new YamlConfiguration, loading from the given file.
static YamlConfiguration	loadConfiguration(InputStream stream)	Deprecated. this method loads the entire file into memory, for larger files please use load(SupplierIO.InputStream)
static YamlConfiguration	loadConfiguration(Reader reader)	Deprecated. this method loads the entire file into memory, for larger files please use load(SupplierIO.Reader)
static YamlConfiguration	loadConfiguration(SupplierIO.InputStream streamSupplier)	Creates a new YamlConfiguration, loading from the given input stream.
static YamlConfiguration	loadConfiguration(SupplierIO.Reader readerSupplier)	Creates a new YamlConfiguration, loading from the given reader.
static YamlConfiguration	loadConfigurationFromString(String contents)	Creates a new YamlConfiguration, loading from the specified string contents.
void	loadFromString(String contents)	Loads this YamlConfiguration from the specified string.
protected void	loadHeader(Reader reader)
YamlConfigurationOptions	options()	Gets the ConfigurationOptions for this Configuration.
void	save(Writer writer)	Save the configuration values including the header.
String	saveToString()	Save the configuration values including the header to a string.
void	set(String path, Object value)	Sets the specified path to the given value.
void	set(String path, Object value, QuoteStyle quoteStyle)	Sets the specified path to the given value.
void	setImplementation(YamlImplementation yamlImplementation)

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

buildHeader, load, save, save

Methods inherited from class org.simpleyaml.configuration.MemoryConfiguration

addDefault, addDefaults, addDefaults, getDefaults, getParent, setDefaults

Methods inherited from class org.simpleyaml.configuration.MemorySection

contains, createPath, createPath, createSection, createSection, get, getBoolean, getBoolean, getBooleanList, getByte, getByte, getByteList, getCharacter, getCharacter, getCharacterList, getConfigurationSection, getCurrentPath, getDefault, getDefaultSection, getDouble, getDouble, getDoubleList, getFloat, getFloat, getFloatList, getInt, getInt, getIntegerList, getKeys, getList, getList, getLong, getLong, getLongList, getMapList, getMapValues, getName, getRoot, getShort, getShort, getShortList, getString, getString, getStringList, getValues, isBoolean, isByte, isCharacter, isConfigurationSection, isDouble, isEmpty, isFloat, isInt, isList, isLong, isPrimitiveWrapper, isSet, isShort, isString, mapChildrenKeys, mapChildrenValues, size, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.simpleyaml.configuration.ConfigurationSection

contains, createSection, createSection, get, getBoolean, getBoolean, getBooleanList, getByte, getByte, getByteList, getCharacter, getCharacter, getCharacterList, getConfigurationSection, getCurrentPath, getDefaultSection, getDouble, getDouble, getDoubleList, getFloat, getFloat, getFloatList, getInt, getInt, getIntegerList, getKeys, getList, getList, getLong, getLong, getLongList, getMapList, getMapValues, getName, getRoot, getShort, getShort, getShortList, getString, getString, getStringList, getValues, isBoolean, isByte, isCharacter, isConfigurationSection, isDouble, isEmpty, isFloat, isInt, isList, isLong, isSet, isShort, isString, remove, size

Field Details

yamlImplementation

protected YamlImplementation yamlImplementation

Constructor Details

YamlConfiguration

public YamlConfiguration()

Creates an empty YamlConfiguration.

YamlConfiguration

public YamlConfiguration(Configuration defaults)

Creates an empty YamlConfiguration using the specified Configuration as a source for all default values.

Parameters:

defaults - default values

YamlConfiguration

public YamlConfiguration(YamlImplementation yamlImplementation)

YamlConfiguration

public YamlConfiguration(Configuration defaults,
 YamlImplementation yamlImplementation)

Method Details

getImplementation

public YamlImplementation getImplementation()

setImplementation

public void setImplementation(YamlImplementation yamlImplementation)

saveToString

public String saveToString()
                    throws IOException

Save the configuration values including the header to a string.

Returns:

a String containing this configuration.

Throws:

IOException - when the contents cannot be written for any reason

save

public void save(Writer writer)
          throws IOException

Save the configuration values including the header.

Specified by:

save in interface LoadableConfiguration

Overrides:

save in class FileConfiguration

Parameters:

writer - where to save this configuration

Throws:

IOException - when the contents cannot be written for any reason

See Also:

• saveToString()

dump

public String dump()
            throws IOException

Dump the configuration values without the header to a string.

Throws:

IOException - when the contents cannot be written for any reason

See Also:

• saveToString()

dump

public void dump(Writer writer)
          throws IOException

Dump the configuration values without the header.

Parameters:

writer - where to save this configuration

Throws:

IOException - when the contents cannot be written for any reason

See Also:

• save(Writer)

load

public void load(SupplierIO.Reader readerSupplier)
          throws IOException,
InvalidConfigurationException

Loads this YamlConfiguration from the specified reader.

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

If the file cannot be loaded for any reason, an exception will be thrown.

Parameters:

readerSupplier - a function providing the reader to load from (new instance)

Throws:

IOException - Thrown when underlying reader throws an IOException.

InvalidConfigurationException - Thrown when the reader does not represent a valid Configuration.

IllegalArgumentException - Thrown when reader is null.

loadHeader

protected void loadHeader(Reader reader)
                   throws IOException

Throws:

IOException

loadConfiguration

public static YamlConfiguration loadConfiguration(SupplierIO.Reader readerSupplier)
                                           throws IOException

Creates a new YamlConfiguration, loading from the given reader.

Parameters:

readerSupplier - a function providing the reader to load from (new instance)

Returns:

resulting configuration

Throws:

IllegalArgumentException - if stream is null

IOException - if cannot load configuration

loadConfiguration

public static YamlConfiguration loadConfiguration(File file)
                                           throws IOException

Creates a new YamlConfiguration, loading from the given file.

This method will use the options() charset encoding, which defaults to UTF8.

Parameters:

file - Input file

Returns:

Resulting configuration

Throws:

IllegalArgumentException - if file is null

IOException - if cannot load configuration

load

public void load(File file)
          throws FileNotFoundException,
IOException,
InvalidConfigurationException

Loads this configuration from the specified 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 file.

If the file cannot be loaded for any reason, an exception will be thrown.

This method will use the options() charset encoding, which defaults to UTF8.

Overrides:

load in class FileConfiguration

Parameters:

file - File to load from.

Throws:

FileNotFoundException - Thrown when the given file cannot be opened.

IOException - Thrown when the given file cannot be read.

InvalidConfigurationException - Thrown when the given file is not a valid Configuration.

IllegalArgumentException - Thrown when file is null.

loadConfigurationFromString

public static YamlConfiguration loadConfigurationFromString(String contents)
                                                     throws IOException

Creates a new YamlConfiguration, loading from the specified string contents.

If the file cannot be loaded for any reason, an exception will be thrown.

Parameters:

contents - the contents to load from

Throws:

IOException - Thrown when underlying reader throws an IOException.

InvalidConfigurationException - Thrown when the contents does not represent a valid Configuration.

IllegalArgumentException - Thrown when contents is null.

loadFromString

public void loadFromString(String contents)
                    throws IOException

Loads this YamlConfiguration from the specified string.

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

If the file cannot be loaded for any reason, an exception will be thrown.

Parameters:

contents - the contents to load from

Throws:

IOException - Thrown when underlying reader throws an IOException.

InvalidConfigurationException - Thrown when the contents does not represent a valid Configuration.

IllegalArgumentException - Thrown when contents is null.

loadConfiguration

public static YamlConfiguration loadConfiguration(SupplierIO.InputStream streamSupplier)
                                           throws IOException

Creates a new YamlConfiguration, loading from the given input stream.

If the file cannot be loaded for any reason, an exception will be thrown.

Parameters:

streamSupplier - a function providing the stream to load from (new instance)

Returns:

resulting configuration

Throws:

InvalidConfigurationException - if input stream is not a valid Configuration.

IllegalArgumentException - if stream is null

IOException - if cannot load configuration

load

public void load(SupplierIO.InputStream streamSupplier)
          throws IOException,
InvalidConfigurationException

Loads this configuration from the specified stream.

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

If the file cannot be loaded for any reason, an exception will be thrown.

This method will use the options() charset encoding, which defaults to UTF8.

Parameters:

streamSupplier - a function providing the stream to load from (new instance)

Throws:

IOException - Thrown when the given file cannot be read.

InvalidConfigurationException - Thrown when the given file is not a valid Configuration.

IllegalArgumentException - Thrown when stream is null.

See Also:

• load(SupplierIO.Reader)

loadConfiguration

@Deprecated
public static YamlConfiguration loadConfiguration(InputStream stream)
                                           throws IOException

Deprecated.

this method loads the entire file into memory, for larger files please use load(SupplierIO.InputStream)

Creates a new YamlConfiguration, loading from the given stream.

This method will use the options() charset encoding, which defaults to UTF8.

Parameters:

stream - Input stream

Returns:

Resulting configuration

Throws:

IllegalArgumentException - if stream is null

IOException - if cannot load configuration

See Also:

• loadConfiguration(SupplierIO.InputStream)
• loadConfiguration(SupplierIO.Reader)

load

@Deprecated
public void load(InputStream stream)
          throws IOException,
InvalidConfigurationException

Deprecated.

this method loads the entire file into memory, for larger files please use load(SupplierIO.InputStream)

Description copied from class: FileConfiguration

Loads this configuration from the specified stream.

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

If the file cannot be loaded for any reason, an exception will be thrown.

This method will use the FileConfiguration.options() charset encoding, which defaults to UTF8.

Overrides:

load in class FileConfiguration

Parameters:

stream - Stream to load from

Throws:

IOException - Thrown when the given file cannot be read.

InvalidConfigurationException - Thrown when the given file is not a valid Configuration.

See Also:

• loadConfiguration(SupplierIO.InputStream)

loadConfiguration

@Deprecated
public static YamlConfiguration loadConfiguration(Reader reader)
                                           throws IOException

Deprecated.

this method loads the entire file into memory, for larger files please use load(SupplierIO.Reader)

Creates a new YamlConfiguration, loading from the given reader.

Parameters:

reader - input reader

Returns:

resulting configuration

Throws:

IllegalArgumentException - if stream is null

IOException - if cannot load configuration

See Also:

• loadConfiguration(SupplierIO.Reader)
• loadConfiguration(SupplierIO.InputStream)

load

@Deprecated
public void load(Reader reader)
          throws IOException,
InvalidConfigurationException

Deprecated.

this method loads the entire file into memory, for larger files please use load(SupplierIO.Reader)

Description copied from class: FileConfiguration

Loads this configuration from the specified reader.

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

If the file cannot be loaded for any reason, an exception will be thrown.

Specified by:

load in interface LoadableConfiguration

Overrides:

load in class FileConfiguration

Parameters:

reader - the reader to load from

Throws:

IOException - Thrown when underlying reader throws an IOException.

InvalidConfigurationException - Thrown when the reader does not represent a valid Configuration.

See Also:

• loadConfiguration(SupplierIO.Reader)

set

public void set(String path,
 Object value,
 QuoteStyle quoteStyle)

Sets the specified path to the given value.

The value will be represented with the specified quote style in the configuration file.

Any existing entry will be replaced, regardless of what the new value is.

Null value is valid and will not remove the key, this is different to set(String, Object). Instead, a null value will be written as a yaml empty null value.

Some implementations may have limitations on what you may store. See their individual javadocs for details. No implementations should allow you to store Configurations or ConfigurationSections, please use MemorySection.createSection(String) for that.

Parameters:

path - Path of the object to set.

value - New value to set the path to.

quoteStyle - The quote style to use.

set

public void set(String path,
 Object value)

Sets the specified path to the given value.

If value is null, the entry will be removed. Any existing entry will be replaced, regardless of what the new value is.

Some implementations may have limitations on what you may store. See their individual javadocs for details. No implementations should allow you to store Configurations or ConfigurationSections, please use MemorySection.createSection(String) for that.

Specified by:

set in interface ConfigurationSection

Overrides:

set in class MemorySection

Parameters:

path - Path of the object to set.

value - New value to set the path to.

get

public Object get(String path,
 Object def)

Description copied from interface: ConfigurationSection

Gets the requested Object by path, returning a default value if not found.

If the Object does not exist then the specified default value will returned regardless of if a default has been identified in the root Configuration.

Specified by:

get in interface ConfigurationSection

Overrides:

get in class MemorySection

Parameters:

path - Path of the Object to get.

def - The default value to return if the path is not found.

Returns:

Requested Object.

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