org.bspfsystems.yamlconfiguration.configuration

Class MemoryConfigurationOptions

java.lang.Object

org.bspfsystems.yamlconfiguration.configuration.ConfigurationOptions

org.bspfsystems.yamlconfiguration.configuration.MemoryConfigurationOptions

Direct Known Subclasses:

FileConfigurationOptions

public class MemoryConfigurationOptions
extends ConfigurationOptions

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

Synchronized with the commit on 13-March-2019.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
@NotNull MemoryConfiguration	configuration() Deprecated.
@NotNull MemoryConfigurationOptions	copyDefaults(boolean copyDefaults) Deprecated.
@NotNull MemoryConfiguration	getConfiguration() Gets the Configuration that this ConfigurationOptions controls.
@NotNull MemoryConfigurationOptions	pathSeparator(char pathSeparator) Deprecated.
@NotNull MemoryConfigurationOptions	setCopyDefaults(boolean copyDefaults) Sets if the Configuration should copy values from its default Configuration directly.
@NotNull MemoryConfigurationOptions	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

MemoryConfigurationOptions

protected MemoryConfigurationOptions(@NotNull
                                     @NotNull MemoryConfiguration configuration)

Constructs a new set of MemoryConfigurationOptions.

Parameters:

configuration - The MemoryConfiguration to create the MemoryConfigurationOptions for.

See Also:

ConfigurationOptions(Configuration)

Method Detail

getConfiguration

@NotNull
public @NotNull MemoryConfiguration getConfiguration()

Gets the Configuration that this ConfigurationOptions controls.

Overrides:

getConfiguration in class ConfigurationOptions

Returns:

The Configuration that this ConfigurationOptions controls.

configuration

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

Returns:

The Configuration that this ConfigurationOptions controls.

See Also:

ConfigurationOptions.getConfiguration()

setPathSeparator

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

Parameters:

pathSeparator - The char used to separate ConfigurationSections.

Returns:

This ConfigurationOptions, for chaining.

pathSeparator

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

Parameters:

pathSeparator - The char used to separate ConfigurationSections.

Returns:

This ConfigurationOptions, for chaining.

See Also:

ConfigurationOptions.setPathSeparator(char)

setCopyDefaults

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

Parameters:

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

Returns:

This ConfigurationOptions, for chaining.

copyDefaults

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

Parameters:

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

Returns:

This ConfigurationOptions, for chaining.

See Also:

ConfigurationOptions.setCopyDefaults(boolean)