org.bukkit.configuration.file

Class FileConfigurationOptions

java.lang.Object

org.bukkit.configuration.ConfigurationOptions

org.bukkit.configuration.MemoryConfigurationOptions

org.bukkit.configuration.file.FileConfigurationOptions

Direct Known Subclasses:

YamlConfigurationOptions

public class FileConfigurationOptions
extends MemoryConfigurationOptions

Various settings for controlling the input and output of a FileConfiguration

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileConfigurationOptions(MemoryConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
FileConfiguration	configuration() Returns the Configuration that this object is responsible for.
FileConfigurationOptions	copyDefaults(boolean value) Sets if the Configuration should copy values from its default Configuration directly.
boolean	copyHeader() Deprecated. Call parseComments() instead.
FileConfigurationOptions	copyHeader(boolean value) Deprecated. Call parseComments(boolean) instead.
List<String>	getFooter() Gets the footer that will be applied to the bottom of the saved output.
List<String>	getHeader() Gets the header that will be applied to the top of the saved output.
String	header() Deprecated. use getHeader() instead.
FileConfigurationOptions	header(String value) Deprecated. use setHeader() instead
boolean	parseComments() Gets whether or not comments should be loaded and saved.
MemoryConfigurationOptions	parseComments(boolean value) Sets whether or not comments should be loaded and saved.
FileConfigurationOptions	pathSeparator(char value) Sets the char that will be used to separate ConfigurationSections
FileConfigurationOptions	setFooter(List<String> value) Sets the footer that will be applied to the bottom of the saved output.
FileConfigurationOptions	setHeader(List<String> value) Sets the header that will be applied to the top of the saved output.

Methods inherited from class org.bukkit.configuration.ConfigurationOptions

copyDefaults, pathSeparator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileConfigurationOptions

protected FileConfigurationOptions(@NotNull
                                   MemoryConfiguration configuration)

Method Detail

configuration

@NotNull
public FileConfiguration configuration()

Description copied from class: ConfigurationOptions

Returns the Configuration that this object is responsible for.

Overrides:

configuration in class MemoryConfigurationOptions

Returns:

Parent configuration

copyDefaults

@NotNull
public FileConfigurationOptions copyDefaults(boolean value)

Description copied from class: ConfigurationOptions

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.

Overrides:

copyDefaults in class MemoryConfigurationOptions

Parameters:

value - Whether or not defaults are directly copied

Returns:

This object, for chaining

pathSeparator

@NotNull
public FileConfigurationOptions pathSeparator(char value)

Description copied from class: ConfigurationOptions

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 '.'.

Overrides:

pathSeparator in class MemoryConfigurationOptions

Parameters:

value - Path separator

Returns:

This object, for chaining

getHeader

@NotNull
public List<String> getHeader()

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.

If no comments exist, an empty list will be returned. A null entry represents an empty line and an empty String represents an empty comment line.

Returns:

Unmodifiable header, every entry represents one line.

header

@NotNull
 @Deprecated
public String header()

Deprecated. use getHeader() instead.

Returns:

The string header.

setHeader

@NotNull
public FileConfigurationOptions setHeader(@Nullable
                                                   List<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.

If no comments exist, an empty list will be returned. A null entry represents an empty line and an empty String represents an empty comment line.

Parameters:

value - New header, every entry represents one line.

Returns:

This object, for chaining

header

@NotNull
 @Deprecated
public FileConfigurationOptions header(@Nullable
                                                             String value)

Deprecated. use setHeader() instead

Parameters:

value - The string header.

Returns:

This object, for chaining.

getFooter

@NotNull
public List<String> getFooter()

Gets the footer that will be applied to the bottom of the saved output.

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

If no comments exist, an empty list will be returned. A null entry represents an empty line and an empty String represents an empty comment line.

Returns:

Unmodifiable footer, every entry represents one line.

setFooter

@NotNull
public FileConfigurationOptions setFooter(@Nullable
                                                   List<String> value)

Sets the footer that will be applied to the bottom of the saved output.

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

If no comments exist, an empty list will be returned. A null entry represents an empty line and an empty String represents an empty comment line.

Parameters:

value - New footer, every entry represents one line.

Returns:

This object, for chaining

parseComments

public boolean parseComments()

Gets whether or not comments should be loaded and saved.

Defaults to true.

Returns:

Whether or not comments are parsed.

parseComments

@NotNull
public MemoryConfigurationOptions parseComments(boolean value)

Sets whether or not comments should be loaded and saved.

Defaults to true.

Parameters:

value - Whether or not comments are parsed.

Returns:

This object, for chaining

copyHeader

@Deprecated
public boolean copyHeader()

Deprecated. Call parseComments() instead.

Returns:

Whether or not comments are parsed.

copyHeader

@NotNull
 @Deprecated
public FileConfigurationOptions copyHeader(boolean value)

Deprecated. Call parseComments(boolean) instead.

Parameters:

value - Should comments be parsed.

Returns:

This object, for chaining