org.bspfsystems.yamlconfiguration.file

Class YamlConfigurationOptions

java.lang.Object

org.bspfsystems.yamlconfiguration.configuration.ConfigurationOptions

org.bspfsystems.yamlconfiguration.configuration.MemoryConfigurationOptions

org.bspfsystems.yamlconfiguration.file.FileConfigurationOptions

org.bspfsystems.yamlconfiguration.file.YamlConfigurationOptions

public final class YamlConfigurationOptions
extends FileConfigurationOptions

Various settings for controlling the input and output of a YamlConfiguration. Synchronized with the commit on 13-March-2019.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	YamlConfigurationOptions(@NotNull YamlConfiguration configuration) Constructs a new set of YamlConfigurationOptions.

Method Summary

Modifier and Type	Method and Description
@NotNull YamlConfiguration	configuration() Returns the Configuration that this object is responsible for.
@NotNull YamlConfigurationOptions	copyDefaults(boolean copyDefaults) Sets if the Configuration should copy values from its default Configuration directly.
@NotNull YamlConfigurationOptions	copyHeader(boolean copyHeader) Sets whether or not the header should be copied from a default source.
@NotNull YamlConfigurationOptions	header(@Nullable String header) Sets the header that will be applied to the top of the saved output.
int	indent() Gets how much spaces should be used to indent each line.
@NotNull YamlConfigurationOptions	indent(int indent) Sets how much spaces should be used to indent each line.
@NotNull YamlConfigurationOptions	pathSeparator(char pathSeparator) Sets the char that will be used to separate ConfigurationSections

Methods inherited from class org.bspfsystems.yamlconfiguration.file.FileConfigurationOptions

copyHeader, header

Methods inherited from class org.bspfsystems.yamlconfiguration.configuration.ConfigurationOptions

copyDefaults, pathSeparator

Methods inherited from class java.lang.Object

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

Constructor Detail

YamlConfigurationOptions

protected YamlConfigurationOptions(@NotNull
                                   @NotNull YamlConfiguration configuration)

Constructs a new set of YamlConfigurationOptions.

Parameters:

configuration - The YamlConfiguration to create the YamlConfigurationOptions for.

See Also:

FileConfigurationOptions(MemoryConfiguration)

Method Detail

configuration

@NotNull
public @NotNull YamlConfiguration configuration()

Returns the Configuration that this object is responsible for.

Overrides:

configuration in class FileConfigurationOptions

Returns:

Parent configuration

pathSeparator

@NotNull
public @NotNull YamlConfigurationOptions pathSeparator(char pathSeparator)

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:

pathSeparator - Path separator

Returns:

This object, for chaining

copyDefaults

@NotNull
public @NotNull YamlConfigurationOptions copyDefaults(boolean copyDefaults)

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 FileConfigurationOptions

Parameters:

copyDefaults - Whether or not defaults are directly copied

Returns:

This object, for chaining

header

@NotNull
public @NotNull YamlConfigurationOptions header(@Nullable
                                                         @Nullable String header)

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.

Overrides:

header in class FileConfigurationOptions

Parameters:

header - New header

Returns:

This object, for chaining

copyHeader

@NotNull
public @NotNull YamlConfigurationOptions copyHeader(boolean copyHeader)

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:

copyHeader - Whether or not to copy the header

Returns:

This object, for chaining

indent

public int indent()

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

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

Returns:

How much to indent by

indent

@NotNull
public @NotNull YamlConfigurationOptions indent(int indent)

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

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

Parameters:

indent - New indent

Returns:

This object, for chaining