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() Returns the Configuration that this object is responsible for.
@NotNull MemoryConfigurationOptions	copyDefaults(boolean copyDefaults) Sets if the Configuration should copy values from its default Configuration directly.
@NotNull MemoryConfigurationOptions	pathSeparator(char pathSeparator) Sets the char that will be used to separate ConfigurationSections

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

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

configuration

@NotNull
public @NotNull MemoryConfiguration configuration()

Returns the Configuration that this object is responsible for.

Overrides:

configuration in class ConfigurationOptions

Returns:

Parent configuration

pathSeparator

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

Parameters:

pathSeparator - Path separator

Returns:

This object, for chaining

copyDefaults

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

Parameters:

copyDefaults - Whether or not defaults are directly copied

Returns:

This object, for chaining