com.electronwill.nightconfig.core.file

Class GenericBuilder<Base extends Config,Result extends FileConfig>

java.lang.Object

com.electronwill.nightconfig.core.file.GenericBuilder<Base,Result>

Direct Known Subclasses:

CommentedFileConfigBuilder, FileConfigBuilder

public abstract class GenericBuilder<Base extends Config,Result extends FileConfig>
extends java.lang.Object

A generic FileConfig/CommentedFileConfig/someOtherFileConfig builder. The default settings are:

• Charset: UTF-8 - change it with charset(Charset)
• WritingMode: REPLACE - change it with writingMode(WritingMode)
• ParsingMode: REPLACE - change it with parsingMode(ParsingMode)
• FileNotFoundAction: CREATE_EMPTY - change it with onFileNotFound(FileNotFoundAction)
• Asynchronous writing, ie config.save() returns quickly and operates in the background - change it with sync()
• Not autosaved - change it with autosave()
• Not autoreloaded - change it with autoreload()
• Values' insertion order preserved if Config.isInsertionOrderPreserved() returns true when the builder is constructed.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	atomicMove
protected java.lang.Runnable	autoLoadListener
protected FileWatcher	autoreloadFileWatcher
protected boolean	autosave
protected java.lang.Runnable	autoSaveListener
protected java.nio.charset.Charset	charset
protected java.nio.file.Path	file
protected ConfigFormat<? extends Base>	format
protected java.lang.Runnable	loadListener
protected java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>>	mapCreator
protected FileNotFoundAction	nefAction
protected ConfigParser<? extends Base>	parser
protected ParsingMode	parsingMode
protected boolean	preserveInsertionOrder
protected java.lang.Runnable	saveListener
protected boolean	sync
protected ConfigWriter	writer
protected WritingMode	writingMode

Method Summary

Modifier and Type	Method and Description
GenericBuilder<Base,Result>	async() Makes the configuration "write-asynchronous", that is, its FileConfig.save() method does not wait for the write operation to complete.
GenericBuilder<Base,Result>	asyncWithDebouncing(java.time.Duration debounceTime) Makes the configuration "write-asynchronous" and specifies its debouncing time.
GenericBuilder<Base,Result>	autoreload() Makes the configuration "autoreloaded", that is, its FileConfig.load() method is automatically called when the file is modified.
GenericBuilder<Base,Result>	autoreload(FileWatcher fileWatcher) Makes the configuration "autoreloaded", using the given FileWatcher to monitor the config file.
GenericBuilder<Base,Result>	autosave() Makes the configuration "autosaved", that is, its FileConfig.save() method is automatically called when it is modified.
GenericBuilder<Base,Result>	backingMapCreator(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> s) Uses a specific Supplier to create the backing maps (one for the top level and one for each sub-configuration) of the configuration.
Result	build() Creates a new FileConfig with the chosen settings.
protected Result	buildAutosave(CommentedFileConfig chain)
protected Result	buildNormal(CommentedFileConfig chain)
GenericBuilder<Base,Result>	charset(java.nio.charset.Charset charset) Sets the charset used for FileConfig.save() and FileConfig.load().
GenericBuilder<Base,Result>	concurrent() Deprecated. Since NightConfig v3.7, this method has no effect because all FileConfig are thread-safe, backed by ConcurrentConfig.
GenericBuilder<Base,Result>	defaultData(java.io.File file) Sets the file to copy when the config's file is not found.
GenericBuilder<Base,Result>	defaultData(java.nio.file.Path file) Sets the file to copy when the config's file is not found.
GenericBuilder<Base,Result>	defaultData(java.net.URL url) Sets the URL of the data to copy when the config's file is not found.
GenericBuilder<Base,Result>	defaultResource(java.lang.String resourcePath) Sets the resource (in the jar) to copy when the config's file is not found.
GenericBuilder<Base,Result>	onAutoReload(java.lang.Runnable listener) When the configuration is automatically (re)loaded, calls the given listener.
GenericBuilder<Base,Result>	onAutoSave(java.lang.Runnable listener) When the configuration triggers an automatic save, calls the given listener.
GenericBuilder<Base,Result>	onFileNotFound(FileNotFoundAction notFoundAction) Sets the action to execute when the config's file is not found.
GenericBuilder<Base,Result>	onLoad(java.lang.Runnable listener) When the configuration is (re)loaded, calls the given listener.
GenericBuilder<Base,Result>	onLoadFilter(ConfigLoadFilter filter) When the configuration is (re)loaded, applies the given filter first.
GenericBuilder<Base,Result>	onSave(java.lang.Runnable listener) When the configuration is saved, calls the given listener.
GenericBuilder<Base,Result>	parsingMode(ParsingMode parsingMode) Sets the ParsingMode used for FileConfig.load().
GenericBuilder<Base,Result>	preserveInsertionOrder() Makes the configuration preserve the insertion order of its values.
GenericBuilder<Base,Result>	sync() Makes the configuration "write-synchronous", that is, its FileConfig.save() method blocks until the write operation completes.
GenericBuilder<Base,Result>	writingMode(WritingMode writingMode) Sets the WritingMode used for FileConfig.save().

Methods inherited from class java.lang.Object

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

Field Detail

file

protected final java.nio.file.Path file

format

protected final ConfigFormat<? extends Base extends Config> format

writer

protected final ConfigWriter writer

parser

protected final ConfigParser<? extends Base extends Config> parser

charset

protected java.nio.charset.Charset charset

writingMode

protected WritingMode writingMode

parsingMode

protected ParsingMode parsingMode

nefAction

protected FileNotFoundAction nefAction

sync

protected boolean sync

autosave

protected boolean autosave

atomicMove

protected boolean atomicMove

autoreloadFileWatcher

protected FileWatcher autoreloadFileWatcher

preserveInsertionOrder

protected boolean preserveInsertionOrder

mapCreator

protected java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> mapCreator

loadListener

protected java.lang.Runnable loadListener

saveListener

protected java.lang.Runnable saveListener

autoLoadListener

protected java.lang.Runnable autoLoadListener

autoSaveListener

protected java.lang.Runnable autoSaveListener

Method Detail

charset

public GenericBuilder<Base,Result> charset(java.nio.charset.Charset charset)

Sets the charset used for FileConfig.save() and FileConfig.load().

Parameters:

charset - the charset to decode the characters with

Returns:

this builder

writingMode

public GenericBuilder<Base,Result> writingMode(WritingMode writingMode)

Sets the WritingMode used for FileConfig.save().

Example:

 
 FileConfig config = FileConfig.builder(file).writingMode(WritingMode.REPLACE_ATOMIC).build();
 
 

Parameters:

writingMode - how to write to the file

Returns:

this builder

parsingMode

public GenericBuilder<Base,Result> parsingMode(ParsingMode parsingMode)

Sets the ParsingMode used for FileConfig.load().

Parameters:

parsingMode - how to handle conflicts between the existing entries and the new entries that are read from the file

Returns:

this builder

onFileNotFound

public GenericBuilder<Base,Result> onFileNotFound(FileNotFoundAction notFoundAction)

Sets the action to execute when the config's file is not found.

Parameters:

notFoundAction - what to do when the file does not exist

Returns:

this builder

defaultResource

public GenericBuilder<Base,Result> defaultResource(java.lang.String resourcePath)

Sets the resource (in the jar) to copy when the config's file is not found. This is a shortcut for onFileNotFound(FileNotFoundAction.copyResource(resourcePath))

Parameters:

resourcePath - the resource's path

Returns:

this builder

defaultData

public GenericBuilder<Base,Result> defaultData(java.io.File file)

Sets the file to copy when the config's file is not found. This is a shortcut for onFileNotFound(FileNotFoundAction.copyData(file))

Parameters:

file - the data file

Returns:

this builder

defaultData

public GenericBuilder<Base,Result> defaultData(java.nio.file.Path file)

Sets the file to copy when the config's file is not found. This is a shortcut for onFileNotFound(FileNotFoundAction.copyData(file))

Parameters:

file - the data file

Returns:

this builder

defaultData

public GenericBuilder<Base,Result> defaultData(java.net.URL url)

Sets the URL of the data to copy when the config's file is not found. This is a shortcut for onFileNotFound(FileNotFoundAction.copyData(url))

Parameters:

url - the data url

Returns:

this builder

sync

public GenericBuilder<Base,Result> sync()

Makes the configuration "write-synchronous", that is, its FileConfig.save() method blocks until the write operation completes.

Returns:

this builder

async

public GenericBuilder<Base,Result> async()

Makes the configuration "write-asynchronous", that is, its FileConfig.save() method does not wait for the write operation to complete.

An automatic debouncing of unspecified duration is applied.

Returns:

this builder

asyncWithDebouncing

public GenericBuilder<Base,Result> asyncWithDebouncing(java.time.Duration debounceTime)

Makes the configuration "write-asynchronous" and specifies its debouncing time.

The config's FileConfig.save() method will not wait for the write operation to complete, and perform a debouncing of the given duration. Calling FileConfig.save() twice with less than debounceTime in between will cancel the first save and only perform the second.

Parameters:

debounceTime - the minimal time between two saves

Returns:

this builder

autosave

public GenericBuilder<Base,Result> autosave()

Makes the configuration "autosaved", that is, its FileConfig.save() method is automatically called when it is modified.

Returns:

this builder

autoreload

public GenericBuilder<Base,Result> autoreload()

Makes the configuration "autoreloaded", that is, its FileConfig.load() method is automatically called when the file is modified.

Returns:

this builder

autoreload

public GenericBuilder<Base,Result> autoreload(FileWatcher fileWatcher)

Makes the configuration "autoreloaded", using the given FileWatcher to monitor the config file.

Parameters:

fileWatcher - the FileWatcher to register a watch to, in order to reload the config when the file changes

Returns:

this builder

onAutoReload

public GenericBuilder<Base,Result> onAutoReload(java.lang.Runnable listener)

When the configuration is automatically (re)loaded, calls the given listener. Only one listener can be set, calling onAutoReload multiple times will replace the listener.

The listener is called once the loading operation is complete. If a ConfigLoadFilter is set and rejects the operation, the listener is not called.

If FileConfig.load() is called manually rather than automatically, the listener is not called. Use onLoad(Runnable) to be notified of every call to FileConfig.load(), including manual ones.

If autoreload() is not called, setting a listener has no effect.

Parameters:

listener - the listener to call when the FileConfig is automatically reloaded

Returns:

this builder

onAutoSave

public GenericBuilder<Base,Result> onAutoSave(java.lang.Runnable listener)

When the configuration triggers an automatic save, calls the given listener. Only one listener can be set, calling onAutoSave multiple times will replace the listener.

If the FileConfig is asynchronous and a debouncing occurs, the listener can be called without an actual saving operation being executed (due to the debouncing, the actual save will occur later). Otherwise, the listener is called once the saving operation is complete.

If FileConfig.save() is called manually rather than automatically, the listener is not called. Use onSave(Runnable) to be notified of every call to FileConfig.save(), including manual ones.

If autosave() is not called on the builder, setting a listener has no effect.

Parameters:

listener - the listener to call when the FileConfig is automatically saved

Returns:

this builder

onLoad

public GenericBuilder<Base,Result> onLoad(java.lang.Runnable listener)

When the configuration is (re)loaded, calls the given listener. Only one listener can be set, calling onLoad multiple times will replace the listener. It is possible to set both an "auto-load" listener and a "load" listener at the same time.

The listener is called once the loading operation is complete. If a ConfigLoadFilter is set and rejects the operation, the listener is not called.

If autoreload() is not called on the builder, setting a listener has no effect.

Parameters:

listener - the listener to call when the FileConfig is automatically reloaded

Returns:

this builder

onSave

public GenericBuilder<Base,Result> onSave(java.lang.Runnable listener)

When the configuration is saved, calls the given listener. Only one listener can be set, calling onSave multiple times will replace the listener. It is possible to set both an "auto-save" listener and a "save" listener at the same time.

The listener is called once the saving operation is complete. If a ConfigLoadFilter is set and rejects the operation, the listener is not called.

If autosave() is not called, setting a listener has no effect.

Parameters:

listener - the listener to call when the FileConfig is automatically saved

Returns:

this builder

onLoadFilter

public GenericBuilder<Base,Result> onLoadFilter(ConfigLoadFilter filter)

When the configuration is (re)loaded, applies the given filter first. The filter can either accept or reject the (re)load. If the operation is rejected, the configuration is not modified.

If a listener is set and the filter accepts the operation, the listener is called after the filter. If a listener is set and the filter rejects the operation, the listener is not called.

Parameters:

filter - the filter to call on FileConfig.load()

Returns:

this builder

concurrent

@Deprecated
public GenericBuilder<Base,Result> concurrent()

Deprecated. Since NightConfig v3.7, this method has no effect because all FileConfig are thread-safe, backed by ConcurrentConfig.

Makes the configuration concurrent, that is, thread-safe.

Returns:

this builder

preserveInsertionOrder

public GenericBuilder<Base,Result> preserveInsertionOrder()

Makes the configuration preserve the insertion order of its values.

If this method is not called, the default value of Config.isInsertionOrderPreserved() is applied.

Returns:

this builder

backingMapCreator

public GenericBuilder<Base,Result> backingMapCreator(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> s)

Uses a specific Supplier to create the backing maps (one for the top level and one for each sub-configuration) of the configuration.

Parameters:

s - the map supplier to use

Returns:

this builder

build

public Result build()

Creates a new FileConfig with the chosen settings.

Returns:

the config

buildAutosave

protected Result buildAutosave(CommentedFileConfig chain)

buildNormal

protected Result buildNormal(CommentedFileConfig chain)