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

Public Member Functions

FileConfiguration configuration ()
 
FileConfigurationOptions copyDefaults (boolean value)
 
FileConfigurationOptions pathSeparator (char value)
 
String header ()
 
FileConfigurationOptions header (String value)
 
boolean copyHeader ()
 
FileConfigurationOptions copyHeader (boolean value)
 
- Public Member Functions inherited from org.bukkit.configuration.MemoryConfigurationOptions
MemoryConfiguration configuration ()
 
MemoryConfigurationOptions copyDefaults (boolean value)
 
MemoryConfigurationOptions pathSeparator (char value)
 
- Public Member Functions inherited from org.bukkit.configuration.ConfigurationOptions
Configuration configuration ()
 
char pathSeparator ()
 
ConfigurationOptions pathSeparator (char value)
 
boolean copyDefaults ()
 
ConfigurationOptions copyDefaults (boolean value)
 

Protected Member Functions

 FileConfigurationOptions (MemoryConfiguration configuration)
 
- Protected Member Functions inherited from org.bukkit.configuration.MemoryConfigurationOptions
 MemoryConfigurationOptions (MemoryConfiguration configuration)
 
- Protected Member Functions inherited from org.bukkit.configuration.ConfigurationOptions
 ConfigurationOptions (Configuration configuration)
 

Detailed Description

Various settings for controlling the input and output of a FileConfiguration

Definition at line 9 of file FileConfigurationOptions.java.

Member Function Documentation

boolean org.bukkit.configuration.file.FileConfigurationOptions.copyHeader ( )

Gets whether or not the header should be copied from a default source.

If this is true, if a default FileConfiguration is passed to FileConfiguration#setDefaults(org.bukkit.configuration.Configuration) then upon saving it will use the header from that config, instead of the one provided here.

If no default is set on the configuration, or the default is not of type FileConfiguration, or that config has no header (header() returns null) then the header specified in this configuration will be used.

Defaults to true.

Returns
Whether or not to copy the header

Definition at line 90 of file FileConfigurationOptions.java.

FileConfigurationOptions org.bukkit.configuration.file.FileConfigurationOptions.copyHeader ( boolean  value)

Sets whether or not the header should be copied from a default source.

If this is true, if a default FileConfiguration is passed to FileConfiguration#setDefaults(org.bukkit.configuration.Configuration) then upon saving it will use the header from that config, instead of the one provided here.

If no default is set on the configuration, or the default is not of type FileConfiguration, or that config has no header (header() returns null) then the header specified in this configuration will be used.

Defaults to true.

Parameters
valueWhether or not to copy the header
Returns
This object, for chaining

Definition at line 113 of file FileConfigurationOptions.java.

113  {
114  copyHeader = value;
115 
116  return this;
117  }
String org.bukkit.configuration.file.FileConfigurationOptions.header ( )

Gets the header that will be applied to the top of the saved output.

This header will be commented out and applied directly at the top of the generated output of the FileConfiguration. It is not required to include a newline at the end of the header as it will automatically be applied, but you may include one if you wish for extra spacing.

Null is a valid value which will indicate that no header is to be applied. The default value is null.

Returns
Header

Definition at line 48 of file FileConfigurationOptions.java.

FileConfigurationOptions org.bukkit.configuration.file.FileConfigurationOptions.header ( String  value)

Sets the header that will be applied to the top of the saved output.

This header will be commented out and applied directly at the top of the generated output of the FileConfiguration. It is not required to include a newline at the end of the header as it will automatically be applied, but you may include one if you wish for extra spacing.

Null is a valid value which will indicate that no header is to be applied.

Parameters
valueNew header
Returns
This object, for chaining

Definition at line 67 of file FileConfigurationOptions.java.

67  {
68  this.header = value;
69  return this;
70  }

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