org.bspfsystems.yamlconfiguration.file

Class FileConfigurationOptions

java.lang.Object

org.bspfsystems.yamlconfiguration.configuration.ConfigurationOptions

org.bspfsystems.yamlconfiguration.configuration.MemoryConfigurationOptions

org.bspfsystems.yamlconfiguration.file.FileConfigurationOptions

Direct Known Subclasses:

YamlConfigurationOptions

public class FileConfigurationOptions
extends MemoryConfigurationOptions

Various settings for controlling the input and output of a FileConfiguration. Synchronized with the commit on 20-December-2021.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
@NotNull FileConfiguration	configuration() Deprecated.
@NotNull FileConfigurationOptions	copyDefaults(boolean copyDefaults) Deprecated.
boolean	copyHeader() Deprecated. This method only exists for backwards compatibility. Please use getParseComments() instead.
@NotNull FileConfigurationOptions	copyHeader(boolean parseComments) Deprecated. This method only exists for backwards compatibility. Please use setParseComments(boolean) instead.
@NotNull FileConfiguration	getConfiguration() Gets the Configuration that this ConfigurationOptions controls.
@NotNull List<String>	getFooter() Gets the footer that will be applied to the bottom of the saved output.
@NotNull List<String>	getHeader() Gets the header that will be applied to the top of the saved output.
boolean	getParseComments() Gets whether the comments in a FileConfiguration should be loaded and saved.
@NotNull String	header() Deprecated. This method exists for backwards compatibility. Please use getHeader() instead.
@NotNull FileConfigurationOptions	header(@Nullable String header) Deprecated. This method exists for backwards compatibility. Please use setHeader(List) instead.
@NotNull FileConfigurationOptions	pathSeparator(char pathSeparator) Deprecated.
@NotNull FileConfigurationOptions	setCopyDefaults(boolean copyDefaults) Sets if the Configuration should copy values from its default Configuration directly.
@NotNull FileConfigurationOptions	setFooter(@Nullable List<String> footer) Sets the footer that will be applied to the bottom of the saved output.
@NotNull FileConfigurationOptions	setHeader(@Nullable List<String> header) Sets the header that will be applied to the top of the saved output.
@NotNull FileConfigurationOptions	setParseComments(boolean parseComments) Sets whether the comments in a FileConfiguration should be loaded and saved.
@NotNull FileConfigurationOptions	setPathSeparator(char pathSeparator) Sets the char that will be used to separate ConfigurationSections.

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

copyDefaults, getCopyDefaults, getPathSeparator, 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
                                   @NotNull MemoryConfiguration configuration)

Constructs a new set of FileConfigurationOptions.

Parameters:

configuration - The MemoryConfiguration to create the FileConfigurationOptions for.

See Also:

MemoryConfigurationOptions(MemoryConfiguration)

Method Detail

getConfiguration

@NotNull
public @NotNull FileConfiguration getConfiguration()

Gets the Configuration that this ConfigurationOptions controls.

Overrides:

getConfiguration in class MemoryConfigurationOptions

Returns:

The Configuration that this ConfigurationOptions controls.

configuration

@Deprecated
 @NotNull
public @NotNull FileConfiguration configuration()

Deprecated.

This method exists for backwards compatibility, and it will be removed in a future release.

Please use ConfigurationOptions.getConfiguration() instead; it provides the same functionality.

Overrides:

configuration in class MemoryConfigurationOptions

Returns:

The Configuration that this ConfigurationOptions controls.

See Also:

ConfigurationOptions.getConfiguration()

setPathSeparator

