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

Inheritance diagram for org.bukkit.configuration.file.FileConfigurationOptions:

Collaboration diagram for org.bukkit.configuration.file.FileConfigurationOptions:

Public Member Functions
FileConfiguration	configuration ()

FileConfigurationOptions	copyDefaults (boolean value)

FileConfigurationOptions	pathSeparator (char value)

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

FileConfigurationOptions	header (String value)
	Sets the header that will be applied to the top of the saved output.

boolean	copyHeader ()
	Gets whether or not the header should be copied from a default source.

FileConfigurationOptions	copyHeader (boolean value)
	Sets whether or not the header should be copied from a default source.

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 ()
	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
	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 8 of file FileConfigurationOptions.java.

Constructor & Destructor Documentation

org.bukkit.configuration.file.FileConfigurationOptions.FileConfigurationOptions ( MemoryConfiguration configuration )

protected

Definition at line 12 of file FileConfigurationOptions.java.

Member Function Documentation

FileConfiguration org.bukkit.configuration.file.FileConfigurationOptions.configuration ( )

Definition at line 17 of file FileConfigurationOptions.java.

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

Definition at line 22 of file FileConfigurationOptions.java.

References org.bukkit.configuration.file.FileConfigurationOptions.copyDefaults().

Referenced by org.bukkit.configuration.file.FileConfigurationOptions.copyDefaults().

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 83 of file FileConfigurationOptions.java.

Referenced by org.bukkit.configuration.file.FileConfigurationOptions.copyHeader().

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

value Whether or not to copy the header

Returns: This object, for chaining

Definition at line 103 of file FileConfigurationOptions.java.

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

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 46 of file FileConfigurationOptions.java.

Referenced by org.bukkit.configuration.file.FileConfigurationOptions.header().

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

value New header

Returns: This object, for chaining

Definition at line 63 of file FileConfigurationOptions.java.

References org.bukkit.configuration.file.FileConfigurationOptions.header().

FileConfigurationOptions org.bukkit.configuration.file.FileConfigurationOptions.pathSeparator ( char value )

Definition at line 28 of file FileConfigurationOptions.java.

References org.bukkit.configuration.file.FileConfigurationOptions.pathSeparator().

Referenced by org.bukkit.configuration.file.FileConfigurationOptions.pathSeparator().

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

org/bukkit/configuration/file/FileConfigurationOptions.java

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation