Bukkit  1.4.7-R1.0
 All Classes Namespaces Files Functions Variables Enumerator Pages
org.bukkit.configuration.MemoryConfiguration Class Reference

This is a Configuration implementation that does not save or load from any source, and stores all values in memory only. More...

+ Inheritance diagram for org.bukkit.configuration.MemoryConfiguration:
+ Collaboration diagram for org.bukkit.configuration.MemoryConfiguration:

Public Member Functions

 MemoryConfiguration ()
 Creates an empty MemoryConfiguration with no default values.
 
 MemoryConfiguration (Configuration defaults)
 Creates an empty MemoryConfiguration using the specified Configuration as a source for all default values.
 
void addDefault (String path, Object value)
 
void addDefaults (Map< String, Object > defaults)
 
void addDefaults (Configuration defaults)
 
void setDefaults (Configuration defaults)
 
Configuration getDefaults ()
 
ConfigurationSection getParent ()
 
MemoryConfigurationOptions options ()
 
- Public Member Functions inherited from org.bukkit.configuration.MemorySection
Set< String > getKeys (boolean deep)
 
Map< String, Object > getValues (boolean deep)
 
boolean contains (String path)
 
boolean isSet (String path)
 
String getCurrentPath ()
 
String getName ()
 
Configuration getRoot ()
 
ConfigurationSection getParent ()
 
void addDefault (String path, Object value)
 
ConfigurationSection getDefaultSection ()
 
void set (String path, Object value)
 
Object get (String path)
 
Object get (String path, Object def)
 
ConfigurationSection createSection (String path)
 
ConfigurationSection createSection (String path, Map<?,?> map)
 
String getString (String path)
 
String getString (String path, String def)
 
boolean isString (String path)
 
int getInt (String path)
 
int getInt (String path, int def)
 
boolean isInt (String path)
 
boolean getBoolean (String path)
 
boolean getBoolean (String path, boolean def)
 
boolean isBoolean (String path)
 
double getDouble (String path)
 
double getDouble (String path, double def)
 
boolean isDouble (String path)
 
long getLong (String path)
 
long getLong (String path, long def)
 
boolean isLong (String path)
 
List<?> getList (String path)
 
List<?> getList (String path, List<?> def)
 
boolean isList (String path)
 
List< String > getStringList (String path)
 
List< Integer > getIntegerList (String path)
 
List< Boolean > getBooleanList (String path)
 
List< Double > getDoubleList (String path)
 
List< Float > getFloatList (String path)
 
List< Long > getLongList (String path)
 
List< Byte > getByteList (String path)
 
List< Character > getCharacterList (String path)
 
List< Short > getShortList (String path)
 
List< Map<?,?> > getMapList (String path)
 
Vector getVector (String path)
 
Vector getVector (String path, Vector def)
 
boolean isVector (String path)
 
OfflinePlayer getOfflinePlayer (String path)
 
OfflinePlayer getOfflinePlayer (String path, OfflinePlayer def)
 
boolean isOfflinePlayer (String path)
 
ItemStack getItemStack (String path)
 
ItemStack getItemStack (String path, ItemStack def)
 
boolean isItemStack (String path)
 
Color getColor (String path)
 
Color getColor (String path, Color def)
 
boolean isColor (String path)
 
ConfigurationSection getConfigurationSection (String path)
 
boolean isConfigurationSection (String path)
 
String toString ()
 
- Public Member Functions inherited from org.bukkit.configuration.ConfigurationSection
Set< String > getKeys (boolean deep)
 Gets a set containing all keys in this section.
 
Map< String, Object > getValues (boolean deep)
 Gets a Map containing all keys and their values for this section.
 
boolean contains (String path)
 Checks if this ConfigurationSection contains the given path.
 
boolean isSet (String path)
 Checks if this ConfigurationSection has a value set for the given path.
 
String getCurrentPath ()
 Gets the path of this ConfigurationSection from its root Configuration.
 
String getName ()
 Gets the name of this individual ConfigurationSection, in the path.
 
