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

Represents the various settings for controlling the input and output of a memory configuration.

Synchronized with the commit on 13-March-2019.

Field Summary

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

DEFAULT_COPY_DEFAULTS, DEFAULT_PATH_SEPARATOR

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
@NotNull MemoryConfiguration	getConfiguration() Gets the configuration that these options controls.
@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 configuration sections.

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

getCopyDefaults, getPathSeparator

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 set of memory configuration options.

Parameters:

configuration - The memory configuration to create the options for.

See Also:

ConfigurationOptions(Configuration)

Method Detail

getConfiguration

@NotNull
public @NotNull MemoryConfiguration getConfiguration()

Gets the configuration that these options controls.

Overrides:

getConfiguration in class ConfigurationOptions

Returns:

The configuration that these options controls.

setPathSeparator

@NotNull
public @NotNull MemoryConfigurationOptions setPathSeparator(char pathSeparator)

Sets the char that will be used to separate configuration sections.

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 configuration sections.

Returns:

These options, for chaining.

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:

These options, for chaining.