com.electronwill.nightconfig.core

Class InMemoryCommentedFormat

java.lang.Object

com.electronwill.nightconfig.core.InMemoryCommentedFormat

All Implemented Interfaces:

ConfigFormat<CommentedConfig>

public class InMemoryCommentedFormat
extends java.lang.Object
implements ConfigFormat<CommentedConfig>

The commented version of InMemoryFormat

Method Summary

Modifier and Type	Method and Description
CommentedConfig	createConfig(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.Object>> mapCreator) Creates a config that uses the given map supplier for all its levels (top level and subconfigs).
ConfigParser<CommentedConfig>	createParser()
ConfigWriter	createWriter()
static InMemoryCommentedFormat	defaultInstance()
boolean	isInMemory() Checks if this format is in memory only and therefore cannot create writers nor parsers.
boolean	supportsComments() Checks if this format supports CommentedConfigs.
boolean	supportsType(java.lang.Class<?> type) Checks if this format supports the given type of value.
static InMemoryCommentedFormat	withSupport(java.util.function.Predicate<java.lang.Class<?>> supportPredicate)
static InMemoryCommentedFormat	withUniversalSupport()

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

Method Detail

defaultInstance

public static InMemoryCommentedFormat defaultInstance()

withSupport

public static InMemoryCommentedFormat withSupport(java.util.function.Predicate<java.lang.Class<?>> supportPredicate)

withUniversalSupport

public static InMemoryCommentedFormat withUniversalSupport()

createWriter

public ConfigWriter createWriter()

Specified by:

createWriter in interface ConfigFormat<CommentedConfig>

Returns:

a writer of this config format

createParser

public ConfigParser<CommentedConfig> createParser()

Specified by:

createParser in interface ConfigFormat<CommentedConfig>

Returns:

a parser of this config format

createConfig

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

Description copied from interface: ConfigFormat

Creates a config that uses the given map supplier for all its levels (top level and subconfigs).

Specified by:

createConfig in interface ConfigFormat<CommentedConfig>

Parameters:

mapCreator - the map supplier for the config

Returns:

a config of this format with the given map creator

supportsComments

public boolean supportsComments()

Description copied from interface: ConfigFormat

Checks if this format supports CommentedConfigs. Note that supporting CommentedConfigs isn't the same things as allowing the user to write comments in the config files.

Specified by:

supportsComments in interface ConfigFormat<CommentedConfig>

Returns:

true iff this format supports CommentedConfigs

supportsType

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

Description copied from interface: ConfigFormat

Checks if this format supports the given type of value.

Specified by:

supportsType in interface ConfigFormat<CommentedConfig>

Parameters:

type - the type to check, may be null in which case this method checks if the format supports null values

Returns:

true iff this format supports the given type

isInMemory

public boolean isInMemory()

Description copied from interface: ConfigFormat

Checks if this format is in memory only and therefore cannot create writers nor parsers.

Specified by:

isInMemory in interface ConfigFormat<CommentedConfig>

Returns:

true iff this format is only in memory.