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

Various settings for controlling the input and output of a Configuration. More...

+ Inheritance diagram for org.bukkit.configuration.ConfigurationOptions:

Public Member Functions

Configuration configuration ()
 Returns the Configuration that this object is responsible for.
 
char pathSeparator ()
 Gets the char that will be used to separate ConfigurationSections.
 
ConfigurationOptions pathSeparator (char value)
 Sets the char that will be used to separate ConfigurationSections.
 
boolean copyDefaults ()
 Checks if the Configuration should copy values from its default Configuration directly.
 
ConfigurationOptions copyDefaults (boolean value)
 Sets if the Configuration should copy values from its default Configuration directly.
 

Protected Member Functions

 ConfigurationOptions (Configuration configuration)
 

Detailed Description

Various settings for controlling the input and output of a Configuration.

Definition at line 6 of file ConfigurationOptions.java.

Constructor & Destructor Documentation

org.bukkit.configuration.ConfigurationOptions.ConfigurationOptions ( Configuration  configuration)
protected

Member Function Documentation

Configuration org.bukkit.configuration.ConfigurationOptions.configuration ( )

Returns the Configuration that this object is responsible for.

Returns
Parent configuration

Definition at line 20 of file ConfigurationOptions.java.

Referenced by org.bukkit.configuration.ConfigurationOptions.ConfigurationOptions().

boolean org.bukkit.configuration.ConfigurationOptions.copyDefaults ( )

Checks if the Configuration should copy values from its default Configuration directly.

If this is true, all values in the default Configuration will be directly copied, making it impossible to distinguish between values that were set and values that are provided by default. As a result, ConfigurationSection#contains(java.lang.String) will always return the same value as ConfigurationSection#isSet(java.lang.String). The default value is false.

Returns
Whether or not defaults are directly copied

Definition at line 61 of file ConfigurationOptions.java.

Referenced by org.bukkit.configuration.ConfigurationOptions.copyDefaults().

ConfigurationOptions org.bukkit.configuration.ConfigurationOptions.copyDefaults ( boolean  value)

Sets if the Configuration should copy values from its default Configuration directly.

If this is true, all values in the default Configuration will be directly copied, making it impossible to distinguish between values that were set and values that are provided by default. As a result, ConfigurationSection#contains(java.lang.String) will always return the same value as ConfigurationSection#isSet(java.lang.String). The default value is false.

Parameters
valueWhether or not defaults are directly copied
Returns
This object, for chaining

Definition at line 77 of file ConfigurationOptions.java.

References org.bukkit.configuration.ConfigurationOptions.copyDefaults().

char org.bukkit.configuration.ConfigurationOptions.pathSeparator ( )

Gets the char that will be used to separate ConfigurationSections.

This value does not affect how the Configuration is stored, only in how you access the data. The default value is '.'.

Returns
Path separator

Definition at line 32 of file ConfigurationOptions.java.

Referenced by org.bukkit.configuration.ConfigurationOptions.pathSeparator().

ConfigurationOptions org.bukkit.configuration.ConfigurationOptions.pathSeparator ( char  value)

Sets the char that will be used to separate ConfigurationSections.

This value does not affect how the Configuration is stored, only in how you access the data. The default value is '.'.

Parameters
valuePath separator
Returns
This object, for chaining

Definition at line 45 of file ConfigurationOptions.java.

References org.bukkit.configuration.ConfigurationOptions.pathSeparator().


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