CommentedFileConfigBuilder (core 3.6.7 API)

java.lang.Object

com.electronwill.nightconfig.core.file.GenericBuilder<CommentedConfig,CommentedFileConfig>

com.electronwill.nightconfig.core.file.CommentedFileConfigBuilder

public final class CommentedFileConfigBuilder extends GenericBuilder<CommentedConfig,CommentedFileConfig>

Builder for CommentedFileConfig. The default settings are:

Charset: UTF-8 - change it with GenericBuilder.charset(Charset)
WritingMode: REPLACE - change it with GenericBuilder.writingMode(WritingMode)
ParsingMode: REPLACE - change it with GenericBuilder.parsingMode(ParsingMode)
FileNotFoundAction: CREATE_EMPTY - change it with GenericBuilder.onFileNotFound(FileNotFoundAction)
Asynchronous writing, ie config.save() returns quickly and operates in the background - change it with GenericBuilder.sync()
Not autosaved - change it with GenericBuilder.autosave()
Not autoreloaded - change it with GenericBuilder.autoreload()
Not thread-safe - change it with GenericBuilder.concurrent()

Field Summary

Fields inherited from class com.electronwill.nightconfig.core.file.GenericBuilder
autoreload, autosave, charset, concurrent, file, format, insertionOrder, mapCreator, nefAction, parser, parsingMode, sync, writer, writingMode
Method Summary

Modifier and Type

Method

Description

protected CommentedFileConfig

buildAutosave(FileConfig chain)

protected CommentedFileConfig

buildNormal(FileConfig chain)

Methods inherited from class com.electronwill.nightconfig.core.file.GenericBuilder
autoreload, autosave, backingMapCreator, build, charset, concurrent, defaultData, defaultData, defaultData, defaultResource, getConfig, onFileNotFound, parsingMode, preserveInsertionOrder, sync, writingMode

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

Method Details
- buildAutosave
  
  protected CommentedFileConfig buildAutosave(FileConfig chain)
  
  Specified by:
  
  buildAutosave in class GenericBuilder<CommentedConfig,CommentedFileConfig>
- buildNormal
  
  protected CommentedFileConfig buildNormal(FileConfig chain)
  
  Specified by:
  
  buildNormal in class GenericBuilder<CommentedConfig,CommentedFileConfig>