com.electronwill.nightconfig.core.serde

Class ObjectDeserializer

java.lang.Object

com.electronwill.nightconfig.core.serde.ObjectDeserializer

public final class ObjectDeserializer
extends java.lang.Object

Deserializes configs (UnmodifiableConfig, Config, etc.) to Java objects.

Example

Given a class like this:

 class Position {
     private final int x, y, z;

     public Position(int x, int y, int z) {
         this.x=x; this.y=y; this.z=z;
     }
 }
 

And a configuration like this:

 Config conf = Config.inMemory();
 conf.set("x", 12);
 conf.set("y", -20);
 conf.set("z", 42);
 

You can deserialize the Config to an instance of Position with:

 Position deserialized = new ObjectDeserializer.standard().deserializeFields(conf, Position::new);
 // result: Position(12, -20, 42)
 

Use builder() or blankBuilder() to precisely configure the deserialization process.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	applyTransientModifier
protected ValueDeserializerProvider<?,?>	defaultProvider
protected java.util.List<ValueDeserializerProvider<?,?>>	generalProviders

Method Summary

Modifier and Type	Method and Description
static ObjectDeserializerBuilder	blankBuilder() Creates a new ObjectDeserializerBuilder without the standard deserializers already registered.
static ObjectDeserializerBuilder	builder() Creates a new ObjectDeserializerBuilder with some standard deserializers already registered.
void	deserializeFields(UnmodifiableConfig source, java.lang.Object destination) Deserializes a Config as an object by transforming the config entries into fields.
<R> R	deserializeFields(UnmodifiableConfig source, java.util.function.Supplier<? extends R> destinationSupplier) Deserializes a Config as an object of type R by transforming the config entries into fields.
<C extends java.util.Collection<V>,V> C	deserializeToCollection(java.lang.Object configValue, java.lang.Class<C> collectionClass, java.lang.Class<V> valueClass) Deserializes a value into an instance of the collection C<V>.
<M extends java.util.Map<java.lang.String,V>,V> M	deserializeToMap(java.lang.Object configValue, java.lang.Class<M> mapClass, java.lang.Class<V> valueClass) Deserializes a value into an instance of the map M<String, V>.
protected java.util.function.Supplier<?>	findDefaultValueSupplier(java.lang.Object rawConfigValue, java.lang.reflect.Field field, java.lang.Object instance)
protected <T,R> ValueDeserializer<T,R>	findValueDeserializer(T value, TypeConstraint resultType)
static ObjectDeserializer	standard() Creates a new ObjectDeserializer with the standard deserializers.

Methods inherited from class java.lang.Object

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

Field Detail

generalProviders

protected final java.util.List<ValueDeserializerProvider<?,?>> generalProviders

defaultProvider

protected ValueDeserializerProvider<?,?> defaultProvider

applyTransientModifier

protected final boolean applyTransientModifier

Method Detail

builder

public static ObjectDeserializerBuilder builder()

Creates a new ObjectDeserializerBuilder with some standard deserializers already registered.

Returns:

a new builder

blankBuilder

public static ObjectDeserializerBuilder blankBuilder()

Creates a new ObjectDeserializerBuilder without the standard deserializers already registered.

Returns:

a new builder

standard

public static ObjectDeserializer standard()

Creates a new ObjectDeserializer with the standard deserializers.

This is equivalent to ObjectDeserializer.builder().build().

deserializeToCollection

public <C extends java.util.Collection<V>,V> C deserializeToCollection(java.lang.Object configValue,
                                                                       java.lang.Class<C> collectionClass,
                                                                       java.lang.Class<V> valueClass)

Deserializes a value into an instance of the collection C<V>.

Type Parameters:

C - type of the collection

V - type of the values in the collection

Parameters:

configValue - config value to deserialize

collectionClass - class of the collection

valueClass - class of the values in the collection

Returns:

the deserialized collection

deserializeToMap

public <M extends java.util.Map<java.lang.String,V>,V> M deserializeToMap(java.lang.Object configValue,
                                                                          java.lang.Class<M> mapClass,
                                                                          java.lang.Class<V> valueClass)

Deserializes a value into an instance of the map M<String, V>.

Type Parameters:

M - type of the map

V - type of the values in the map

Parameters:

configValue - config value to deserialize

mapClass - class of the map

valueClass - class of the values in the collection

Returns:

the deserialized map

deserializeFields

public void deserializeFields(UnmodifiableConfig source,
                              java.lang.Object destination)

Deserializes a Config as an object by transforming the config entries into fields. The fields of the destination are modified through reflection.

Parameters:

source - config to deserialize

destination - object to store the result in

deserializeFields

public <R> R deserializeFields(UnmodifiableConfig source,
                               java.util.function.Supplier<? extends R> destinationSupplier)

Deserializes a Config as an object of type R by transforming the config entries into fields. A new instance of the object is created, and its fields are modified through reflection.

Type Parameters:

R - type of the resulting object

Parameters:

source - config to deserialize

destinationSupplier - supplier of the resulting object

Returns:

the deserialized object

findValueDeserializer

protected <T,R> ValueDeserializer<T,R> findValueDeserializer(T value,
                                                             TypeConstraint resultType)

findDefaultValueSupplier

protected java.util.function.Supplier<?> findDefaultValueSupplier(java.lang.Object rawConfigValue,
                                                                  java.lang.reflect.Field field,
                                                                  java.lang.Object instance)