com.electronwill.nightconfig.core.serde

Class ObjectSerializer

java.lang.Object

com.electronwill.nightconfig.core.serde.ObjectSerializer

public final class ObjectSerializer
extends java.lang.Object

Serializes Java objects to NightConfig configurations (UnmodifiableConfig, Config, etc.).

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 an instance like this:

 Position pos = new Position(12, -20, 42);
 

You can serialize your instance of Position to a Config with:

 Config conf = new ObjectSerializer.standard().serializeFields(pos, Config::inMemory);
 // result: SimpleConfig{x=12, y=-20, z=42}
 

It is also possible to serialize an object to an existing configuration, which is especially handy if you are working with FileConfigs.

 FileConfig myFileConfig = ...; // your FileConfig here
 new ObjectSerializer().standard().serializeFields(pos, myFileConfig);
 // the FileConfig is modified with the serialization result
 

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

Method Summary

Modifier and Type	Method and Description
static ObjectSerializerBuilder	blankBuilder() Creates a new ObjectSerializerBuilder with some standard serializers already registered.
static ObjectSerializerBuilder	builder() Creates a new ObjectSerializerBuilder with some standard serializers already registered.
java.lang.Object	serialize(java.lang.Object value, java.util.function.Supplier<? extends Config> configSupplier) Serializes a single value.
void	serializeFields(java.lang.Object source, Config destination) Serializes an object as a Config by transforming its fields into configuration entries.
<C extends Config> C	serializeFields(java.lang.Object source, java.util.function.Supplier<C> configSupplier) Serializes an object as a Config or type C by transforming its fields into configuration entries.
static ObjectSerializer	standard() Creates a new ObjectSerializer with the standard deserializers.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static ObjectSerializerBuilder builder()

Creates a new ObjectSerializerBuilder with some standard serializers already registered.

Returns:

a new builder

blankBuilder

public static ObjectSerializerBuilder blankBuilder()

Creates a new ObjectSerializerBuilder with some standard serializers already registered.

Returns:

a new builder

standard

public static ObjectSerializer standard()

Creates a new ObjectSerializer with the standard deserializers.

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

serialize

public java.lang.Object serialize(java.lang.Object value,
                                  java.util.function.Supplier<? extends Config> configSupplier)

Serializes a single value. The resulting object can be a Config, a List, or a plain value that would be suitable for insertion in a configuration supplied by configSupplier.

To ensure that you serialize the fields of a Java object into a Config, use serializeFields(Object, Supplier).

Returns:

the object, converted to a config value

serializeFields

public <C extends Config> C serializeFields(java.lang.Object source,
                                            java.util.function.Supplier<C> configSupplier)

Serializes an object as a Config or type C by transforming its fields into configuration entries. A new configuration is created with the configSupplier.

The serialization depends on the registered value serializers.

Returns:

the new configuration

See Also:

ObjectSerializerBuilder.withSerializerForClass(Class, ValueSerializer), ObjectSerializerBuilder.withSerializerForExactClass(Class, ValueSerializer), ObjectSerializerBuilder.withSerializerProvider(ValueSerializerProvider)

serializeFields

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

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

The serialization depends on the registered value serializers.

Parameters:

source - object to serialize

destination - configuration to store the result in

See Also:

ObjectSerializerBuilder.withSerializerForClass(Class, ValueSerializer), ObjectSerializerBuilder.withSerializerForExactClass(Class, ValueSerializer), ObjectSerializerBuilder.withSerializerProvider(ValueSerializerProvider)