org.bukkit.configuration

インタフェース Configuration

すべてのスーパーインタフェース:

ConfigurationSection

既知の実装クラスのリスト:

FileConfiguration, MemoryConfiguration, YamlConfiguration

public interface Configuration
extends ConfigurationSection

Represents a source of configurable options and settings

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addDefault(String path, Object value) Sets the default value of the given path as provided.
void	addDefaults(Configuration defaults) Sets the default values of the given paths as provided.
void	addDefaults(Map<String,Object> defaults) Sets the default values of the given paths as provided.
Configuration	getDefaults() Gets the source Configuration for this configuration.
ConfigurationOptions	options() Gets the ConfigurationOptions for this Configuration.
void	setDefaults(Configuration defaults) Sets the source of all default values for this Configuration.

インタフェースから継承されたメソッド 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, getParent, getRoot, getShortList, getString, getString, getStringList, getValues, getVector, getVector, isBoolean, isColor, isConfigurationSection, isDouble, isInt, isItemStack, isList, isLong, isOfflinePlayer, isSet, isString, isVector, set

メソッドの詳細

addDefault

void addDefault(String path,
                Object value)

Sets the default value of the given path as provided.

If no source Configuration was provided as a default collection, then a new MemoryConfiguration will be created to hold the new default value.

If value is null, the value will be removed from the default Configuration source.

定義:

addDefault インタフェース内 ConfigurationSection

パラメータ:

path - Path of the value to set.

value - Value to set the default to.

例外:

IllegalArgumentException - Thrown if path is null.

addDefaults

void addDefaults(Map<String,Object> defaults)

Sets the default values of the given paths as provided.

If no source Configuration was provided as a default collection, then a new MemoryConfiguration will be created to hold the new default values.

パラメータ:

defaults - A map of Path->Values to add to defaults.

例外:

IllegalArgumentException - Thrown if defaults is null.

addDefaults

void addDefaults(Configuration defaults)

Sets the default values of the given paths as provided.

If no source Configuration was provided as a default collection, then a new MemoryConfiguration will be created to hold the new default value.

This method will not hold a reference to the specified Configuration, nor will it automatically update if that Configuration ever changes. If you require this, you should set the default source with setDefaults(org.bukkit.configuration.Configuration).

パラメータ:

defaults - A configuration holding a list of defaults to copy.

例外:

IllegalArgumentException - Thrown if defaults is null or this.

setDefaults

void setDefaults(Configuration defaults)

Sets the source of all default values for this Configuration.

If a previous source was set, or previous default values were defined, then they will not be copied to the new source.

パラメータ:

defaults - New source of default values for this configuration.

例外:

IllegalArgumentException - Thrown if defaults is null or this.

getDefaults

Configuration getDefaults()

Gets the source Configuration for this configuration.

If no configuration source was set, but default values were added, then a MemoryConfiguration will be returned. If no source was set and no defaults were set, then this method will return null.

戻り値:

Configuration source for default values, or null if none exist.

options

ConfigurationOptions options()

Gets the ConfigurationOptions for this Configuration.

All setters through this method are chainable.

戻り値:

Options for this configuration