com.electronwill.nightconfig.core.file

Interface CommentedFileConfig

All Superinterfaces:

java.lang.AutoCloseable, CommentedConfig, Config, FileConfig, UnmodifiableCommentedConfig, UnmodifiableConfig

All Known Implementing Classes:

ConvertedCommentedFileConfig

public interface CommentedFileConfig
extends CommentedConfig, FileConfig

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

Method Summary

Modifier and Type	Method and Description
static CommentedFileConfigBuilder	builder(java.io.File file) Returns a CommentedFileConfigBuilder to create a CommentedFileConfig with many options.
static CommentedFileConfigBuilder	builder(java.io.File file, ConfigFormat<? extends CommentedConfig> format) Returns a CommentedFileConfigBuilder to create a CommentedFileConfig with many options.
static CommentedFileConfigBuilder	builder(java.nio.file.Path file) Returns a CommentedFileConfigBuilder to create a CommentedFileConfig with many options.
static CommentedFileConfigBuilder	builder(java.nio.file.Path file, ConfigFormat<? extends CommentedConfig> format) Returns a CommentedFileConfigBuilder to create a CommentedFileConfig with many options.
static CommentedFileConfigBuilder	builder(java.lang.String filePath) Returns a CommentedFileConfigBuilder to create a CommentedFileConfig with many options.
static CommentedFileConfigBuilder	builder(java.lang.String filePath, ConfigFormat<? extends CommentedConfig> format) Returns a CommentedFileConfigBuilder to create a CommentedFileConfig with many options.
default void	bulkCommentedUpdate(java.util.function.Consumer<? super CommentedConfig> action) Performs multiple read/write operations, and do not save the configuration until the end (unless save() is called by action).
<R> R	bulkCommentedUpdate(java.util.function.Function<? super CommentedConfig,R> action) Performs multiple read/write operations, and do not save the configuration until the end (unless save() is called by action).
default <R> R	bulkUpdate(java.util.function.Function<? super Config,R> action) Performs multiple read/write operations, and do not save the configuration until the end (unless save() is called by action).
default CommentedFileConfig	checked() Returns a checked view of the config.
static CommentedFileConfig	of(java.io.File file) Creates a new FileConfig based on the specified file and format.
static CommentedFileConfig	of(java.io.File file, ConfigFormat<? extends CommentedConfig> format) Creates a new FileConfig based on the specified file and format.
static CommentedFileConfig	of(java.nio.file.Path file) Creates a new FileConfig based on the specified file and format.
static CommentedFileConfig	of(java.nio.file.Path file, ConfigFormat<? extends CommentedConfig> format) Creates a new FileConfig based on the specified file and format.
static CommentedFileConfig	of(java.lang.String filePath) Creates a new FileConfig based on the specified file and format.
static CommentedFileConfig	of(java.lang.String filePath, ConfigFormat<? extends CommentedConfig> format) Creates a new FileConfig based on the specified file and format.
static CommentedFileConfig	ofConcurrent(java.io.File file) Deprecated. All FileConfig are now thread-safe by default, backed by a ConcurrentConfig
static CommentedFileConfig	ofConcurrent(java.io.File file, ConfigFormat<? extends CommentedConfig> format) Deprecated. All FileConfig are now thread-safe by default, backed by a ConcurrentConfig
static CommentedFileConfig	ofConcurrent(java.nio.file.Path file) Deprecated. All FileConfig are now thread-safe by default, backed by a ConcurrentConfig
static CommentedFileConfig	ofConcurrent(java.nio.file.Path file, ConfigFormat<? extends CommentedConfig> format) Deprecated. All FileConfig are now thread-safe by default, backed by a ConcurrentConfig
static CommentedFileConfig	ofConcurrent(java.lang.String filePath) Deprecated. All FileConfig are now thread-safe by default, backed by a ConcurrentConfig
static CommentedFileConfig	ofConcurrent(java.lang.String filePath, ConfigFormat<? extends CommentedConfig> format) Deprecated. All FileConfig are now thread-safe by default, backed by a ConcurrentConfig

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

clearComments, commentMap, concurrentCopy, concurrentCopy, concurrentCopy, concurrentCopy, copy, copy, copy, copy, copy, copy, copy, copy, createSubConfig, entrySet, fake, inMemory, inMemoryConcurrent, of, of, ofConcurrent, putAllComments, putAllComments, removeComment, removeComment, setComment, setComment, unmodifiable, wrap

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

containsComment, containsComment, fake, getComment, getComment, getComments, getComments, getOptionalComment, getOptionalComment

Methods inherited from interface com.electronwill.nightconfig.core.file.FileConfig

builder, builder, builder, bulkUpdate, close, getFile, getNioPath, load, of, of, of, ofConcurrent, ofConcurrent, ofConcurrent, save

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

