com.electronwill.nightconfig.json

Class JsonFormat<W extends com.electronwill.nightconfig.core.io.ConfigWriter>

java.lang.Object

com.electronwill.nightconfig.json.JsonFormat<W>

All Implemented Interfaces:

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

public abstract class JsonFormat<W extends com.electronwill.nightconfig.core.io.ConfigWriter>
extends java.lang.Object
implements com.electronwill.nightconfig.core.ConfigFormat<com.electronwill.nightconfig.core.Config>

Method Summary

Modifier and Type	Method and Description
com.electronwill.nightconfig.core.Config	createConfig(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> mapCreator)
abstract com.electronwill.nightconfig.core.io.ConfigParser<com.electronwill.nightconfig.core.Config>	createParser()
abstract W	createWriter()
static JsonFormat<FancyJsonWriter>	emptyTolerantInstance()
static JsonFormat<FancyJsonWriter>	fancyInstance()
void	initEmptyFile(java.io.Writer writer)
void	initEmptyFile(com.electronwill.nightconfig.core.utils.WriterSupplier ws)
static JsonFormat<MinimalJsonWriter>	minimalEmptyTolerantInstance()
static JsonFormat<MinimalJsonWriter>	minimalInstance()
static com.electronwill.nightconfig.core.Config	newConcurrentConfig()
static com.electronwill.nightconfig.core.Config	newConfig()
static com.electronwill.nightconfig.core.Config	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, isInMemory, supportsType

Method Detail

fancyInstance

public static JsonFormat<FancyJsonWriter> fancyInstance()

Returns:

the unique instance of JsonFormat that creates FancyJsonWriters.

minimalInstance

public static JsonFormat<MinimalJsonWriter> minimalInstance()

Returns:

the unique instance of JsonFormat that creates MinimalJsonWriters.

emptyTolerantInstance

public static JsonFormat<FancyJsonWriter> emptyTolerantInstance()

Returns:

an instance of JsonFormat with a parser that accepts empty inputs and a fancy writer

minimalEmptyTolerantInstance

public static JsonFormat<MinimalJsonWriter> minimalEmptyTolerantInstance()

Returns:

an instance of JsonFormat with a parser that accepts empty inputs and a minimal writer

newConfig

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

Returns:

a new config with the format fancyInstance().

newConfig

public static com.electronwill.nightconfig.core.Config 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.Config newConcurrentConfig()

Returns:

a new thread-safe config with the format fancyInstance().

createWriter

public abstract W createWriter()

Specified by:

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

createParser

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

Specified by:

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

createConfig

public com.electronwill.nightconfig.core.Config 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.Config>

supportsComments

public boolean supportsComments()

Specified by:

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

initEmptyFile

public void initEmptyFile(com.electronwill.nightconfig.core.utils.WriterSupplier ws)
                   throws java.io.IOException

Specified by:

initEmptyFile in interface com.electronwill.nightconfig.core.ConfigFormat<com.electronwill.nightconfig.core.Config>

Throws:

java.io.IOException

initEmptyFile

public void initEmptyFile(java.io.Writer writer)
                   throws java.io.IOException

Specified by:

initEmptyFile in interface com.electronwill.nightconfig.core.ConfigFormat<com.electronwill.nightconfig.core.Config>

Throws:

java.io.IOException