org.bukkit.configuration.file

クラス FileConfiguration

java.lang.Object

org.bukkit.configuration.MemorySection

org.bukkit.configuration.MemoryConfiguration

org.bukkit.configuration.file.FileConfiguration

すべての実装されたインタフェース:

Configuration, ConfigurationSection

直系の既知のサブクラス:

YamlConfiguration

public abstract class FileConfiguration
extends MemoryConfiguration

This is a base class for all File based implementations of Configuration

フィールドのサマリー

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

defaults, options

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

map

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

コンストラクタ

コンストラクタと説明
FileConfiguration() Creates an empty FileConfiguration with no default values.
FileConfiguration(Configuration defaults) Creates an empty FileConfiguration using the specified Configuration as a source for all default values.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected abstract String	buildHeader() Compiles the header for this FileConfiguration and returns the result.
void	load(File file) Loads this FileConfiguration from the specified location.
void	load(InputStream stream) 非推奨です。 This does not consider encoding
void	load(Reader reader) Loads this FileConfiguration from the specified reader.
void	load(String file) Loads this FileConfiguration from the specified location.
abstract void	loadFromString(String contents) Loads this FileConfiguration from the specified string, as opposed to from file.
FileConfigurationOptions	options() Gets the ConfigurationOptions for this Configuration.
void	save(File file) Saves this FileConfiguration to the specified location.
void	save(String file) Saves this FileConfiguration to the specified location.
abstract String	saveToString() Saves this FileConfiguration to a string, and returns it.

クラスから継承されたメソッド 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

コンストラクタの詳細

FileConfiguration

public FileConfiguration()

Creates an empty FileConfiguration with no default values.

FileConfiguration

public FileConfiguration(Configuration defaults)

Creates an empty FileConfiguration using the specified Configuration as a source for all default values.

パラメータ:

defaults - Default value provider

メソッドの詳細

save

public void save(File file)
          throws IOException

Saves this FileConfiguration to the specified location.

If the file does not exist, it will be created. If already exists, it will be overwritten. If it cannot be overwritten or created, an exception will be thrown.

This method will save using the system default encoding, or possibly using UTF8.

パラメータ:

file - File to save to.

例外:

IOException - Thrown when the given file cannot be written to for any reason.

IllegalArgumentException - Thrown when file is null.

save

public void save(String file)
          throws IOException

Saves this FileConfiguration to the specified location.

If the file does not exist, it will be created. If already exists, it will be overwritten. If it cannot be overwritten or created, an exception will be thrown.

This method will save using the system default encoding, or possibly using UTF8.

パラメータ:

file - File to save to.

例外:

IOException - Thrown when the given file cannot be written to for any reason.

IllegalArgumentException - Thrown when file is null.

saveToString

public abstract String saveToString()

Saves this FileConfiguration to a string, and returns it.

戻り値:

String containing this configuration.

load

public void load(File file)
          throws FileNotFoundException,
                 IOException,
                 InvalidConfigurationException

Loads this FileConfiguration from the specified location.

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

If the file cannot be loaded for any reason, an exception will be thrown.

パラメータ:

file - File to load from.

例外:

FileNotFoundException - Thrown when the given file cannot be opened.

IOException - Thrown when the given file cannot be read.

InvalidConfigurationException - Thrown when the given file is not a valid Configuration.

IllegalArgumentException - Thrown when file is null.

load

@Deprecated
public void load(InputStream stream)
                       throws IOException,
                              InvalidConfigurationException

非推奨です。 This does not consider encoding

Loads this FileConfiguration from the specified stream.

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

パラメータ:

stream - Stream to load from

例外:

IOException - Thrown when the given file cannot be read.

InvalidConfigurationException - Thrown when the given file is not a valid Configuration.

IllegalArgumentException - Thrown when stream is null.

関連項目:

load(Reader)

load

public void load(Reader reader)
          throws IOException,
                 InvalidConfigurationException

Loads this FileConfiguration from the specified reader.

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

パラメータ:

reader - the reader to load from

例外:

IOException - thrown when underlying reader throws an IOException

InvalidConfigurationException - thrown when the reader does not represent a valid Configuration

IllegalArgumentException - thrown when reader is null

load

public void load(String file)
          throws FileNotFoundException,
                 IOException,
                 InvalidConfigurationException

Loads this FileConfiguration from the specified location.

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

If the file cannot be loaded for any reason, an exception will be thrown.

パラメータ:

file - File to load from.

例外:

FileNotFoundException - Thrown when the given file cannot be opened.

IOException - Thrown when the given file cannot be read.

InvalidConfigurationException - Thrown when the given file is not a valid Configuration.

IllegalArgumentException - Thrown when file is null.

loadFromString

public abstract void loadFromString(String contents)
                             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.

パラメータ:

contents - Contents of a Configuration to load.

例外:

InvalidConfigurationException - Thrown if the specified string is invalid.

IllegalArgumentException - Thrown if contents is null.

buildHeader

protected abstract String buildHeader()

Compiles the header for this FileConfiguration and returns the result.

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

戻り値:

Compiled header

options

public FileConfigurationOptions options()

インタフェースからコピーされた説明: Configuration

Gets the ConfigurationOptions for this Configuration.

All setters through this method are chainable.

定義:

options インタフェース内 Configuration

オーバーライド:

options クラス内 MemoryConfiguration

戻り値:

Options for this configuration