com.electronwill.nightconfig.core.serde

Class ObjectDeserializerBuilder

java.lang.Object

com.electronwill.nightconfig.core.serde.ObjectDeserializerBuilder

public final class ObjectDeserializerBuilder
extends java.lang.Object

Builder for ObjectDeserializer.

Method Summary

Modifier and Type	Method and Description
ObjectDeserializer	build() Builds the ObjectDeserializer with the current settings.
void	deserializeTransientFields() Deserialize transient fields instead of ignoring them.
void	withDefaultDeserializerProvider() Enables the standard default serializer provider.
<V,R> void	withDefaultDeserializerProvider(ValueDeserializerProvider<V,R> provider) Sets the default serializer provider, which is called when no other ValueDeserializerProvider is able to give a ValueDeserializer for the incoming value and result type constraint.
<V,R> void	withDeserializerForClass(java.lang.Class<V> valueClass, java.lang.Class<R> resultClass, ValueDeserializer<? super V,? extends R> deserializer) Adds a ValueDeserializer that will be used to deserialize config values of type valueClass to objects of type resultClass.
<V,R> void	withDeserializerProvider(ValueDeserializerProvider<V,R> provider) Adds a ValueDeserializerProvider that provides ValueDeserializer to deserialize config values.

Methods inherited from class java.lang.Object

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

Method Detail

build

public ObjectDeserializer build()

Builds the ObjectDeserializer with the current settings.

Returns:

a new ObjectDeserializer

deserializeTransientFields

public void deserializeTransientFields()

Deserialize transient fields instead of ignoring them.

withDeserializerForClass

public <V,R> void withDeserializerForClass(java.lang.Class<V> valueClass,
                                           java.lang.Class<R> resultClass,
                                           ValueDeserializer<? super V,? extends R> deserializer)

Adds a ValueDeserializer that will be used to deserialize config values of type valueClass to objects of type resultClass.

Type Parameters:

V - type of the config values to deserialize

R - resulting type of the deserialization

Parameters:

valueClass - class of the config values to deserialize

resultClass - class of the deserialization result

deserializer - deserializer to register

withDeserializerProvider

public <V,R> void withDeserializerProvider(ValueDeserializerProvider<V,R> provider)

Adds a ValueDeserializerProvider that provides ValueDeserializer to deserialize config values.

Type Parameters:

V - type of the config values to deserialize

R - resulting type of the deserialization

Parameters:

provider - provider to register

withDefaultDeserializerProvider

public <V,R> void withDefaultDeserializerProvider(ValueDeserializerProvider<V,R> provider)

Sets the default serializer provider, which is called when no other ValueDeserializerProvider is able to give a ValueDeserializer for the incoming value and result type constraint.

This will replace any previously set default provider.

Type Parameters:

V - type of the config values to deserialize

R - resulting type of the deserialization

Parameters:

provider - the new default serializer

withDefaultDeserializerProvider

public void withDefaultDeserializerProvider()

Enables the standard default serializer provider.

This will replace any previously set default provider.

See Also:

withDefaultDeserializerProvider(ValueDeserializerProvider)