org.bukkit.configuration.file

类 YamlConfiguration

java.lang.Object

org.bukkit.configuration.MemorySection

org.bukkit.configuration.MemoryConfiguration

org.bukkit.configuration.file.FileConfiguration

org.bukkit.configuration.file.YamlConfiguration

所有已实现的接口:

Configuration, ConfigurationSection

public class YamlConfiguration
extends FileConfiguration

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

字段概要

字段

限定符和类型	字段和说明
protected static java.lang.String	BLANK_CONFIG
protected static java.lang.String	COMMENT_PREFIX

从类继承的字段 org.bukkit.configuration.MemoryConfiguration

defaults, options

从类继承的字段 org.bukkit.configuration.MemorySection

map

构造器概要

构造器

构造器和说明
YamlConfiguration()

方法概要

限定符和类型	方法和说明
protected java.lang.String	buildHeader() Compiles the header for this FileConfiguration and returns the result.
protected void	convertMapsToSections(java.util.Map<?,?> input, ConfigurationSection section)
static YamlConfiguration	loadConfiguration(java.io.File file) Creates a new YamlConfiguration, loading from the given file.
static YamlConfiguration	loadConfiguration(java.io.Reader reader) Creates a new YamlConfiguration, loading from the given reader.
void	loadFromString(java.lang.String contents) Loads this FileConfiguration from the specified string, as opposed to from file.
YamlConfigurationOptions	options() 获取这个 Configuration 的 ConfigurationOptions.
protected java.lang.String	parseHeader(java.lang.String input)
java.lang.String	saveToString() 将这个 FileConfiguration 转化为String对象并且返回

从类继承的方法 org.bukkit.configuration.file.FileConfiguration

load, load, load, save, save

从类继承的方法 org.bukkit.configuration.MemoryConfiguration

addDefault, addDefaults, addDefaults, getDefaults, getParent, setDefaults

从类继承的方法 org.bukkit.configuration.MemorySection

contains, 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, getSerializable, getSerializable, getShortList, getString, getString, getStringList, getValues, getVector, getVector, isBoolean, isColor, isConfigurationSection, isDouble, isInt, isItemStack, isList, isLong, isOfflinePlayer, isPrimitiveWrapper, isSet, isString, isVector, mapChildrenKeys, mapChildrenValues, set, toString

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 org.bukkit.configuration.ConfigurationSection

contains, 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, getSerializable, getSerializable, getShortList, getString, getString, getStringList, getValues, getVector, getVector, isBoolean, isColor, isConfigurationSection, isDouble, isInt, isItemStack, isList, isLong, isOfflinePlayer, isSet, isString, isVector, set

字段详细资料

COMMENT_PREFIX

protected static final java.lang.String COMMENT_PREFIX

另请参阅:

常量字段值

BLANK_CONFIG

protected static final java.lang.String BLANK_CONFIG

另请参阅:

常量字段值

构造器详细资料

YamlConfiguration

public YamlConfiguration()

方法详细资料

saveToString

public java.lang.String saveToString()

从类复制的说明: FileConfiguration

将这个 FileConfiguration 转化为String对象并且返回

指定者:

saveToString 在类中 FileConfiguration

返回:

这个FileConfiguration包含的所有String

loadFromString

public void loadFromString(java.lang.String contents)
                    throws InvalidConfigurationException

从类复制的说明: FileConfiguration

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.

指定者:

loadFromString 在类中 FileConfiguration

参数:

contents - Contents of a Configuration to load.

抛出:

InvalidConfigurationException - Thrown if the specified string is invalid.

convertMapsToSections

protected void convertMapsToSections(java.util.Map<?,?> input,
                                     ConfigurationSection section)

parseHeader

protected java.lang.String parseHeader(java.lang.String input)

buildHeader

protected java.lang.String buildHeader()

从类复制的说明: FileConfiguration

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.

指定者:

buildHeader 在类中 FileConfiguration

返回:

Compiled header

options

public YamlConfigurationOptions options()

从接口复制的说明: Configuration

获取这个 Configuration 的 ConfigurationOptions.

如需修改配置,直接修改返回值即可.

原文: Gets the ConfigurationOptions for this Configuration.

All setters through this method are chainable.

指定者:

options 在接口中 Configuration

覆盖:

options 在类中 FileConfiguration

返回:

这个配置文件的一些配置(格式之类的).

loadConfiguration

public static YamlConfiguration loadConfiguration(java.io.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.

参数:

file - Input file

返回:

Resulting configuration

抛出:

java.lang.IllegalArgumentException - Thrown if file is null

loadConfiguration

public static YamlConfiguration loadConfiguration(java.io.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.

参数:

reader - input

返回:

resulting configuration

抛出:

java.lang.IllegalArgumentException - Thrown if stream is null