Package org.simpleyaml.configuration.file

Class FileConfiguration

java.lang.Object

org.simpleyaml.configuration.MemorySection

org.simpleyaml.configuration.MemoryConfiguration

org.simpleyaml.configuration.file.FileConfiguration

All Implemented Interfaces:

Configuration, ConfigurationSection, LoadableConfiguration

Direct Known Subclasses:

YamlConfiguration

public abstract class FileConfiguration
extends MemoryConfiguration
implements LoadableConfiguration

This is a base class for all File based implementations of Configuration

Author:

Bukkit, Carleslc

See Also:

• Bukkit Source

Field Summary

Fields inherited from class org.simpleyaml.configuration.MemoryConfiguration

defaults, options

Fields inherited from class org.simpleyaml.configuration.MemorySection

map

Constructor Summary

Constructors

Constructor	Description
FileConfiguration()	Creates an empty FileConfiguration with no default values.
FileConfiguration(Configuration defaults)	Creates an empty FileConfiguration using the specified Configuration as a source for all default values.

Method Summary

Modifier and Type	Method	Description
String	buildHeader()	Compiles the header for this FileConfiguration and returns the result.
void	load(File file)	Loads this configuration from the specified file.
void	load(InputStream stream)	Loads this configuration from the specified stream.
void	load(Reader reader)	Loads this configuration from the specified reader.
void	load(String file)	Loads this configuration from the specified file path.
FileConfigurationOptions	options()	Gets the ConfigurationOptions for this Configuration.
void	save(File file)	Saves this FileConfiguration to the specified location.
void	save(Writer writer)	Saves this configuration to a writer.
void	save(String file)	Saves this FileConfiguration to the specified location.

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, 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, set, 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, 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, set, size

Methods inherited from interface org.simpleyaml.configuration.LoadableConfiguration

loadFromString, saveToString

Constructor Details

FileConfiguration

public FileConfiguration()

Creates an empty FileConfiguration with no default values.

FileConfiguration

public FileConfiguration(Configuration defaults)

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

Parameters:

defaults - Default value provider

Method Details

save

public void save(File file)
          throws IOException

Saves this FileConfiguration to the specified location.

If the file does not exist, it will be created. If already exists, it will be overwritten. If it cannot be overwritten or created, an exception will be thrown.

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

Parameters:

file - File to save to.

Throws:

IOException - Thrown when the given file cannot be written to for any reason.

IllegalArgumentException - Thrown when file is null.

save

public void save(String file)
          throws IOException

Saves this FileConfiguration to the specified location.

If the file does not exist, it will be created. If already exists, it will be overwritten. If it cannot be overwritten or created, an exception will be thrown.

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

Parameters:

file - File to save to.

Throws:

IOException - Thrown when the given file cannot be written to for any reason.

IllegalArgumentException - Thrown when file is null.

save

public void save(Writer writer)
          throws IOException

Description copied from interface: LoadableConfiguration

Saves this configuration to a writer.

Specified by:

save in interface LoadableConfiguration

Parameters:

writer - where to save this configuration

Throws:

IOException - when the contents cannot be written for any reason.

load

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

Loads this configuration from the specified file path.

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.

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.

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.

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.

load

public void load(InputStream stream)
          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:

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.

IllegalArgumentException - Thrown when stream is null.

See Also:

• load(Reader)

load

public void load(Reader reader)
          throws IOException,
InvalidConfigurationException

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

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.

IllegalArgumentException - Thrown when reader is null.

options

public FileConfigurationOptions 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 MemoryConfiguration

Returns:

Options for this configuration

buildHeader

public String buildHeader()

Compiles the header for this FileConfiguration and returns the result.

This will use the header from options() FileConfigurationOptions.header(), respecting the rules of FileConfigurationOptions.copyHeader() and FileConfigurationOptions.headerFormatter() if set.

Returns:

Compiled header