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 String	BLANK_CONFIG
protected static String	COMMENT_PREFIX

クラスから継承されたフィールド org.bukkit.configuration.MemoryConfiguration

defaults, options

クラスから継承されたフィールド org.bukkit.configuration.MemorySection

map

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
YamlConfiguration()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
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) 非推奨です。 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.

クラスから継承されたメソッド org.bukkit.configuration.file.FileConfiguration

load, 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, 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, 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 String COMMENT_PREFIX

関連項目:

定数フィールド値

BLANK_CONFIG

protected static final String BLANK_CONFIG

関連項目:

定数フィールド値

コンストラクタの詳細

YamlConfiguration

public YamlConfiguration()

メソッドの詳細

saveToString

public String saveToString()

クラスからコピーされた説明: FileConfiguration

Saves this FileConfiguration to a string, and returns it.

定義:

saveToString クラス内 FileConfiguration

戻り値:

String containing this configuration.

loadFromString

public void loadFromString(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(Map<?,?> input,
                                     ConfigurationSection section)

parseHeader

protected String parseHeader(String input)

buildHeader

protected 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

Gets the ConfigurationOptions for this Configuration.

All setters through this method are chainable.

定義:

options インタフェース内 Configuration

オーバーライド:

options クラス内 FileConfiguration

戻り値:

Options for this configuration

loadConfiguration

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

例外:

IllegalArgumentException - Thrown if file is null

loadConfiguration

@Deprecated
public static YamlConfiguration loadConfiguration(InputStream stream)

非推奨です。 does not properly consider encoding

Creates a new 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 stream

戻り値:

Resulting configuration

例外:

IllegalArgumentException - Thrown if stream is null

関連項目:

FileConfiguration.load(InputStream), loadConfiguration(Reader)

loadConfiguration

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

例外:

IllegalArgumentException - Thrown if stream is null