Package org.simpleyaml.configuration.file

Class YamlConfigurationOptions

java.lang.Object

org.simpleyaml.configuration.ConfigurationOptions

org.simpleyaml.configuration.MemoryConfigurationOptions

org.simpleyaml.configuration.file.FileConfigurationOptions

org.simpleyaml.configuration.file.YamlConfigurationOptions

public class YamlConfigurationOptions
extends FileConfigurationOptions

Various settings for controlling the input and output of a YamlConfiguration

Author:

Bukkit, Carleslc

See Also:

• Bukkit Source

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	YamlConfigurationOptions.QuoteStyleDefaults	Options to configure the default QuoteStyle for each type.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	YamlConfigurationOptions(YamlConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
YamlConfigurationOptions	charset(Charset charset)
YamlCommentFormatter	commentFormatter()	Gets the comment formatter used to format comments.
YamlConfigurationOptions	commentFormatter(YamlCommentFormatter commentFormatter)	Sets the comment formatter to be used to format comments.
YamlConfiguration	configuration()	Returns the Configuration that this object is responsible for.
YamlConfigurationOptions	copyDefaults(boolean value)	Sets if the Configuration should copy values from its default Configuration directly.
YamlConfigurationOptions	copyHeader(boolean value)	Sets whether or not the header should be copied from a default source.
boolean	equals(Object o)
int	hashCode()
YamlConfigurationOptions	header(String header)	Sets the header that will be applied to the top of the saved output.
YamlHeaderFormatter	headerFormatter()	Gets the header format used for parsing and dumping the header.
YamlConfigurationOptions	headerFormatter(CommentFormatter headerFormatter)	Sets the header format used for parsing and dumping the header.
YamlConfigurationOptions	indent(int value)	Sets how much spaces should be used to indent each line.
int	indentList()	Gets how much spaces should be used to indent each list element, in addition to the line indent.
YamlConfigurationOptions	indentList(int value)	Sets how much spaces should be used to indent each list element, in addition to the line indent.
YamlConfigurationOptions	pathSeparator(char value)	Sets the char that will be used to separate ConfigurationSections
YamlConfigurationOptions.QuoteStyleDefaults	quoteStyleDefaults()	Get the quote style default options.
boolean	useComments()	Indicates if parsing comments is enabled.
YamlConfigurationOptions	useComments(boolean useComments)	Sets if parsing comments is needed.

Methods inherited from class org.simpleyaml.configuration.file.FileConfigurationOptions

charset, copyHeader, header, isUnicode

Methods inherited from class org.simpleyaml.configuration.ConfigurationOptions

copyDefaults, indent, pathSeparator

Methods inherited from class java.lang.Object

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

Constructor Details

YamlConfigurationOptions

protected YamlConfigurationOptions(YamlConfiguration configuration)

Method Details

configuration

public YamlConfiguration configuration()

Description copied from class: ConfigurationOptions

Returns the Configuration that this object is responsible for.

Overrides:

configuration in class FileConfigurationOptions

Returns:

Parent configuration

copyDefaults

public YamlConfigurationOptions 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(String) will always return the same value as ConfigurationSection.isSet(String). The default value is true.

Overrides:

copyDefaults in class FileConfigurationOptions

Parameters:

value - Whether or not defaults are directly copied

Returns:

This object, for chaining

pathSeparator

public YamlConfigurationOptions 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 FileConfigurationOptions

Parameters:

value - Path separator

Returns:

This object, for chaining

charset

public YamlConfigurationOptions charset(Charset charset)

Overrides:

charset in class FileConfigurationOptions

header

public YamlConfigurationOptions header(String header)

Description copied from class: FileConfigurationOptions

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 header which will indicate that no header is to be applied.

Overrides:

header in class FileConfigurationOptions

Parameters:

header - New header

Returns:

This object, for chaining

copyHeader

public YamlConfigurationOptions copyHeader(boolean value)

Description copied from class: FileConfigurationOptions

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

If this is true, if a default FileConfiguration is passed to MemoryConfiguration.setDefaults(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 (FileConfigurationOptions.header() returns null) then the header specified in this configuration will be used.

Defaults to true.

Overrides:

copyHeader in class FileConfigurationOptions

Parameters:

value - Whether or not to copy the header

Returns:

This object, for chaining

headerFormatter

public YamlConfigurationOptions headerFormatter(CommentFormatter headerFormatter)

Description copied from class: FileConfigurationOptions

Sets the header format used for parsing and dumping the header.

Overrides:

headerFormatter in class FileConfigurationOptions

Parameters:

headerFormatter - The header formatter

Returns:

This object, for chaining

headerFormatter

public YamlHeaderFormatter headerFormatter()

Description copied from class: FileConfigurationOptions

Gets the header format used for parsing and dumping the header.

Overrides:

headerFormatter in class FileConfigurationOptions

Returns:

The header formatter

indent

public YamlConfigurationOptions indent(int value)

Sets how much spaces should be used to indent each line.

The minimum value this may be is 2, and the maximum is 9.

Overrides:

indent in class ConfigurationOptions

Parameters:

value - New indent

Returns:

This object, for chaining

indentList

public int indentList()

Gets how much spaces should be used to indent each list element, in addition to the line indent.

Returns:

the list elements indentation

indentList

public YamlConfigurationOptions indentList(int value)

Sets how much spaces should be used to indent each list element, in addition to the line indent.

The minimum value this may be is 0, and the maximum is the same as the ConfigurationOptions.indent().

Parameters:

value - New list indentation

Returns:

This object, for chaining

commentFormatter

public YamlCommentFormatter commentFormatter()

Gets the comment formatter used to format comments.

The default comment formatter is YamlCommentFormat.DEFAULT, which comment prefix is "# ", i.e. a # followed by a space.

Returns:

the comment formatter

commentFormatter

public YamlConfigurationOptions commentFormatter(YamlCommentFormatter commentFormatter)

Sets the comment formatter to be used to format comments.

If unset, the default comment formatter prefix is "# ", i.e. a # followed by a space.

Parameters:

commentFormatter - the comment formatter to use

Returns:

This object, for chaining

useComments

public YamlConfigurationOptions useComments(boolean useComments)

Sets if parsing comments is needed.

If you don't use comments in your configuration file keep this disabled to improve parsing performance.

Default is false.

With YamlFile it is updated automatically when you load a file with comments or set new comments programmatically.

Parameters:

useComments - if parsing comments is needed

Returns:

This object, for chaining

useComments

public boolean useComments()

Indicates if parsing comments is enabled.

If you don't use comments in your configuration file keep this disabled to improve parsing performance.

Default is false.

With YamlFile it is updated automatically when you load a file with comments or set new comments programmatically.

Returns:

This object, for chaining

See Also:

• useComments(boolean)

quoteStyleDefaults

public YamlConfigurationOptions.QuoteStyleDefaults quoteStyleDefaults()

Get the quote style default options.

You can change the default quote style globally or for specific value types.

Returns:

the quote style default options

See Also:

• QuoteStyle.PLAIN
• QuoteStyle.SINGLE
• QuoteStyle.DOUBLE

equals

public boolean equals(Object o)

Overrides:

equals in class FileConfigurationOptions

hashCode

public int hashCode()

Overrides:

hashCode in class FileConfigurationOptions