com.electronwill.nightconfig.hocon

Class HoconFormat

java.lang.Object

com.electronwill.nightconfig.hocon.HoconFormat

All Implemented Interfaces:

com.electronwill.nightconfig.core.ConfigFormat<com.electronwill.nightconfig.core.CommentedConfig>

public final class HoconFormat
extends java.lang.Object
implements com.electronwill.nightconfig.core.ConfigFormat<com.electronwill.nightconfig.core.CommentedConfig>

Represents the Hocon config format.

Method Summary

Modifier and Type	Method and Description
com.electronwill.nightconfig.core.CommentedConfig	createConfig(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> mapCreator)
com.electronwill.nightconfig.core.io.ConfigParser<com.electronwill.nightconfig.core.CommentedConfig>	createParser()
com.electronwill.nightconfig.core.io.ConfigWriter	createWriter()
static HoconFormat	instance()
static com.electronwill.nightconfig.core.CommentedConfig	newConcurrentConfig()
static com.electronwill.nightconfig.core.CommentedConfig	newConfig()
static com.electronwill.nightconfig.core.CommentedConfig	newConfig(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> s)
boolean	supportsComments()

Methods inherited from class java.lang.Object

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

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

createConcurrentConfig, createConfig, initEmptyFile, initEmptyFile, initEmptyFile, initEmptyFile, isInMemory, supportsType

Method Detail

instance

public static HoconFormat instance()

Returns:

the unique instance of HoconFormat

newConfig

public static com.electronwill.nightconfig.core.CommentedConfig newConfig()

Returns:

a new config with the hocon format

newConfig

public static com.electronwill.nightconfig.core.CommentedConfig newConfig(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> s)

Returns:

a new config with the given map creator

newConcurrentConfig

public static com.electronwill.nightconfig.core.CommentedConfig newConcurrentConfig()

Returns:

a new thread-safe config with the hocon format

createWriter

public com.electronwill.nightconfig.core.io.ConfigWriter createWriter()

Specified by:

createWriter in interface com.electronwill.nightconfig.core.ConfigFormat<com.electronwill.nightconfig.core.CommentedConfig>

createParser

public com.electronwill.nightconfig.core.io.ConfigParser<com.electronwill.nightconfig.core.CommentedConfig> createParser()

Specified by:

createParser in interface com.electronwill.nightconfig.core.ConfigFormat<com.electronwill.nightconfig.core.CommentedConfig>

createConfig

public com.electronwill.nightconfig.core.CommentedConfig createConfig(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> mapCreator)

Specified by:

createConfig in interface com.electronwill.nightconfig.core.ConfigFormat<com.electronwill.nightconfig.core.CommentedConfig>

supportsComments

public boolean supportsComments()

Specified by:

supportsComments in interface com.electronwill.nightconfig.core.ConfigFormat<com.electronwill.nightconfig.core.CommentedConfig>