org.bspfsystems.yamlconfiguration.configuration

Class MemoryConfiguration

java.lang.Object

org.bspfsystems.yamlconfiguration.configuration.MemorySection

org.bspfsystems.yamlconfiguration.configuration.MemoryConfiguration

All Implemented Interfaces:

Configuration, ConfigurationSection

Direct Known Subclasses:

FileConfiguration

public class MemoryConfiguration
extends MemorySection
implements Configuration

This is a Configuration implementation that does not save or load from any source, and stores all values in memory only. This is useful for temporary Configurations for providing defaults. Synchronized with the commit on 04-December-2021.

Field Summary

Fields

Modifier and Type	Field and Description
protected Configuration	defs
protected MemoryConfigurationOptions	options

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

map

Constructor Summary

Constructors

Constructor and Description
MemoryConfiguration() Creates an empty MemoryConfiguration with no default values.
MemoryConfiguration(@Nullable Configuration defs) Creates an empty MemoryConfiguration using the specified Configuration as a source for all default values.

Method Summary

Modifier and Type	Method and Description
void	addDefault(@NotNull String path, @Nullable Object value) Sets the default value in the root at the given path as provided.
void	addDefaults(@NotNull Configuration defs) Sets the default values of the given paths as provided.
void	addDefaults(@NotNull Map<String,Object> defs) Sets the default values of the given paths as provided.
@Nullable Configuration	getDefaults() Gets the source Configuration for this Configuration.
@NotNull MemoryConfigurationOptions	getOptions() Gets the ConfigurationOptions for this Configuration.
@Nullable ConfigurationSection	getParent() Gets the parent ConfigurationSection that directly contains this ConfigurationSection.
@NotNull MemoryConfigurationOptions	options() Deprecated.
void	setDefaults(@NotNull Configuration defs) Sets the source of all default values for this Configuration.

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

contains, contains, createPath, createPath, createSection, createSection, get, get, getBoolean, getBoolean, getBooleanList, getByte, getByte, getByteList, getChar, getChar, getCharList, getComments, getConfigurationSection, getCurrentPath, getDefault, getDefaultSection, getDouble, getDouble, getDoubleList, getFloat, getFloat, getFloatList, getInLineComments, getInt, getInt, getIntList, getKeys, getList, getList, getLong, getLong, getLongList, getMapList, getName, getObject, getObject, getRoot, getSerializable, getSerializable, getShort, getShort, getShortList, getString, getString, getStringList, getValues, isBoolean, isByte, isChar, isConfigurationSection, isDouble, isFloat, isInt, isList, isLong, isSet, isShort, isString, mapChildrenKeys, mapChildrenValues, set, setComments, setInLineComments, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection

contains, contains, createSection, createSection, get, get, getBoolean, getBoolean, getBooleanList, getByte, getByte, getByteList, getChar, getChar, getCharList, getComments, getConfigurationSection, getCurrentPath, getDefaultSection, getDouble, getDouble, getDoubleList, getFloat, getFloat, getFloatList, getInLineComments, getInt, getInt, getIntList, getKeys, getList, getList, getLong, getLong, getLongList, getMapList, getName, getObject, getObject, getRoot, getSerializable, getSerializable, getShort, getShort, getShortList, getString, getString, getStringList, getValues, isBoolean, isByte, isChar, isConfigurationSection, isDouble, isFloat, isInt, isList, isLong, isSet, isShort, isString, set, setComments, setInLineComments

Field Detail

defs

protected Configuration defs

options

protected MemoryConfigurationOptions options

Constructor Detail

MemoryConfiguration

public MemoryConfiguration()

Creates an empty MemoryConfiguration with no default values.

MemoryConfiguration

public MemoryConfiguration(@Nullable
                           @Nullable Configuration defs)

Creates an empty MemoryConfiguration using the specified Configuration as a source for all default values.

Parameters:

defs - The default value provider.

Method Detail

addDefault

public void addDefault(@NotNull
                       @NotNull String path,
                       @Nullable
                       @Nullable Object value)

Sets the default value in the root at the given path as provided.

If no source Configuration was provided as a default collection, then a new MemoryConfiguration will be created to hold the new default value.

If value is null, the value will be removed from the default Configuration source.

If the value as returned by ConfigurationSection.getDefaultSection() is null, then this will create a new ConfigurationSection at the path, replacing anything that may have existed there previously.

Specified by:

addDefault in interface Configuration

Specified by:

addDefault in interface ConfigurationSection

Overrides:

addDefault in class MemorySection

Parameters:

path - The path of the value to set.

value - The value to set the default to.

addDefaults

public void addDefaults(@NotNull
                        @NotNull Map<String,Object> defs)

Sets the default values of the given paths as provided.

If no source Configuration was provided as a default collection, then a new MemoryConfiguration will be created to hold the new default values.

Specified by:

addDefaults in interface Configuration

Parameters:

defs - A Map of Path->Values to add to the defaults.

addDefaults

public void addDefaults(@NotNull
                        @NotNull Configuration defs)

Sets the default values of the given paths as provided.

If no source Configuration was provided as a default collection, then a new MemoryConfiguration will be created to hold the new default value.

This method will not hold a reference to the specified Configuration, nor will it automatically update if that Configuration ever changes. If you require this, you should set the default source with Configuration.setDefaults(Configuration).

Specified by:

addDefaults in interface Configuration

Parameters:

defs - A Configuration holding a list of defaults to copy.

setDefaults

public void setDefaults(@NotNull
                        @NotNull Configuration defs)

Sets the source of all default values for this Configuration.

If a previous source was set, or previous default values were defined, then they will not be copied to the new source.

Specified by:

setDefaults in interface Configuration

Parameters:

defs - New source of default values for this Configuration.

getDefaults

@Nullable
public @Nullable Configuration getDefaults()

Gets the source Configuration for this Configuration.

If no configuration source was set, but default values were added, then a MemoryConfiguration will be returned. If no source was set and no defaults were set, then this method will return null.

Specified by:

getDefaults in interface Configuration

Returns:

The Configuration source for default values, or null if none exist.

getParent

@Nullable
public @Nullable ConfigurationSection getParent()

Gets the parent ConfigurationSection that directly contains this ConfigurationSection.

For any Configuration themselves, this will return null.

If this ConfigurationSection is no longer contained within its parent for any reason, such as being replaced with a different value, this may return null.

Specified by:

getParent in interface ConfigurationSection

Overrides:

getParent in class MemorySection

Returns:

The parent ConfigurationSection containing this ConfigurationSection.

getOptions

@NotNull
public @NotNull MemoryConfigurationOptions getOptions()

Gets the ConfigurationOptions for this Configuration.

All setters through this method are chainable.

Specified by:

getOptions in interface Configuration

Returns:

The ConfigurationOptions for this Configuration.

options

@Deprecated
 @NotNull
public @NotNull MemoryConfigurationOptions options()

Deprecated.

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

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

Specified by:

options in interface Configuration

Returns:

The ConfigurationOptions for this Configuration.

See Also:

Configuration.getOptions()