com.electronwill.nightconfig.core.concurrent

Class SynchronizedConfig

java.lang.Object

com.electronwill.nightconfig.core.concurrent.SynchronizedConfig

All Implemented Interfaces:

CommentedConfig, ConcurrentCommentedConfig, ConcurrentConfig, Config, UnmodifiableCommentedConfig, UnmodifiableConfig

public final class SynchronizedConfig
extends java.lang.Object
implements ConcurrentCommentedConfig

A configuration that is synchronized, and therefore thread-safe (reads and writes can happen in any order from any thread).

Only one read or write can happen at the same time. This includes every read and write on sub-configurations, iterator operations, etc.

Nested Class Summary

Nested classes/interfaces inherited from interface com.electronwill.nightconfig.core.CommentedConfig

CommentedConfig.Entry

Nested classes/interfaces inherited from interface com.electronwill.nightconfig.core.UnmodifiableCommentedConfig

UnmodifiableCommentedConfig.CommentNode

Constructor Summary

Constructors

Constructor and Description
SynchronizedConfig()
SynchronizedConfig(ConfigFormat<?> configFormat, java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> mapSupplier)
SynchronizedConfig(ConfigFormat<?> configFormat, java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> mapSupplier, SynchronizedConfig parent)

Method Summary

Modifier and Type	Method and Description
boolean	add(java.util.List<java.lang.String> path, java.lang.Object value) Adds a config value.
boolean	add(java.lang.String path, java.lang.Object value) Adds a config value.
void	addAll(UnmodifiableConfig other) Adds all the values of a config to this config, without replacing existing entries.
<T> T	apply(java.util.List<java.lang.String> path) For scala: gets a config value.
<R> R	bulkCommentedRead(java.util.function.Function<? super UnmodifiableCommentedConfig,R> action) Performs multiple reads as a single atomic operation, and returns a value.
<R> R	bulkCommentedUpdate(java.util.function.Function<? super CommentedConfig,R> action) Performs multiple reads and writes as a single atomic operation and returns a value.
void	clear() Removes all values from the config.
void	clearComments() Removes all the comments from the config.
java.util.Map<java.lang.String,java.lang.String>	commentMap() Returns a Map view of the config's comments.
ConfigFormat<?>	configFormat() Returns the config's format.
boolean	contains(java.util.List<java.lang.String> path) Checks if the config contains a value at some path.
boolean	containsComment(java.util.List<java.lang.String> path) Checks if the config contains a comment at some path.
static SynchronizedConfig	convert(Config c)
SynchronizedConfig	createSubConfig() Creates a new sub config of this config, as created when a subconfig's creation is implied by Config.set(List, Object) or Config.add(List, Object).
java.util.Set<? extends CommentedConfig.Entry>	entrySet() Returns a Set view of the config's entries.
boolean	equals(java.lang.Object obj)
<T> T	get(java.util.List<java.lang.String> path) Gets a value from the config.
java.lang.String	getComment(java.util.List<java.lang.String> path) Gets a comment from the config.
java.util.Map<java.lang.String,UnmodifiableCommentedConfig.CommentNode>	getComments() Returns a Map containing a deep copy of all the comments in the config.
void	getComments(java.util.Map<java.lang.String,UnmodifiableCommentedConfig.CommentNode> destination) Puts all the config's comments to the specified map.
<T> T	getRaw(java.util.List<java.lang.String> path) Gets a value from the config.
int	hashCode()
boolean	isEmpty() Checks if the config is empty.
boolean	isNull(java.util.List<java.lang.String> path) Checks if the config contains a null value at some path.
void	putAll(UnmodifiableConfig other) Copies all the values of a config into this config.
void	putAllComments(java.util.Map<java.lang.String,UnmodifiableCommentedConfig.CommentNode> comments) Puts the comments in the given map to this config.
void	putAllComments(UnmodifiableCommentedConfig commentedConfig) Puts the comments in the given config to this config.
<T> T	remove(java.util.List<java.lang.String> path) Removes a value from the config.
<T> T	remove(java.lang.String path) Removes a value from the config.
void	removeAll(UnmodifiableConfig toRemove) Removes all the values of the given config from this config.
java.lang.String	removeComment(java.util.List<java.lang.String> path) Removes a comment from the config.
void	replaceContentBy(Config newContent) Atomically replaces the content of this config by the content of the specified config.
void	replaceContentBy(SynchronizedConfig newContent) Atomically replaces the content of this config by the content of the specified config.
<T> T	set(java.util.List<java.lang.String> path, java.lang.Object value) Sets a config value.
<T> T	set(java.lang.String path, java.lang.Object value) Sets a config value.
java.lang.String	setComment(java.util.List<java.lang.String> path, java.lang.String comment) Sets a config comment.
int	size() Gets the size of the config.
java.lang.String	toString()
UnmodifiableCommentedConfig	unmodifiable() Returns an Unmodifiable view of the config.
void	update(java.util.List<java.lang.String> path, java.lang.Object value) For scala: sets a config value.
java.util.Map<java.lang.String,java.lang.Object>	valueMap() Deprecated. This method is deprecated on SynchronizedConfig. Because a conversion is applied to the value that is added to the map with put, modifying the value after the put will, most of the time, not be reflected to the config, i.e. once something is added to the valueMap(), you loose control over it.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.electronwill.nightconfig.core.concurrent.ConcurrentCommentedConfig

