com.electronwill.nightconfig.core.serde

Class SerializerContext

java.lang.Object

com.electronwill.nightconfig.core.serde.SerializerContext

public final class SerializerContext
extends java.lang.Object

Holds serialization settings and provides some base serialization logic.

Method Summary

Modifier and Type	Method and Description
ConfigFormat<?>	configFormat()
CommentedConfig	createCommentedConfig()
Config	createConfig()
void	serializeFields(java.lang.Object source, Config destination) Serializes an object as a Config by transforming its fields into configuration entries in destination.
java.lang.Object	serializeValue(java.lang.Object value) Serializes a single value.

Methods inherited from class java.lang.Object

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

Method Detail

configFormat

public ConfigFormat<?> configFormat()

Returns:

the current ConfigFormat

createConfig

public Config createConfig()

Returns:

a new Config

createCommentedConfig

public CommentedConfig createCommentedConfig()

Returns:

a new CommentedConfig

serializeValue

public java.lang.Object serializeValue(java.lang.Object value)

Serializes a single value.

Parameters:

value - value coming from a field that we are serializing

Returns:

a value that can be added to a config

Throws:

SerdeException - if no suitable serializer is found

serializeFields

public void serializeFields(java.lang.Object source,
                            Config destination)

Serializes an object as a Config by transforming its fields into configuration entries in destination.

Parameters:

source - the object that we are serializing

destination - the config that we are modifying (result of the serialization)