org.bspfsystems.yamlconfiguration.file

Class FileConfiguration

java.lang.Object

org.bspfsystems.yamlconfiguration.configuration.MemorySection

org.bspfsystems.yamlconfiguration.configuration.MemoryConfiguration

org.bspfsystems.yamlconfiguration.file.FileConfiguration

All Implemented Interfaces:

Configuration, ConfigurationSection

Direct Known Subclasses:

YamlConfiguration

public abstract class FileConfiguration
extends MemoryConfiguration

This is a base class for all File based implementations of Configuration. Synchronized with the commit on 23-April-2019.

Field Summary

Fields inherited from class org.bspfsystems.yamlconfiguration.configuration.MemoryConfiguration

defs, options

Fields inherited from class org.bspfsystems.yamlconfiguration.configuration.MemorySection

map

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected abstract @NotNull String	buildHeader() Compiles the header for this FileConfiguration and returns the result.
void	load(@NotNull File file) Loads this FileConfiguration from the specified location.
void	load(@NotNull Reader reader) Loads this FileConfiguration from the specified reader.
void	load(@NotNull String fileName) Loads this FileConfiguration from the specified location.
abstract void	loadFromString(@NotNull String data) Loads this FileConfiguration from the specified string, as opposed to from file.
@NotNull FileConfigurationOptions	options() Gets the ConfigurationOptions for this Configuration.
void	save(@NotNull File file) Saves this FileConfiguration to the specified location.
void	save(@NotNull String path) Saves this FileConfiguration to the specified location.
abstract @NotNull String	saveToString() Saves this FileConfiguration to a string, and returns it.

Methods inherited from class org.bspfsystems.yamlconfiguration.configuration.MemoryConfiguration

addDefault, addDefaults, addDefaults, getDefaults, getParent, setDefaults

Methods inherited from class org.bspfsystems.yamlconfiguration.configuration.MemorySection

contains, contains, createPath, createPath, createSection, createSection, get, get, getBoolean, getBoolean, getBooleanList, getByte, getByte, getByteList, getChar, getChar, getCharList, getConfigurationSection, getCurrentPath, getDefault, getDefaultSection, getDouble, getDouble, getDoubleList, getFloat, getFloat, getFloatList, getInt, getInt, getIntList, getKeys, getList, getList, getLong, getLong, getLongList, getMapList, getName, getObject, getObject, getRoot, getSerializable, getSerializable, getShort, getShort, getShortList, getString, getString, getStringList, getValues, isBoolean, isByte, isChar, isConfigurationSection, isDouble, isFloat, isInt, isList, isLong, isSet, isShort, isString, mapChildrenKeys, mapChildrenValues, set, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection

contains, contains, createSection, createSection, get, get, getBoolean, getBoolean, getBooleanList, getByte, getByte, getByteList, getChar, getChar, getCharList, getConfigurationSection, getCurrentPath, getDefaultSection, getDouble, getDouble, getDoubleList, getFloat, getFloat, getFloatList, getInt, getInt, getIntList, getKeys, getList, getList, getLong, getLong, getLongList, getMapList, getName, getObject, getObject, getRoot, getSerializable, getSerializable, getShort, getShort, getShortList, getString, getString, getStringList, getValues, isBoolean, isByte, isChar, isConfigurationSection, isDouble, isFloat, isInt, isList, isLong, isSet, isShort, isString, set

Constructor Detail

FileConfiguration

public FileConfiguration()

Creates an empty FileConfiguration with no default values.

FileConfiguration

public FileConfiguration(@Nullable
                         @Nullable Configuration defs)

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

Parameters:

defs - Default value provider

Method Detail

save

public void save(@NotNull
                 @NotNull 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 save using the system default encoding, or possibly using 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(@NotNull
                 @NotNull String path)
          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 save using the system default encoding, or possibly using UTF8.

Parameters:

path - File to save to.

Throws:

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

IllegalArgumentException - Thrown when file is null.

saveToString

@NotNull
public abstract @NotNull String saveToString()

Saves this FileConfiguration to a string, and returns it.

Returns:

String containing this configuration.

load

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

Loads this FileConfiguration 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.

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

load

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

Loads this FileConfiguration from the specified location.

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.

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(@NotNull
                 @NotNull String fileName)
          throws FileNotFoundException,
                 IOException,
                 InvalidConfigurationException

Loads this FileConfiguration from the specified location.

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.

Parameters:

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

loadFromString

public abstract void loadFromString(@NotNull
                                    @NotNull String data)
                             throws InvalidConfigurationException

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.

Parameters:

data - Contents of a Configuration to load.

Throws:

InvalidConfigurationException - Thrown if the specified string is invalid.

IllegalArgumentException - Thrown if contents is null.

buildHeader

@NotNull
protected abstract @NotNull 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() if set.

Returns:

Compiled header

options

@NotNull
public @NotNull FileConfigurationOptions options()

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