bulkCommentedRead, bulkCommentedUpdate, bulkRead, bulkUpdate

Methods inherited from interface com.electronwill.nightconfig.core.CommentedConfig

checked, concurrentCopy, concurrentCopy, concurrentCopy, concurrentCopy, copy, copy, copy, copy, copy, copy, copy, copy, fake, inMemory, inMemoryConcurrent, of, of, ofConcurrent, removeComment, setComment, wrap

Methods inherited from interface com.electronwill.nightconfig.core.UnmodifiableCommentedConfig

containsComment, fake, getComment, getOptionalComment, getOptionalComment

Methods inherited from interface com.electronwill.nightconfig.core.concurrent.ConcurrentConfig

bulkRead, bulkUpdate

Methods inherited from interface com.electronwill.nightconfig.core.Config

getDefaultMapCreator, getDefaultMapCreator, inMemoryUniversal, inMemoryUniversalConcurrent, isInsertionOrderPreserved, of, of, ofConcurrent, setInsertionOrderPreserved, update

Methods inherited from interface com.electronwill.nightconfig.core.UnmodifiableConfig

apply, contains, get, getByte, getByte, getByteOrElse, getByteOrElse, getChar, getChar, getCharOrElse, getCharOrElse, getEnum, getEnum, getEnum, getEnum, getEnumOrElse, getEnumOrElse, getEnumOrElse, getEnumOrElse, getEnumOrElse, getEnumOrElse, getEnumOrElse, getEnumOrElse, getInt, getInt, getIntOrElse, getIntOrElse, getIntOrElse, getIntOrElse, getLong, getLong, getLongOrElse, getLongOrElse, getLongOrElse, getLongOrElse, getOptional, getOptional, getOptionalEnum, getOptionalEnum, getOptionalEnum, getOptionalEnum, getOptionalInt, getOptionalInt, getOptionalLong, getOptionalLong, getOrElse, getOrElse, getOrElse, getOrElse, getRaw, getShort, getShort, getShortOrElse, getShortOrElse, isNull

Constructor Detail

SynchronizedConfig

public SynchronizedConfig()

SynchronizedConfig

public SynchronizedConfig(ConfigFormat<?> configFormat,
                          java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> mapSupplier)

SynchronizedConfig

public SynchronizedConfig(ConfigFormat<?> configFormat,
                          java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> mapSupplier,
                          SynchronizedConfig parent)

Method Detail

convert

public static SynchronizedConfig convert(Config c)

replaceContentBy

public void replaceContentBy(SynchronizedConfig newContent)

Atomically replaces the content of this config by the content of the specified config. The specified config cannot be used anymore after a call to this method.

Parameters:

newContent - the new content (cannot be used anymore after this)

replaceContentBy

public void replaceContentBy(Config newContent)

Atomically replaces the content of this config by the content of the specified config. The specified config cannot be used anymore after a call to this method.

Parameters:

newContent - the new content (cannot be used anymore after this)

bulkCommentedRead

public <R> R bulkCommentedRead(java.util.function.Function<? super UnmodifiableCommentedConfig,R> action)

Description copied from interface: ConcurrentCommentedConfig

Performs multiple reads as a single atomic operation, and returns a value.

