StampedConfig (core 3.8.2 API)

java.lang.Object
- com.electronwill.nightconfig.core.concurrent.StampedConfig

All Implemented Interfaces:

CommentedConfig, ConcurrentCommentedConfig, ConcurrentConfig, Config, UnmodifiableCommentedConfig, UnmodifiableConfig
```
public final class StampedConfig
extends java.lang.Object
implements ConcurrentCommentedConfig
```
A thread-safe configuration based on a StampedLock.
Unlike SynchronizedConfig, StampedConfig allows multiple concurrent reads. It should also perform better under contention.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`StampedConfig.Accumulator` A CommentedConfig that allows to quickly accumulate values before a `replaceContentBy(Accumulator)`.

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
`StampedConfig()`
`StampedConfig(ConfigFormat<?> configFormat, java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> mapSupplier)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(java.util.List<java.lang.String> path, java.lang.Object value)` Adds 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.
`<R> R`	`bulkRead(java.util.function.Function<? super UnmodifiableConfig,R> action)` Performs multiple reads as a single atomic operation and returns a value.
`<R> R`	`bulkUpdate(java.util.function.Function<? super Config,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.
`StampedConfig`	`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 view of the entries contained in the configuration.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getComment(java.util.List<java.lang.String> path)` Gets a comment from the config.
`<T> T`	`getRaw(java.util.List<java.lang.String> path)` Gets a value from the config.
`StampedConfig.Accumulator`	`newAccumulator()` Creates a new accumulator with the same `Supplier<Map>` and `ConfigFormat` as this config.
`StampedConfig.Accumulator`	`newAccumulatorCopy()` Creates a deep copy of this config into an `StampedConfig.Accumulator`.
`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 other)` 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.
`void`	`removeAll(UnmodifiableConfig other)` 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(StampedConfig.Accumulator newContent)` Atomically replaces the content of this config by the content of the specified accumulator.
`void`	`replaceContentBy(StampedConfig 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.
`java.lang.String`	`setComment(java.util.List<java.lang.String> path, java.lang.String value)` Sets a config comment.
`int`	`size()` Gets the size of the config.
`java.lang.String`	`toString()`
`java.util.Map<java.lang.String,java.lang.Object>`	`valueMap()` Returns a Map view of the config's values.

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.electronwill.nightconfig.core.concurrent.ConcurrentCommentedConfig
bulkCommentedRead, bulkCommentedUpdate

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, unmodifiable, wrap

Methods inherited from interface com.electronwill.nightconfig.core.UnmodifiableCommentedConfig
containsComment, fake, getComment, getComments, getComments, getOptionalComment, getOptionalComment

Methods inherited from interface com.electronwill.nightconfig.core.concurrent.ConcurrentConfig
bulkRead, bulkUpdate

Methods inherited from interface com.electronwill.nightconfig.core.Config
add, addAll, getDefaultMapCreator, getDefaultMapCreator, inMemoryUniversal, inMemoryUniversalConcurrent, isInsertionOrderPreserved, of, of, ofConcurrent, remove, set, setInsertionOrderPreserved, update, update

Methods inherited from interface com.electronwill.nightconfig.core.UnmodifiableConfig
apply, apply, contains, get, 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, isEmpty, isNull, isNull

- Constructor Detail
  - StampedConfig
```
public StampedConfig()
```
  - StampedConfig
```
public StampedConfig(ConfigFormat<?> configFormat,
                     java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> mapSupplier)
```
- Method Detail
  - replaceContentBy
```
public void replaceContentBy(StampedConfig newContent)
```
    Atomically replaces the content of this config by the content of the specified config. The specified config cannot be used anymore after this operation.
    
    Parameters:
    
    newContent - the new content (cannot be used anymore after this)
  - replaceContentBy
```
public void replaceContentBy(StampedConfig.Accumulator newContent)
```
    Atomically replaces the content of this config by the content of the specified accumulator. The accumulator cannot be used anymore after this operation.
    
    Parameters:
    
    newContent - the new content (cannot be used anymore after this)
  - newAccumulator
```
public StampedConfig.Accumulator newAccumulator()
```
    Creates a new accumulator with the same Supplier<Map> and ConfigFormat as this config. See StampedConfig.Accumulator for more information.
  - newAccumulatorCopy
```
public StampedConfig.Accumulator newAccumulatorCopy()
```
    Creates a deep copy of this config into an StampedConfig.Accumulator.
    
    Returns:
    
    a deep copy
  - 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.
  - createSubConfig
```
public StampedConfig 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
  - 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
  - valueMap