Configuration getRoot ()
 Gets the root Configuration that contains this ConfigurationSection.
 
ConfigurationSection getParent ()
 Gets the parent ConfigurationSection that directly contains this ConfigurationSection.
 
Object get (String path)
 Gets the requested Object by path.
 
Object get (String path, Object def)
 Gets the requested Object by path, returning a default value if not found.
 
void set (String path, Object value)
 Sets the specified path to the given value.
 
ConfigurationSection createSection (String path)
 Creates an empty ConfigurationSection at the specified path.
 
ConfigurationSection createSection (String path, Map<?,?> map)
 Creates a ConfigurationSection at the specified path, with specified values.
 
String getString (String path)
 Gets the requested String by path.
 
String getString (String path, String def)
 Gets the requested String by path, returning a default value if not found.
 
boolean isString (String path)
 Checks if the specified path is a String.
 
int getInt (String path)
 Gets the requested int by path.
 
int getInt (String path, int def)
 Gets the requested int by path, returning a default value if not found.
 
boolean isInt (String path)
 Checks if the specified path is an int.
 
boolean getBoolean (String path)
 Gets the requested boolean by path.
 
boolean getBoolean (String path, boolean def)
 Gets the requested boolean by path, returning a default value if not found.
 
boolean isBoolean (String path)
 Checks if the specified path is a boolean.
 
double getDouble (String path)
 Gets the requested double by path.
 
double getDouble (String path, double def)
 Gets the requested double by path, returning a default value if not found.
 
boolean isDouble (String path)
 Checks if the specified path is a double.
 
long getLong (String path)
 Gets the requested long by path.
 
long getLong (String path, long def)
 Gets the requested long by path, returning a default value if not found.
 
boolean isLong (String path)
 Checks if the specified path is a long.
 
List<?> getList (String path)
 Gets the requested List by path.
 
List<?> getList (String path, List<?> def)
 Gets the requested List by path, returning a default value if not found.
 
boolean isList (String path)
 Checks if the specified path is a List.
 
List< String > getStringList (String path)
 Gets the requested List of String by path.
 
List< Integer > getIntegerList (String path)
 Gets the requested List of Integer by path.
 
List< Boolean > getBooleanList (String path)
 Gets the requested List of Boolean by path.
 
List< Double > getDoubleList (String path)
 Gets the requested List of Double by path.
 
List< Float > getFloatList (String path)
 Gets the requested List of Float by path.
 
List< Long > getLongList (String path)
 Gets the requested List of Long by path.
 
List< Byte > getByteList (String path)
 Gets the requested List of Byte by path.
 
List< Character > getCharacterList (String path)
 Gets the requested List of Character by path.
 
List< Short > getShortList (String path)
 Gets the requested List of Short by path.
 
List< Map<?,?> > getMapList (String path)
 Gets the requested List of Maps by path.
 
Vector getVector (String path)
 Gets the requested Vector by path.
 
Vector getVector (String path, Vector def)
 Gets the requested Vector by path, returning a default value if not found.
 
boolean isVector (String path)
 Checks if the specified path is a Vector.
 
OfflinePlayer getOfflinePlayer (String path)
 Gets the requested OfflinePlayer by path.
 
OfflinePlayer getOfflinePlayer (String path, OfflinePlayer def)
 Gets the requested OfflinePlayer by path, returning a default value if not found.
 
boolean isOfflinePlayer (String path)
 Checks if the specified path is an OfflinePlayer.
 
ItemStack getItemStack (String path)
 Gets the requested ItemStack by path.
 
ItemStack getItemStack (String path, ItemStack def)
 Gets the requested ItemStack by path, returning a default value if not found.
 
boolean isItemStack (String path)
 Checks if the specified path is an ItemStack.
 
Color getColor (String path)
 Gets the requested Color by path.
 
Color getColor (String path, Color def)
 Gets the requested Color by path, returning a default value if not found.
 
boolean isColor (String path)
 Checks if the specified path is a Color.
 
