Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.configuration.ConfigurationOptions Class Reference
Inheritance diagram for org.bukkit.configuration.ConfigurationOptions:
org.bukkit.configuration.MemoryConfigurationOptions org.bukkit.configuration.file.FileConfigurationOptions org.bukkit.configuration.file.YamlConfigurationOptions

Public Member Functions

Configuration configuration ()
 
char pathSeparator ()
 
ConfigurationOptions pathSeparator (char value)
 
boolean copyDefaults ()
 
ConfigurationOptions copyDefaults (boolean value)
 

Protected Member Functions

 ConfigurationOptions (Configuration configuration)
 

Detailed Description

Various settings for controlling the input and output of a Configuration

Definition at line 7 of file ConfigurationOptions.java.

Member Function Documentation

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

Returns the Configuration that this object is responsible for.

Returns
Parent configuration

Definition at line 21 of file ConfigurationOptions.java.

21  {
22  return configuration;
23  }
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 67 of file ConfigurationOptions.java.

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 86 of file ConfigurationOptions.java.

86  {
87  this.copyDefaults = value;
88  return this;
89  }
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 34 of file ConfigurationOptions.java.

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 48 of file ConfigurationOptions.java.

48  {
49  this.pathSeparator = value;
50  return this;
51  }

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