org.bspfsystems.yamlconfiguration.configuration

Class ConfigurationOptions

java.lang.Object

org.bspfsystems.yamlconfiguration.configuration.ConfigurationOptions

Direct Known Subclasses:

MemoryConfigurationOptions

public class ConfigurationOptions
extends Object

Various settings for controlling the input and output of a Configuration.

Synchronized with the commit on 13-March-2019.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
@NotNull Configuration	configuration() Deprecated. This method exists for backwards compatibility. Please use getConfiguration() instead.
boolean	copyDefaults() Deprecated. This method exists for backwards compatibility. Please use getCopyDefaults() instead.
@NotNull ConfigurationOptions	copyDefaults(boolean copyDefaults) Deprecated. This method exists for backwards compatibility. Please use setCopyDefaults(boolean) instead.
@NotNull Configuration	getConfiguration() Gets the Configuration that this ConfigurationOptions controls.
boolean	getCopyDefaults() Checks if the Configuration should copy values from its default Configuration directly.
char	getPathSeparator() Gets the char that will be used to separate ConfigurationSections.
char	pathSeparator() Deprecated. This method exists for backwards compatibility. Please use getPathSeparator() instead.
@NotNull ConfigurationOptions	pathSeparator(char pathSeparator) Deprecated. This method exists for backwards compatibility. Please use setPathSeparator(char) instead.
@NotNull ConfigurationOptions	setCopyDefaults(boolean copyDefaults) Sets if the Configuration should copy values from its default Configuration directly.
@NotNull ConfigurationOptions	setPathSeparator(char pathSeparator) Sets the char that will be used to separate ConfigurationSections.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationOptions

protected ConfigurationOptions(@NotNull
                               @NotNull Configuration configuration)

Constructs a new set of ConfigurationOptions.

Parameters:

configuration - The Configuration to create the ConfigurationOptions for.

Method Detail

getConfiguration

@NotNull
public @NotNull Configuration getConfiguration()

Gets the Configuration that this ConfigurationOptions controls.

Returns:

The Configuration that this ConfigurationOptions controls.

configuration

@Deprecated
 @NotNull
public @NotNull Configuration configuration()

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

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

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

Returns:

The Configuration that this ConfigurationOptions controls.

See Also:

getConfiguration()

getPathSeparator

public final char getPathSeparator()

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

Returns:

The char used to separate ConfigurationSections.

pathSeparator

@Deprecated
public final char pathSeparator()

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

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

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

Returns:

The char used to separate ConfigurationSections.

See Also:

getPathSeparator()

setPathSeparator

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

Parameters:

pathSeparator - The char used to separate ConfigurationSections.

Returns:

This ConfigurationOptions, for chaining.

pathSeparator

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

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

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

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

Parameters:

pathSeparator - The char used to separate ConfigurationSections.

Returns:

This ConfigurationOptions, for chaining.

See Also:

setPathSeparator(char)

getCopyDefaults

public final boolean getCopyDefaults()

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

Returns:

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

copyDefaults

@Deprecated
public final boolean copyDefaults()

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

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

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

Returns:

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

See Also:

getCopyDefaults()

setCopyDefaults

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

Parameters:

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

Returns:

This ConfigurationOptions, for chaining.

copyDefaults

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

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

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

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

Parameters:

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

Returns:

This ConfigurationOptions, for chaining.

See Also:

setCopyDefaults(boolean)