ConfigurationSection getConfigurationSection (String path)
 Gets the requested ConfigurationSection by path.
 
boolean isConfigurationSection (String path)
 Checks if the specified path is a ConfigurationSection.
 
ConfigurationSection getDefaultSection ()
 Gets the equivalent ConfigurationSection from the default Configuration defined in getRoot().
 
void addDefault (String path, Object value)
 Sets the default value in the root at the given path as provided.
 
- Public Member Functions inherited from org.bukkit.configuration.Configuration
void addDefault (String path, Object value)
 Sets the default value of the given path as provided.
 
void addDefaults (Map< String, Object > defaults)
 Sets the default values of the given paths as provided.
 
void addDefaults (Configuration defaults)
 Sets the default values of the given paths as provided.
 
void setDefaults (Configuration defaults)
 Sets the source of all default values for this Configuration.
 
Configuration getDefaults ()
 Gets the source Configuration for this configuration.
 
ConfigurationOptions options ()
 Gets the ConfigurationOptions for this Configuration.
 

Protected Attributes

Configuration defaults
 
MemoryConfigurationOptions options
 
- Protected Attributes inherited from org.bukkit.configuration.MemorySection
final Map< String, Object > map = new LinkedHashMap<String, Object>()
 

Additional Inherited Members

- Static Public Member Functions inherited from org.bukkit.configuration.MemorySection
static String createPath (ConfigurationSection section, String key)
 Creates a full path to the given ConfigurationSection from its root Configuration.
 
static String createPath (ConfigurationSection section, String key, ConfigurationSection relativeTo)
 Creates a relative path to the given ConfigurationSection from the given relative section.
 
- Protected Member Functions inherited from org.bukkit.configuration.MemorySection
 MemorySection ()
 Creates an empty MemorySection for use as a root Configuration section.
 
 MemorySection (ConfigurationSection parent, String path)
 Creates an empty MemorySection with the specified parent and path.
 
boolean isPrimitiveWrapper (Object input)
 
Object getDefault (String path)
 
void mapChildrenKeys (Set< String > output, ConfigurationSection section, boolean deep)
 
void mapChildrenValues (Map< String, Object > output, ConfigurationSection section, boolean deep)
 

Detailed Description

This is a Configuration implementation that does not save or load from any source, and stores all values in memory only.

This is useful for temporary Configurations for providing defaults.

Definition at line 12 of file MemoryConfiguration.java.

Constructor & Destructor Documentation

org.bukkit.configuration.MemoryConfiguration.MemoryConfiguration ( )

Creates an empty MemoryConfiguration with no default values.

Definition at line 19 of file MemoryConfiguration.java.

Referenced by org.bukkit.configuration.MemoryConfiguration.addDefault().

org.bukkit.configuration.MemoryConfiguration.MemoryConfiguration ( Configuration  defaults)

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

Parameters
defaultsDefault value provider
Exceptions
IllegalArgumentExceptionThrown if defaults is null

Definition at line 28 of file MemoryConfiguration.java.

References org.bukkit.configuration.MemoryConfiguration.defaults.

Member Function Documentation

void org.bukkit.configuration.MemoryConfiguration.addDefaults ( Map< String, Object >  defaults)
void org.bukkit.configuration.MemoryConfiguration.addDefaults ( Configuration  defaults)
Configuration org.bukkit.configuration.MemoryConfiguration.getDefaults ( )
ConfigurationSection org.bukkit.configuration.MemoryConfiguration.getParent ( )

Definition at line 68 of file MemoryConfiguration.java.

MemoryConfigurationOptions org.bukkit.configuration.MemoryConfiguration.options ( )

Definition at line 72 of file MemoryConfiguration.java.

void org.bukkit.configuration.MemoryConfiguration.setDefaults ( Configuration  defaults)

Member Data Documentation

MemoryConfigurationOptions org.bukkit.configuration.MemoryConfiguration.options
protected

Definition at line 14 of file MemoryConfiguration.java.


The documentation for this class was generated from the following file: