com.electronwill.nightconfig.yaml

Class YamlFormat

java.lang.Object

com.electronwill.nightconfig.yaml.YamlFormat

All Implemented Interfaces:

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

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

Method Summary

Modifier and Type	Method and Description
static YamlFormat	configuredInstance(org.yaml.snakeyaml.Yaml yaml) Creates an instance of YamlFormat, set with the specified Yaml object.
com.electronwill.nightconfig.core.Config	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.Config>	createParser()
com.electronwill.nightconfig.core.io.ConfigWriter	createWriter()
static YamlFormat	defaultInstance()
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>> mapCreator)
boolean	supportsComments()
boolean	supportsType(java.lang.Class<?> type)

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

Method Detail

defaultInstance

public static YamlFormat defaultInstance()

Returns:

the default instance of HoconFormat

configuredInstance

public static YamlFormat configuredInstance(org.yaml.snakeyaml.Yaml yaml)

Creates an instance of YamlFormat, set with the specified Yaml object.

Parameters:

yaml - the Yaml object to use

Returns:

a new instance of YamlFormat

newConfig

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

Returns:

a new config with the format defaultInstance().

newConfig

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

Returns:

a new config with the given map creator

newConcurrentConfig

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

Returns:

a new concurrent config with the format defaultInstance().

createWriter

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

Specified by:

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

createParser

public 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>

supportsType

public boolean supportsType(java.lang.Class<?> type)

Specified by:

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