Package org.bukkit.configuration.file
Class YamlConfiguration
java.lang.Object
org.bukkit.configuration.MemorySection
org.bukkit.configuration.MemoryConfiguration
org.bukkit.configuration.file.FileConfiguration
org.bukkit.configuration.file.YamlConfiguration
- All Implemented Interfaces:
Configuration
,ConfigurationSection
An implementation of
Configuration
which saves all files in Yaml.
Note that this implementation is not synchronized.-
Field Summary
Modifier and TypeFieldDescriptionprotected static final String
Deprecated.unused, not intended to be APIprotected static final String
Deprecated.unused, not intended to be APIFields inherited from class org.bukkit.configuration.MemoryConfiguration
defaults, options
Fields inherited from class org.bukkit.configuration.MemorySection
map
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic @NotNull YamlConfiguration
loadConfiguration
(@NotNull File file) Creates a newYamlConfiguration
, loading from the given file.static @NotNull YamlConfiguration
loadConfiguration
(@NotNull Reader reader) Creates a newYamlConfiguration
, loading from the given reader.void
loadFromString
(@NotNull String contents) Loads thisFileConfiguration
from the specified string, as opposed to from file.options()
Gets theConfigurationOptions
for thisConfiguration
.Saves thisFileConfiguration
to a string, and returns it.Methods inherited from class org.bukkit.configuration.file.FileConfiguration
buildHeader, load, load, load, save, save
Methods inherited from class org.bukkit.configuration.MemoryConfiguration
addDefault, addDefaults, addDefaults, getDefaults, getParent, setDefaults
Methods inherited from class org.bukkit.configuration.MemorySection
contains, contains, createPath, createPath, createSection, createSection, get, get, getBoolean, getBoolean, getBooleanList, getByteList, getCharacterList, getColor, getColor, getComments, getConfigurationSection, getCurrentPath, getDefault, getDefaultSection, getDouble, getDouble, getDoubleList, getFloatList, getInlineComments, getInt, getInt, getIntegerList, getItemStack, getItemStack, getKeys, getList, getList, getLocation, getLocation, getLong, getLong, getLongList, getMapList, getName, getObject, getObject, getOfflinePlayer, getOfflinePlayer, getRoot, getSerializable, getSerializable, getShortList, getString, getString, getStringList, getValues, getVector, getVector, isBoolean, isColor, isConfigurationSection, isDouble, isInt, isItemStack, isList, isLocation, isLong, isOfflinePlayer, isPrimitiveWrapper, isSet, isString, isVector, 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.bukkit.configuration.ConfigurationSection
contains, contains, createSection, createSection, get, get, getBoolean, getBoolean, getBooleanList, getByteList, getCharacterList, getColor, getColor, getComments, getComponent, getComponent, getConfigurationSection, getCurrentPath, getDefaultSection, getDouble, getDouble, getDoubleList, getFloatList, getInlineComments, getInt, getInt, getIntegerList, getItemStack, getItemStack, getKeys, getList, getList, getLocation, getLocation, getLong, getLong, getLongList, getMapList, getName, getObject, getObject, getOfflinePlayer, getOfflinePlayer, getRichMessage, getRichMessage, getRoot, getSerializable, getSerializable, getShortList, getString, getString, getStringList, getValues, getVector, getVector, isBoolean, isColor, isConfigurationSection, isDouble, isInt, isItemStack, isList, isLocation, isLong, isOfflinePlayer, isSet, isString, isVector, set, setComments, setComponent, setInlineComments, setRichMessage
-
Field Details
-
COMMENT_PREFIX
Deprecated.unused, not intended to be API- See Also:
-
BLANK_CONFIG
Deprecated.unused, not intended to be API- See Also:
-
-
Constructor Details
-
YamlConfiguration
public YamlConfiguration()
-
-
Method Details
-
saveToString
Description copied from class:FileConfiguration
Saves thisFileConfiguration
to a string, and returns it.- Specified by:
saveToString
in classFileConfiguration
- Returns:
- String containing this configuration.
-
loadFromString
Description copied from class:FileConfiguration
Loads thisFileConfiguration
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 classFileConfiguration
- Parameters:
contents
- Contents of a Configuration to load.- Throws:
InvalidConfigurationException
- Thrown if the specified string is invalid.
-
options
Description copied from interface:Configuration
Gets theConfigurationOptions
for thisConfiguration
.All setters through this method are chainable.
- Specified by:
options
in interfaceConfiguration
- Overrides:
options
in classFileConfiguration
- Returns:
- Options for this configuration
-
loadConfiguration
Creates a newYamlConfiguration
, 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 newYamlConfiguration
, 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
-