It is guaranteed that the content of the config, accessed through the provided "view", will not change during the entire operation. The configuration must be used exclusively through the object passed to the consumer (the "view"), not with the original reference. After the bulk operation, the view cannot be used anymore.

Here is an example:

 
 config.bulkCommentedRead(conf -> {
     Object value = conf.get("a.b.c");
     String comment = conf.getComment("a.b.c");
     // note that we use `conf` and not `config`!
 });
 
 

If you don't need access to the comments, prefer to use ConcurrentCommentedConfig.bulkRead(Function), sine it may provide a better performance.

Specified by:

bulkCommentedRead in interface ConcurrentCommentedConfig

Type Parameters:

R - the type of the function's result

Parameters:

action - a function to execute on the configuration view

Returns:

the result of the function

bulkCommentedUpdate

public <R> R bulkCommentedUpdate(java.util.function.Function<? super CommentedConfig,R> action)

Description copied from interface: ConcurrentCommentedConfig

Performs multiple reads and writes as a single atomic operation and returns a value.

It is guaranteed that the content of the config, accessed through the provided "view", will not be concurrently modified by other threads during the entire bulk operation. The configuration must be used exclusively through the object passed to the consumer (the "view"), not with the original reference. After the bulk operation, the view cannot be used anymore.

Here is an example:

 
 Object value = config.bulkCommentedUpdate(conf -> {
     Object value = conf.get("a.b.c");
     String comment = conf.getComment("a.b.c");
     conf.setComment("a.b.c", comment + "\nAdditional comment here.");
     // note that we use `conf` and not `config`!
     return value;
 });
 
 

If you don't need access to the comments, prefer to use ConcurrentCommentedConfig.bulkUpdate(Function), since it may provide a better performance. Also, if you only have to read the configuration, prefer to use ConcurrentCommentedConfig.bulkCommentedRead(Function).

Specified by:

bulkCommentedUpdate in interface ConcurrentCommentedConfig

Type Parameters:

R - the type of the function's result

Parameters:

action - a function to execute on the configuration view

Returns:

the result of the function

add

public boolean add(java.util.List<java.lang.String> path,
                   java.lang.Object value)

Description copied from interface: Config

Adds a config value. The value is set iff there is no value associated with the given path.

Specified by:

add in interface Config

Parameters:

path - the value's path, each element of the list is a different part of the path.

value - the value to set

Returns:

true if the value has been added, false if a value is already associated with the given path

clearComments

public void clearComments()

Description copied from interface: CommentedConfig

Removes all the comments from the config.

Specified by:

clearComments in interface CommentedConfig

commentMap

public java.util.Map<java.lang.String,java.lang.String> commentMap()

Description copied from interface: CommentedConfig

Returns a Map view of the config's comments. Any change to the map is reflected in the config and vice-versa.

The comment map contains only the comments of the direct elements of the configuration, not the comments of their sub-elements.

Specified by:

commentMap in interface CommentedConfig

Specified by:

commentMap in interface UnmodifiableCommentedConfig

Returns:

a Map view of the config's comments.

removeComment

public java.lang.String removeComment(java.util.List<java.lang.String> path)

Description copied from interface: CommentedConfig

Removes a comment from the config.

Specified by:

removeComment in interface CommentedConfig

Parameters:

path - the comment's path, each element of the list is a different part of the path.

Returns:

the old comment if any, or null

setComment

public java.lang.String setComment(java.util.List<java.lang.String> path,
                                   java.lang.String comment)

Description copied from interface: CommentedConfig

Sets a config comment.

Specified by:

setComment in interface CommentedConfig

Parameters:

path - the comment's path, each element of the list is a different part of the path.

comment - the comment to set

Returns:

the old comment if any, or null

containsComment

public boolean containsComment(java.util.List<java.lang.String> path)

Description copied from interface: UnmodifiableCommentedConfig

Checks if the config contains a comment at some path.

Specified by:

containsComment in interface UnmodifiableCommentedConfig

Parameters:

path - the path to check, each element of the list is a different part of the path.

Returns:

true if the path is associated with a comment, false if it's not.

getComment

public java.lang.String getComment(java.util.List<java.lang.String> path)

Description copied from interface: UnmodifiableCommentedConfig

Gets a comment from the config.

Specified by:

getComment in interface UnmodifiableCommentedConfig

Parameters:

path - the comment's path, each element of the list is a different part of the path.

Returns:

the comment at the given path, or null if there is none.

configFormat

public ConfigFormat<?> configFormat()

Description copied from interface: UnmodifiableConfig

Returns the config's format.

Specified by:

configFormat in interface UnmodifiableConfig

Returns:

the config's format

clear

public void clear()

Description copied from interface: Config

Removes all values from the config.

Specified by:

clear in interface Config

createSubConfig

public SynchronizedConfig createSubConfig()

Description copied from interface: Config

Creates a new sub config of this config, as created when a subconfig's creation is implied by Config.set(List, Object) or Config.add(List, Object).

Specified by:

createSubConfig in interface CommentedConfig

Specified by:

createSubConfig in interface ConcurrentCommentedConfig

Specified by:

createSubConfig in interface ConcurrentConfig

Specified by:

createSubConfig in interface Config

Returns:

a new sub config

entrySet

public java.util.Set<? extends CommentedConfig.Entry> entrySet()

Description copied from interface: UnmodifiableConfig

Returns a Set view of the config's entries. If the config is unmodifiable then the returned set is unmodifiable too.

Specified by:

entrySet in interface CommentedConfig

Specified by:

entrySet in interface Config

Specified by:

entrySet in interface UnmodifiableCommentedConfig

Specified by:

entrySet in interface UnmodifiableConfig

Returns:

a Set view of the config's entries.

remove

public <T> T remove(java.util.List<java.lang.String> path)

Description copied from interface: Config

Removes a value from the config.

Specified by:

remove in interface Config

Type Parameters:

T - the type of the old value

Parameters:

path - the value's path, each element of the list is a different part of the path.

Returns:

the old value if any, or null

set

public <T> T set(java.util.List<java.lang.String> path,
                 java.lang.Object value)

Description copied from interface: Config

Sets a config value.

Specified by:

set in interface Config

Type Parameters:

T - the type of the old value

Parameters:

path - the value's path, each element of the list is a different part of the path.

value - the value to set

Returns:

the old value if any, or null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

contains

public boolean contains(java.util.List<java.lang.String> path)

Description copied from interface: UnmodifiableConfig

Checks if the config contains a value at some path.

Specified by:

contains in interface UnmodifiableConfig

Parameters:

path - the path to check, each element of the list is a different part of the path.

Returns:

true if the path is associated with a value, false if it's not.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getRaw

public <T> T getRaw(java.util.List<java.lang.String> path)

Description copied from interface: UnmodifiableConfig

Gets a value from the config. Doesn't convert NullObject.NULL_OBJECT to null.

Specified by:

getRaw in interface UnmodifiableConfig

Type Parameters:

T - the value's type

Parameters:

path - the value's path, each element of the list is a different part of the path.

Returns:

the value at the given path, or null if there is no such value.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isEmpty

public boolean isEmpty()

Description copied from interface: UnmodifiableConfig

Checks if the config is empty.

Specified by:

isEmpty in interface UnmodifiableConfig

Returns:

true if the config is empty, false if it contains at least one element.

size

public int size()

Description copied from interface: UnmodifiableConfig

Gets the size of the config.

Specified by:

size in interface UnmodifiableConfig

Returns:

the number of top-level elements in the config.

valueMap

@Deprecated
public java.util.Map<java.lang.String,java.lang.Object> valueMap()

Deprecated. This method is deprecated on SynchronizedConfig. Because a conversion is applied to the value that is added to the map with put, modifying the value after the put will, most of the time, not be reflected to the config, i.e. once something is added to the valueMap(), you loose control over it.

Returns a Map view of the config's values.

Specified by:

valueMap in interface Config

Specified by:

valueMap in interface UnmodifiableConfig

Returns:

a Map view of the config's values.

add

public boolean add(java.lang.String path,
                   java.lang.Object value)

Description copied from interface: Config

Adds a config value. The value is set iff there is no value associated with the given path.

Specified by:

add in interface Config

Parameters:

path - the value's path, each part separated by a dot. Example "a.b.c"

value - the value to set

Returns:

true if the value has been added, false if a value is already associated with the given path

addAll

public void addAll(UnmodifiableConfig other)

Description copied from interface: Config

Adds all the values of a config to this config, without replacing existing entries.

Specified by:

addAll in interface Config

Parameters:

other - the source config

