org.bspfsystems.yamlconfiguration.file

Class YamlConfiguration

java.lang.Object

org.bspfsystems.yamlconfiguration.configuration.MemorySection

org.bspfsystems.yamlconfiguration.configuration.MemoryConfiguration

org.bspfsystems.yamlconfiguration.file.FileConfiguration

org.bspfsystems.yamlconfiguration.file.YamlConfiguration

All Implemented Interfaces:

Configuration, ConfigurationSection

public final class YamlConfiguration
extends FileConfiguration

An implementation of Configuration which saves all files in Yaml. Please note that this implementation is not synchronized.

Synchronized with the commit on 09-Oct-2022.

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
YamlConfiguration() Creates an empty YamlConfiguration with no default values.
YamlConfiguration(@Nullable Configuration defs) Creates an empty YamlConfiguration using the specified Configuration as a source for all default values.

Method Summary

Modifier and Type	Method and Description
@NotNull YamlConfigurationOptions	getOptions() Gets the ConfigurationOptions for this Configuration.
static @NotNull YamlConfiguration	loadConfiguration(@NotNull File file) Creates a new YamlConfiguration, loading from the given File.
static @NotNull YamlConfiguration	loadConfiguration(@NotNull Reader reader) Creates a new YamlConfiguration, loading from the given Reader.
void	loadFromString(@NotNull String data) Loads this FileConfiguration from the given String.
@NotNull YamlConfigurationOptions	options() Deprecated.
@NotNull String	saveToString() Saves this FileConfiguration to a String, and returns it.

Methods inherited from class org.bspfsystems.yamlconfiguration.file.FileConfiguration

buildHeader, load, load, load, save, save

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

YamlConfiguration

public YamlConfiguration()

Creates an empty YamlConfiguration with no default values.

See Also:

FileConfiguration()

YamlConfiguration

public YamlConfiguration(@Nullable
                         @Nullable Configuration defs)

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

Parameters:

defs - A Configuration containing the values to use as defaults.

See Also:

FileConfiguration(Configuration)

Method Detail

saveToString

@NotNull
public @NotNull String saveToString()

Saves this FileConfiguration to a String, and returns it.

Specified by:

saveToString in class FileConfiguration

Returns:

The String containing this FileConfiguration.

loadFromString

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

Specified by:

loadFromString in class FileConfiguration

Parameters:

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

Throws:

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

getOptions

@NotNull
public @NotNull YamlConfigurationOptions getOptions()

Gets the ConfigurationOptions for this Configuration.

All setters through this method are chainable.

Specified by:

getOptions in interface Configuration

Overrides:

getOptions in class FileConfiguration

Returns:

The ConfigurationOptions for this Configuration.

options

@Deprecated
 @NotNull
public @NotNull YamlConfigurationOptions 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 FileConfiguration

Returns:

The ConfigurationOptions for this Configuration.

See Also:

Configuration.getOptions()

loadConfiguration

@NotNull
public static @NotNull YamlConfiguration loadConfiguration(@NotNull
                                                                    @NotNull File file)

Creates a new YamlConfiguration, loading from the given File.

Any errors loading the YamlConfiguration will be logged and then ignored. If the specified input is not a valid YamlConfiguration, a blank YamlConfiguration will be returned.

This will only load up to the default number of aliases (YamlConfigurationOptions.getMaxAliases()) to prevent a Billion Laughs Attack.

The encoding used may follow the system dependent default.

Parameters:

file - The File to load.

Returns:

The loaded YamlConfiguration.

loadConfiguration

@NotNull
public static @NotNull YamlConfiguration loadConfiguration(@NotNull
                                                                    @NotNull Reader reader)

Creates a new YamlConfiguration, loading from the given Reader.

Any errors loading the YamlConfiguration will be logged and then ignored. If the specified input is not a valid YamlConfiguration, a blank YamlConfiguration will be returned.

This will only load up to the default number of aliases (YamlConfigurationOptions.getMaxAliases()) to prevent a Billion Laughs Attack.

The encoding used may follow the system dependent default.

Parameters:

reader - The Reader to load.

Returns:

The loaded YamlConfiguration.