```
public java.util.Map<java.lang.String,java.lang.Object> valueMap()
```
    Description copied from interface: UnmodifiableConfig
    
    Returns a Map view of the config's values. If the config is unmodifiable then the returned map is unmodifiable too.
    
    Specified by:
    
    valueMap in interface Config
    
    Specified by:
    
    valueMap in interface UnmodifiableConfig
    
    Returns:
    
    a Map view of the config's values.
  - clear
```
public void clear()
```
    Description copied from interface: Config
    
    Removes all values from the config.
    
    Specified by:
    
    clear in interface Config
  - 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.
  - 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.
  - 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
  - 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
  - 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
  - removeAll
```
public void removeAll(UnmodifiableConfig other)
```
    Description copied from interface: Config
    
    Removes all the values of the given config from this config.
    
    Specified by:
    
    removeAll in interface Config
    
    Parameters:
    
    other - the values to remove
  - clearComments
```
public void clearComments()
```
    Description copied from interface: CommentedConfig
    
    Removes all the comments from the config.
    
    Specified by:
    
    clearComments in interface CommentedConfig
  - 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 value)
```
    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.
    
    value - 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.
  - 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.
  - putAllComments
```
public void putAllComments(UnmodifiableCommentedConfig other)
```
    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:
    
    other - the config to copy its 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
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - entrySet
```
public java.util.Set<? extends CommentedConfig.Entry> entrySet()
```
    Returns a view of the entries contained in the configuration.
    The returned Set provides iterators that do not reflect entries that are removed or added during iteration. Each iterator obtained from the Set provides a list of entries that existed at the time of its creation, and allow to read their latest value.
    
    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.
  - bulkRead
```
public <R> R bulkRead(java.util.function.Function<? super UnmodifiableConfig,R> action)
```
    Description copied from interface: ConcurrentConfig
    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:
```
 
 String combined = config.bulkUpdate(conf -> {
     String a = conf.get("a");
     String b = conf.get("b");
     return a + b;
     // note that we use `conf` and not `config`!
 });
 
 
```
    Specified by:
    
    bulkRead in interface ConcurrentCommentedConfig
    
    Specified by:
    
    bulkRead in interface ConcurrentConfig
    
    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
  - bulkUpdate
```
public <R> R bulkUpdate(java.util.function.Function<? super Config,R> action)
```
    Description copied from interface: ConcurrentConfig
    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:
```
 
 String combined = config.bulkUpdate(conf -> {
     String a = conf.get("a");
     String b = conf.get("b");
     String combined = a + b;
     conf.set("combined", combined);
     return combined;
     // note that we use `conf` and not `config`!
 });
 
 
```
    If you only have to read the configuration, prefer to use ConcurrentConfig.bulkRead(Function), since it may provide a better performance.
    Specified by:
    
    bulkUpdate in interface ConcurrentCommentedConfig
    
    Specified by:
    
    bulkUpdate in interface ConcurrentConfig
    
    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
  - 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

Class StampedConfig

Nested Class Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

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

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

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

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

Constructor Detail

StampedConfig

StampedConfig

Method Detail

replaceContentBy

replaceContentBy

newAccumulator

newAccumulatorCopy

size

createSubConfig

configFormat

valueMap

clear

getRaw

contains

add

remove

set

putAll

removeAll

clearComments

removeComment

setComment

containsComment

getComment

commentMap

putAllComments

putAllComments

equals

toString

entrySet

bulkRead

bulkUpdate

bulkCommentedRead

bulkCommentedUpdate