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 a MemoryConfiguration. Synchronized with the commit on 20-December-2021.

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 @NotNull String	buildHeader() Deprecated. This method only exists for backwards compatibility. Use FileConfigurationOptions.getHeader() instead.
@NotNull FileConfigurationOptions	getOptions() Gets the ConfigurationOptions for this Configuration.
void	load(@NotNull File file) Loads this FileConfiguration from the given File.
void	load(@NotNull Reader reader) Loads this FileConfiguration from the given Reader.
void	load(@NotNull String path) Loads this FileConfiguration from a File at the given path.
abstract void	loadFromString(@NotNull String data) Loads this FileConfiguration from the given String.
@NotNull FileConfigurationOptions	options() Deprecated.
void	save(@NotNull File file) Saves this FileConfiguration to the given File.
void	save(@NotNull String path) Saves this FileConfiguration to a File at the given path.
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, getComments, getConfigurationSection, getCurrentPath, getDefault, getDefaultSection, getDouble, getDouble, getDoubleList, getFloat, getFloat, getFloatList, getInLineComments, 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, setComments, setInLineComments, 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, getComments, getConfigurationSection, getCurrentPath, getDefaultSection, getDouble, getDouble, getDoubleList, getFloat, getFloat, getFloatList, getInLineComments, 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, setComments, setInLineComments

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 final void save(@NotNull
                       @NotNull File file)
                throws IOException

Saves this FileConfiguration to the given File.

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 IOException will be thrown.

This method will save using StandardCharsets.UTF_8.

Parameters:

file - The File to save to.

Throws:

IOException - If the File cannot be written to.

See Also:

saveToString()

save

public final void save(@NotNull
                       @NotNull String path)
                throws IOException

Saves this FileConfiguration to a File at the given path.

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 IOException will be thrown.

This method will save using StandardCharsets.UTF_8.

Parameters:

path - The path of the File to save to.

Throws:

IOException - If the File cannot be written to.

See Also:

save(File)

saveToString

@NotNull
public abstract @NotNull String saveToString()

Saves this FileConfiguration to a String, and returns it.

Returns:

The String containing this FileConfiguration.

load

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

Loads this FileConfiguration from the given Reader.

All values contained in-memory in this FileConfiguration will be removed, leaving only the FileConfigurationOptions as well as any defaults. The new values will be loaded into memory from the given Reader.

Parameters:

reader - The Reader used to load this FileConfiguration.

Throws:

IOException - If the given Reader encounters an error and throws an IOException.

InvalidConfigurationException - If the data in the Reader cannot be parsed as a FileConfiguration.

See Also:

loadFromString(String)

load

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

Loads this FileConfiguration from the given File.

All values contained in-memory in this FileConfiguration will be removed, leaving only the FileConfigurationOptions as well as any defaults. The new values will be loaded into memory from the given File.

Parameters:

file - The File used to load this FileConfiguration.

Throws:

IOException - If the given File cannot be read.

InvalidConfigurationException - If the data in the File cannot be parsed as a FileConfiguration.

See Also:

load(Reader)

load

public final void load(@NotNull
                       @NotNull String path)
                throws IOException,
                       InvalidConfigurationException

Loads this FileConfiguration from a File at the given path.

All values contained in-memory in this FileConfiguration will be removed, leaving only the FileConfigurationOptions as well as any defaults. The new values will be loaded into memory from the File at the given path.

Parameters:

path - The path of the File to load from.

Throws:

IOException - If the File cannot be read.

InvalidConfigurationException - If the data in the File cannot be parsed as a FileConfiguration.

See Also:

load(File)

loadFromString

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

Loads this FileConfiguration from the given String.

All values contained in-memory in this FileConfiguration will be removed, leaving only the FileConfigurationOptions as well as any defaults. The new values will be loaded into memory from the String.

Parameters:

data - A String representation of the FileConfiguration data to load.

Throws:

InvalidConfigurationException - If the given String cannot be parsed as a FileConfiguration.

buildHeader

@Deprecated
 @NotNull
protected final @NotNull String buildHeader()

Deprecated. This method only exists for backwards compatibility. Use FileConfigurationOptions.getHeader() instead.

This method is deprecated and exists only for backwards compatibility; it only returns an empty String. Please use FileConfigurationOptions.getHeader() instead.

Returns:

An empty String.

See Also:

FileConfigurationOptions.getHeader()

getOptions

@NotNull
public @NotNull FileConfigurationOptions getOptions()

Gets the ConfigurationOptions for this Configuration.

All setters through this method are chainable.

Specified by:

getOptions in interface Configuration

Overrides:

getOptions in class MemoryConfiguration

Returns:

The ConfigurationOptions for this Configuration.

options

@Deprecated
 @NotNull
public @NotNull FileConfigurationOptions options()

Deprecated.

This method exists for backwards compatibility, and it will be removed in a future release.

Please use Configuration.getOptions() instead; it provides the same functionality.

Specified by:

options in interface Configuration

Overrides:

options in class MemoryConfiguration

Returns:

The ConfigurationOptions for this Configuration.

See Also:

Configuration.getOptions()