add, add, addAll, clear, getDefaultMapCreator, getDefaultMapCreator, inMemoryUniversal, inMemoryUniversalConcurrent, isInsertionOrderPreserved, of, of, ofConcurrent, putAll, remove, remove, removeAll, set, set, setInsertionOrderPreserved, update, update, valueMap

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

apply, apply, configFormat, contains, 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, getRaw, getShort, getShort, getShortOrElse, getShortOrElse, isEmpty, isNull, isNull, size

Method Detail

checked

default CommentedFileConfig checked()

Description copied from interface: Config

Returns a checked view of the config. It checks that all the values put into the config are supported by the config's format (as per the ConfigFormat.supportsType(Class) method. Trying to insert an unsupported value throws an IllegalArgumentException.

The values that are in the config when this method is called are also checked.

Specified by:

checked in interface CommentedConfig

Specified by:

checked in interface Config

Specified by:

checked in interface FileConfig

Returns:

a checked view of the config.

bulkCommentedUpdate

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

Performs multiple read/write operations, and do not save the configuration until the end (unless save() is called by action). This is a way of manually grouping config modifications together.

If this configuration automatically saves, it will not do so before the end of the bulkUpdate.

bulkCommentedUpdate

default void bulkCommentedUpdate(java.util.function.Consumer<? super CommentedConfig> action)

Performs multiple read/write operations, and do not save the configuration until the end (unless save() is called by action). This is a way of manually grouping config modifications together.

If this configuration automatically saves, it will not do so before the end of the bulkUpdate.

bulkUpdate

default <R> R bulkUpdate(java.util.function.Function<? super Config,R> action)

Description copied from interface: FileConfig

Performs multiple read/write operations, and do not save the configuration until the end (unless save() is called by action). This is a way of manually grouping config modifications together.

If this configuration automatically saves, it will not do so before the end of the bulkUpdate.

Specified by:

bulkUpdate in interface FileConfig

of

static CommentedFileConfig of(java.io.File file)

Creates a new FileConfig based on the specified file and format. The format is detected automatically.

Specified by:

of in interface FileConfig

Parameters:

file - the file to use to save and load the config

Returns:

a new FileConfig associated to the specified file

Throws:

NoFormatFoundException - if the format detection fails

See Also:

builder(File)

of

static CommentedFileConfig of(java.io.File file,
                              ConfigFormat<? extends CommentedConfig> format)

Creates a new FileConfig based on the specified file and format.

Parameters:

file - the file to use to save and load the config

format - the config's format

Returns:

a new FileConfig associated to the specified file

See Also:

builder(File, ConfigFormat)

of

static CommentedFileConfig of(java.nio.file.Path file)

Creates a new FileConfig based on the specified file and format. The format is detected automatically.

Specified by:

of in interface FileConfig

Parameters:

file - the file to use to save and load the config

Returns:

a new FileConfig associated to the specified file

Throws:

NoFormatFoundException - if the format detection fails

See Also:

builder(Path)

of

static CommentedFileConfig of(java.nio.file.Path file,
                              ConfigFormat<? extends CommentedConfig> format)

Creates a new FileConfig based on the specified file and format.

Parameters:

file - the file to use to save and load the config

format - the config's format

Returns:

a new FileConfig associated to the specified file

See Also:

builder(Path, ConfigFormat)

of

static CommentedFileConfig of(java.lang.String filePath)

Creates a new FileConfig based on the specified file and format. The format is detected automatically.

Specified by:

of in interface FileConfig

Parameters:

filePath - the file's path

Returns:

a new FileConfig associated to the specified file

Throws:

NoFormatFoundException - if the format detection fails

See Also:

builder(String)

of

static CommentedFileConfig of(java.lang.String filePath,
                              ConfigFormat<? extends CommentedConfig> format)

Creates a new FileConfig based on the specified file and format.

Parameters:

filePath - the file's path

format - the config's format

Returns:

a new FileConfig associated to the specified file

See Also:

builder(String, ConfigFormat)

ofConcurrent

@Deprecated
static CommentedFileConfig ofConcurrent(java.io.File file)

Deprecated. All FileConfig are now thread-safe by default, backed by a ConcurrentConfig

Creates a new thread-safe CommentedFileConfig based on the specified file and format. The format is detected automatically.

Specified by:

ofConcurrent in interface FileConfig

Parameters:

file - the file to use to save and load the config

Returns:

a new thread-safe CommentedFileConfig associated to the specified file

Throws:

NoFormatFoundException - if the format detection fails

ofConcurrent

@Deprecated
static CommentedFileConfig ofConcurrent(java.io.File file,
                                                    ConfigFormat<? extends CommentedConfig> format)

Deprecated. All FileConfig are now thread-safe by default, backed by a ConcurrentConfig

