public class YamlConfiguration extends FileConfiguration
Configuration which saves all files in Yaml.
Note that this implementation is not synchronized.| Modifier and Type | Field and Description |
|---|---|
protected static String |
BLANK_CONFIG |
protected static String |
COMMENT_PREFIX |
defaults, optionsmap| Constructor and Description |
|---|
YamlConfiguration() |
| Modifier and Type | Method and Description |
|---|---|
protected String |
buildHeader()
Compiles the header for this
FileConfiguration and returns the
result. |
protected void |
convertMapsToSections(Map<?,?> input,
ConfigurationSection section) |
static YamlConfiguration |
loadConfiguration(File file)
Creates a new
YamlConfiguration, loading from the given file. |
static YamlConfiguration |
loadConfiguration(InputStream stream)
Deprecated.
does not properly consider encoding
|
static YamlConfiguration |
loadConfiguration(Reader reader)
Creates a new
YamlConfiguration, loading from the given reader. |
void |
loadFromString(String contents)
Loads this
FileConfiguration from the specified string, as
opposed to from file. |
YamlConfigurationOptions |
options()
Gets the
ConfigurationOptions for this Configuration. |
protected String |
parseHeader(String input) |
String |
saveToString()
Saves this
FileConfiguration to a string, and returns it. |
load, load, load, load, save, saveaddDefault, addDefaults, addDefaults, getDefaults, getParent, setDefaultscontains, contains, createPath, createPath, createSection, createSection, get, get, getBoolean, getBoolean, getBooleanList, getByteList, getCharacterList, getColor, getColor, getConfigurationSection, getCurrentPath, getDefault, getDefaultSection, getDouble, getDouble, getDoubleList, getFloatList, getInt, getInt, getIntegerList, getItemStack, getItemStack, getKeys, getList, getList, getLong, getLong, getLongList, getMapList, getName, getOfflinePlayer, getOfflinePlayer, getRoot, getShortList, getString, getString, getStringList, getValues, getVector, getVector, isBoolean, isColor, isConfigurationSection, isDouble, isInt, isItemStack, isList, isLong, isOfflinePlayer, isPrimitiveWrapper, isSet, isString, isVector, mapChildrenKeys, mapChildrenValues, set, toStringclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitcontains, contains, createSection, createSection, get, get, getBoolean, getBoolean, getBooleanList, getByteList, getCharacterList, getColor, getColor, getConfigurationSection, getCurrentPath, getDefaultSection, getDouble, getDouble, getDoubleList, getFloatList, getInt, getInt, getIntegerList, getItemStack, getItemStack, getKeys, getList, getList, getLong, getLong, getLongList, getMapList, getName, getOfflinePlayer, getOfflinePlayer, getRoot, getShortList, getString, getString, getStringList, getValues, getVector, getVector, isBoolean, isColor, isConfigurationSection, isDouble, isInt, isItemStack, isList, isLong, isOfflinePlayer, isSet, isString, isVector, setprotected static final String COMMENT_PREFIX
protected static final String BLANK_CONFIG
public String saveToString()
FileConfigurationFileConfiguration to a string, and returns it.saveToString in class FileConfigurationpublic void loadFromString(String contents) throws InvalidConfigurationException
FileConfigurationFileConfiguration 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.
loadFromString in class FileConfigurationcontents - Contents of a Configuration to load.InvalidConfigurationException - Thrown if the specified string is
invalid.protected void convertMapsToSections(Map<?,?> input, ConfigurationSection section)
protected String buildHeader()
FileConfigurationFileConfiguration and returns the
result.
This will use the header from FileConfiguration.options() -> FileConfigurationOptions.header(), respecting the rules of FileConfigurationOptions.copyHeader() if set.
buildHeader in class FileConfigurationpublic YamlConfigurationOptions options()
ConfigurationConfigurationOptions for this Configuration.
All setters through this method are chainable.
options in interface Configurationoptions in class FileConfigurationpublic static YamlConfiguration loadConfiguration(File file)
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.
file - Input fileIllegalArgumentException - Thrown if file is null@Deprecated public static YamlConfiguration loadConfiguration(InputStream stream)
YamlConfiguration, loading from the given stream.
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.
stream - Input streamIllegalArgumentException - Thrown if stream is nullFileConfiguration.load(InputStream),
loadConfiguration(Reader)public static YamlConfiguration loadConfiguration(Reader reader)
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.
reader - inputIllegalArgumentException - Thrown if stream is nullCopyright © 2017. All rights reserved.