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. Note that this implementation is not synchronized. Synchronized with the commit on 21-December-2019.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	BLANK_CONFIG
protected static String	COMMENT_PREFIX

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()

Method Summary

Modifier and Type	Method and Description
protected @NotNull String	buildHeader() Compiles the header for this FileConfiguration and returns the result.
protected void	convertMapsToSections(@NotNull Map<?,?> map, @NotNull ConfigurationSection section) Converts the given Map data into a ConfigurationSection, loading it into the given ConfigurationSection.
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 specified string, as opposed to from file.
@NotNull YamlConfigurationOptions	options() Gets the ConfigurationOptions for this Configuration.
protected @NotNull String	parseHeader(@NotNull String data) Parses the YAML header from the given data.
@NotNull String	saveToString() Saves this FileConfiguration to a string, and returns it.

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

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

Field Detail

COMMENT_PREFIX

protected static final String COMMENT_PREFIX

See Also:

Constant Field Values

BLANK_CONFIG

protected static final String BLANK_CONFIG

See Also:

Constant Field Values

Constructor Detail

YamlConfiguration

public YamlConfiguration()

Method Detail

saveToString

@NotNull
public @NotNull String saveToString()

Saves this FileConfiguration to a string, and returns it.

Specified by:

saveToString in class FileConfiguration

Returns:

String containing this configuration.

loadFromString

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

Specified by:

loadFromString in class FileConfiguration

Parameters:

data - Contents of a Configuration to load.

Throws:

InvalidConfigurationException - Thrown if the specified string is invalid.

convertMapsToSections

protected void convertMapsToSections(@NotNull
                                     @NotNull Map<?,?> map,
                                     @NotNull
                                     @NotNull ConfigurationSection section)

Converts the given Map data into a ConfigurationSection, loading it into the given ConfigurationSection.

Parameters:

map - The data to convert.

section - The ConfigurationSection that will hold the converted data.

parseHeader

@NotNull
protected @NotNull String parseHeader(@NotNull
                                               @NotNull String data)

Parses the YAML header from the given data.

Parameters:

data - The data to parse the header from.

Returns:

The parsed header.

buildHeader

@NotNull
protected @NotNull String buildHeader()

Compiles the header for this FileConfiguration and returns the result.

This will use the header from FileConfiguration.options() -> FileConfigurationOptions.header(), respecting the rules of FileConfigurationOptions.copyHeader() if set.

Specified by:

buildHeader in class FileConfiguration

Returns:

Compiled header

options

@NotNull
public @NotNull YamlConfigurationOptions options()

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

loadConfiguration

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

Creates a new YamlConfiguration, loading from the given file.

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

The encoding used may follow the system dependent default.

Parameters:

file - Input file

Returns:

Resulting configuration

Throws:

IllegalArgumentException - Thrown if file is null

loadConfiguration

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

Creates a new YamlConfiguration, loading from the given reader.

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

Parameters:

reader - input

Returns:

resulting configuration

Throws:

IllegalArgumentException - Thrown if stream is null