putAll

public void putAll(UnmodifiableConfig other)

Description copied from interface: Config

Copies all the values of a config into this config. Existing entries are replaced, missing entries are created.

Specified by:

putAll in interface Config

Parameters:

other - the source config

remove

public <T> T remove(java.lang.String path)

Description copied from interface: Config

Removes a value from the config.

Specified by:

remove in interface Config

Type Parameters:

T - the type of the old value

Parameters:

path - the value's path, each part separated by a dot. Example "a.b.c"

Returns:

the old value if any, or null

removeAll

public void removeAll(UnmodifiableConfig toRemove)

Description copied from interface: Config

Removes all the values of the given config from this config.

Specified by:

removeAll in interface Config

Parameters:

toRemove - the values to remove

set

public <T> T set(java.lang.String path,
                 java.lang.Object value)

Description copied from interface: Config

Sets a config value.

Specified by:

set in interface Config

Type Parameters:

T - the type of the old value

Parameters:

path - the value's path, each part separated by a dot. Example "a.b.c"

value - the value to set

Returns:

the old value if any, or null

unmodifiable

public UnmodifiableCommentedConfig unmodifiable()

Description copied from interface: Config

Returns an Unmodifiable view of the config. Any change to the original (modifiable) config is still reflected to the returned UnmodifiableConfig, so it's unmodifiable but not immutable.

Specified by:

unmodifiable in interface CommentedConfig

Specified by:

unmodifiable in interface Config

Returns:

an Unmodifiable view of the config.

update

public void update(java.util.List<java.lang.String> path,
                   java.lang.Object value)

Description copied from interface: Config

For scala: sets a config value.

Specified by:

update in interface Config

Parameters:

path - the value's path, each element of the list is a different part of the path.

value - the value to set

See Also:

Config.set(List, Object)

apply

public <T> T apply(java.util.List<java.lang.String> path)

Description copied from interface: UnmodifiableConfig

For scala: gets a config value.

Specified by:

apply in interface UnmodifiableConfig

Type Parameters:

T - the value's type

Parameters:

path - the value's path, each element of the list is a different part of the path.

See Also:

UnmodifiableConfig.get(List)

get

public <T> T get(java.util.List<java.lang.String> path)

Description copied from interface: UnmodifiableConfig

Gets a value from the config.

Specified by:

get in interface UnmodifiableConfig

Type Parameters:

T - the value's type

Parameters:

path - the value's path, each element of the list is a different part of the path.

Returns:

the value at the given path, or null if there is no such value.

isNull

public boolean isNull(java.util.List<java.lang.String> path)

Description copied from interface: UnmodifiableConfig

Checks if the config contains a null value at some path.

Specified by:

isNull in interface UnmodifiableConfig

Parameters:

path - the path to check, each element of the list is a different part of the path.

Returns:

true if the path is associated with NullObject.NULL_OBJECT, false if it's associated with another value or with no value.

getComments

public java.util.Map<java.lang.String,UnmodifiableCommentedConfig.CommentNode> getComments()

Description copied from interface: UnmodifiableCommentedConfig

Returns a Map containing a deep copy of all the comments in the config.

Specified by:

getComments in interface UnmodifiableCommentedConfig

Returns:

a Map containing the comments in the config.

getComments

public void getComments(java.util.Map<java.lang.String,UnmodifiableCommentedConfig.CommentNode> destination)

Description copied from interface: UnmodifiableCommentedConfig

Puts all the config's comments to the specified map.

Specified by:

getComments in interface UnmodifiableCommentedConfig

Parameters:

destination - the map where to put the comments.

putAllComments

public void putAllComments(java.util.Map<java.lang.String,UnmodifiableCommentedConfig.CommentNode> comments)

Description copied from interface: CommentedConfig

Puts the comments in the given map to this config. Existing comments are replaced, missing comments are created.

Specified by:

putAllComments in interface CommentedConfig

Parameters:

comments - the comments to set

putAllComments

public void putAllComments(UnmodifiableCommentedConfig commentedConfig)

Description copied from interface: CommentedConfig

Puts the comments in the given config to this config. Existing comments are replaced, missing comments are created.

The comments are copied recursively, but missing sub-configurations are NOT created.

Specified by:

putAllComments in interface CommentedConfig

Parameters:

commentedConfig - the config to copy its comments