@NotNull
public @NotNull FileConfigurationOptions setPathSeparator(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:

setPathSeparator in class MemoryConfigurationOptions

Parameters:

pathSeparator - The char used to separate ConfigurationSections.

Returns:

This ConfigurationOptions, for chaining.

pathSeparator

@Deprecated
 @NotNull
public @NotNull FileConfigurationOptions pathSeparator(char pathSeparator)

Deprecated.

This method exists for backwards compatibility, and it will be removed in a future release.

Please use ConfigurationOptions.setPathSeparator(char) instead; it provides the same functionality.

Overrides:

pathSeparator in class MemoryConfigurationOptions

Parameters:

pathSeparator - The char used to separate ConfigurationSections.

Returns:

This ConfigurationOptions, for chaining.

See Also:

ConfigurationOptions.setPathSeparator(char)

setCopyDefaults

@NotNull
public @NotNull FileConfigurationOptions setCopyDefaults(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(String) will always return the same value as ConfigurationSection.isSet(String).

The default value is false.

Overrides:

setCopyDefaults in class MemoryConfigurationOptions

Parameters:

copyDefaults - true if the default values should be copied, false otherwise.

Returns:

This ConfigurationOptions, for chaining.

copyDefaults

@Deprecated
 @NotNull
public @NotNull FileConfigurationOptions copyDefaults(boolean copyDefaults)

Deprecated.

This method exists for backwards compatibility, and it will be removed in a future release.

Please use ConfigurationOptions.setCopyDefaults(boolean) instead; it provides the same functionality.

Overrides:

copyDefaults in class MemoryConfigurationOptions

Parameters:

copyDefaults - true if the default values should be copied, false otherwise.

Returns:

This ConfigurationOptions, for chaining.

See Also:

ConfigurationOptions.setCopyDefaults(boolean)

getHeader

@NotNull
public final @NotNull 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, and empty List will be returned. A null entry represents an empty line, and an empty String represents an empty comment line.

The default header is no header.

Returns:

An unmodifiable header as a List, where every entry represents one line.

header

@Deprecated
 @NotNull
public final @NotNull String header()

Deprecated. This method exists for backwards compatibility. Please use getHeader() instead.

This method exists for backwards compatibility, and it will be removed in a future release.

Please use getHeader() instead.

Returns:

An unmodifiable header as a List, where every entry represents one line.

See Also:

getHeader()

setHeader

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

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.

The default header is no header.

Parameters:

header - The new header, where every entry represents one line.

Returns:

This FileConfigurationOptions, for chaining.

header

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

Deprecated. This method exists for backwards compatibility. Please use setHeader(List) instead.

This method exists for backwards compatibility, and it will be removed in a future release.

Please use setHeader(List) instead.

Parameters:

header - The new header, where every entry represents one line.

Returns:

This FileConfigurationOptions, for chaining.

See Also:

setHeader(List)

getFooter

@NotNull
public final @NotNull 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.

The default footer is no footer.

Returns:

An unmodifiable footer, where every entry represents one line.

setFooter

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

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.

The default footer is no footer.

Parameters:

footer - The new footer, where every entry represents one line.

Returns:

This FileConfigurationOptions, for chaining.

getParseComments

public final boolean getParseComments()

Gets whether the comments in a FileConfiguration should be loaded and saved.

If this is true, and if a default FileConfiguration is passed to Configuration.setDefaults(Configuration), then upon saving, the default comments will be parsed from the passed default FileConfiguration, instead of the ones provided in here.

If no default is set on the Configuration, or the default is not a FileConfiguration, or that Configuration has no comments (getHeader() returns an empty List), then the header specified in this Configuration will be used.

The default value is true.

Returns:

true if the comments are to be parsed, false otherwise.

copyHeader

@Deprecated
public final boolean copyHeader()

Deprecated. This method only exists for backwards compatibility. Please use getParseComments() instead.

This method only exists for backwards compatibility, and it will be removed in a future release.

Please use getParseComments() instead; it provides the same functionality.

Returns:

true if the comments are to be parsed, false otherwise.

See Also:

getParseComments()

setParseComments

@NotNull
public @NotNull FileConfigurationOptions setParseComments(boolean parseComments)

Sets whether the comments in a FileConfiguration should be loaded and saved.

If this is true, and if a default FileConfiguration is passed to Configuration.setDefaults(Configuration), then upon saving, the default comments will be parsed from the passed default FileConfiguration, instead of the ones provided in here.

If no default is set on the Configuration, or the default is not a FileConfiguration, or that Configuration has no comments (getHeader() returns an empty List), then the header specified in this Configuration will be used.

The default value is true.

Parameters:

parseComments - true if the comments are to be parsed, false otherwise.

Returns:

This FileConfigurationOptions, for chaining.

copyHeader

@Deprecated
 @NotNull
public @NotNull FileConfigurationOptions copyHeader(boolean parseComments)

Deprecated. This method only exists for backwards compatibility. Please use setParseComments(boolean) instead.

This method only exists for backwards compatibility, and it will be removed in a future release.

Please use setParseComments(boolean) instead; it provides the same functionality.

Parameters:

parseComments - true if the comments are to be parsed, false otherwise.

Returns:

This FileConfigurationOptions, for chaining.

See Also:

setParseComments(boolean)