Creates a new trhead-safe CommentedFileConfig based on the specified file and format.

Parameters:

file - the file to use to save and load the config

format - the config's format

Returns:

a new thread-safe CommentedFileConfig associated to the specified file

ofConcurrent

@Deprecated
static CommentedFileConfig ofConcurrent(java.nio.file.Path file)

Deprecated. All FileConfig are now thread-safe by default, backed by a ConcurrentConfig

Creates a new thread-safe CommentedFileConfig based on the specified file and format. The format is detected automatically.

Specified by:

ofConcurrent in interface FileConfig

Parameters:

file - the file to use to save and load the config

Returns:

a new thread-safe CommentedFileConfig associated to the specified file

Throws:

NoFormatFoundException - if the format detection fails

ofConcurrent

@Deprecated
static CommentedFileConfig ofConcurrent(java.nio.file.Path file,
                                                    ConfigFormat<? extends CommentedConfig> format)

Deprecated. All FileConfig are now thread-safe by default, backed by a ConcurrentConfig

Creates a new trhead-safe CommentedFileConfig based on the specified file and format.

Parameters:

file - the file to use to save and load the config

format - the config's format

Returns:

a new thread-safe CommentedFileConfig associated to the specified file

ofConcurrent

@Deprecated
static CommentedFileConfig ofConcurrent(java.lang.String filePath,
                                                    ConfigFormat<? extends CommentedConfig> format)

Deprecated. All FileConfig are now thread-safe by default, backed by a ConcurrentConfig

Creates a new trhead-safe CommentedFileConfig based on the specified file and format.

Parameters:

filePath - the file's path

format - the config's format

Returns:

a new thread-safe CommentedFileConfig associated to the specified file

ofConcurrent

@Deprecated
static CommentedFileConfig ofConcurrent(java.lang.String filePath)

Deprecated. All FileConfig are now thread-safe by default, backed by a ConcurrentConfig

Creates a new trhead-safe CommentedFileConfig based on the specified file and format. The format is detected automatically.

Specified by:

ofConcurrent in interface FileConfig

Parameters:

filePath - the file's path

Returns:

a new thread-safe CommentedFileConfig associated to the specified file

Throws:

NoFormatFoundException - if the format detection fails

builder

static CommentedFileConfigBuilder builder(java.io.File file,
                                          ConfigFormat<? extends CommentedConfig> format)

Returns a CommentedFileConfigBuilder to create a CommentedFileConfig with many options.

Parameters:

file - the file to use to save and load the config

format - the config's format

Returns:

a new FileConfigBuilder that will build a CommentedFileConfig associated to the specified file

builder

static CommentedFileConfigBuilder builder(java.io.File file)

Returns a CommentedFileConfigBuilder to create a CommentedFileConfig with many options. The format is detected automatically.

Specified by:

builder in interface FileConfig

Parameters:

file - the file to use to save and load the config

Returns:

a new FileConfigBuilder that will build a CommentedFileConfig associated to the specified file

Throws:

NoFormatFoundException - if the format detection fails

See Also:

FileConfigBuilder

builder

static CommentedFileConfigBuilder builder(java.nio.file.Path file,
                                          ConfigFormat<? extends CommentedConfig> format)

Returns a CommentedFileConfigBuilder to create a CommentedFileConfig with many options.

Parameters:

file - the file to use to save and load the config

format - the config's format

Returns:

a new FileConfigBuilder that will build a CommentedFileConfig associated to the specified file

builder

static CommentedFileConfigBuilder builder(java.nio.file.Path file)

Returns a CommentedFileConfigBuilder to create a CommentedFileConfig with many options. The format is detected automatically.

Specified by:

builder in interface FileConfig

Parameters:

file - the file to use to save and load the config

Returns:

a new FileConfigBuilder that will build a CommentedFileConfig associated to the specified file

Throws:

NoFormatFoundException - if the format detection fails

See Also:

FileConfigBuilder

builder

static CommentedFileConfigBuilder builder(java.lang.String filePath)

Returns a CommentedFileConfigBuilder to create a CommentedFileConfig with many options. The format is detected automatically.

Specified by:

builder in interface FileConfig

Parameters:

filePath - the file's path

Returns:

a new FileConfigBuilder that will build a CommentedFileConfig associated to the specified file

Throws:

NoFormatFoundException - if the format detection fails

See Also:

FileConfigBuilder

builder

static CommentedFileConfigBuilder builder(java.lang.String filePath,
                                          ConfigFormat<? extends CommentedConfig> format)

Returns a CommentedFileConfigBuilder to create a CommentedFileConfig with many options.

Parameters:

filePath - the file's path

format - the config's format

Returns:

a new FileConfigBuilder that will build a CommentedFileConfig associated to the specified file