Package dev.siroshun.configapi.core.serialization.record

Class RecordSerializer<R extends Record>

java.lang.Object

dev.siroshun.configapi.core.serialization.record.RecordSerializer<R>

Type Parameters:

R - the type of the Record

All Implemented Interfaces:

Serializer<R,MapNode>, Function<R,MapNode>

@Experimental
public final class RecordSerializer<R extends Record>
extends Object
implements Serializer<R,MapNode>

A Serializer implementation for serializing Record object to MapNode.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RecordSerializer.Builder<R extends Record>	A RecordSerializer.Builder class for RecordSerializer.

Method Summary

Modifier and Type	Method	Description
static <R extends Record> @NotNull RecordSerializer.Builder<R>	builder()	Creates a new RecordSerializer.Builder of RecordSerializer.
static <R extends Record> @NotNull RecordSerializer<R>	create(@NotNull KeyGenerator keyGenerator)	Creates a RecordSerializer with the KeyGenerator.
@NotNull MapNode	serialize(R input)	Serializes the object.
@NotNull MapNode	serializeDefault(@NotNull Class<? extends R> clazz)	Creates a default MapNode from the given record class.
static <R extends Record> @NotNull RecordSerializer<R>	serializer()	Gets the default RecordSerializer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.siroshun.configapi.core.serialization.Serializer

andThen, apply, compose

Method Details

serializer

@NotNull
public static <R extends Record>
@NotNull RecordSerializer<R> serializer()

Gets the default RecordSerializer.

This serializer uses KeyGenerator.AS_IS.

Type Parameters:

R - the type of the Record

Returns:

the default RecordSerializer

create

@NotNull
public static <R extends Record>
@NotNull RecordSerializer<R> create(@NotNull
 @NotNull KeyGenerator keyGenerator)

Creates a RecordSerializer with the KeyGenerator.

If specifying KeyGenerator.AS_IS, this method returns serializer().

Type Parameters:

R - the type of the Record

Parameters:

keyGenerator - the KeyGenerator to generate key name

Returns:

the RecordSerializer

builder

@NotNull
public static <R extends Record>
@NotNull RecordSerializer.Builder<R> builder()

Creates a new RecordSerializer.Builder of RecordSerializer.

Type Parameters:

R - the type of the Record

Returns:

a new RecordSerializer.Builder of RecordSerializer

serialize

@NotNull
public @NotNull MapNode serialize(@NotNull
 R input)
                           throws SerializationException

Serializes the object.

Specified by:

serialize in interface Serializer<R extends Record,MapNode>

Parameters:

input - the object to serialize

Returns:

the serialized result

Throws:

SerializationException - if Serializer for the custom objects is not found, etc

serializeDefault

@NotNull
public @NotNull MapNode serializeDefault(@NotNull
 @NotNull Class<? extends R> clazz)
                                  throws SerializationException

Creates a default MapNode from the given record class.

Parameters:

clazz - the Record to create MapNode

Returns:

a default MapNode of the given record class

Throws:

SerializationException - if Serializer for the custom objects is not found, etc