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

Class RecordDeserializer<R extends Record>

java.lang.Object

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

Type Parameters:

R - the type of the Record

All Implemented Interfaces:

Deserializer<MapNode,R>, Function<MapNode,R>

@Experimental
public final class RecordDeserializer<R extends Record>
extends Object
implements Deserializer<MapNode,R>

A Deserializer implementation for deserializing MapNode to Record object.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static <R extends Record> @NotNull RecordDeserializer.Builder<R>	builder(@NotNull Class<? extends R> recordClass)	Creates a new RecordDeserializer.Builder of the specified Record class.
static <R extends Record> @NotNull RecordDeserializer.Builder<R>	builder(R defaultRecord)	Creates a new RecordDeserializer.Builder with the default record.
static <R extends Record> @NotNull RecordDeserializer<R>	create(@NotNull Class<? extends R> recordClass)	Creates RecordDeserializer of the specified Record class.
static <R extends Record> @NotNull RecordDeserializer<R>	create(@NotNull Class<? extends R> recordClass, @NotNull KeyGenerator keyGenerator)	Creates RecordDeserializer of the specified Record class.
static <R extends Record> @NotNull RecordDeserializer<R>	create(R defaultRecord)	Creates RecordDeserializer with the default record.
static <R extends Record> @NotNull RecordDeserializer<R>	create(R defaultRecord, @NotNull KeyGenerator keyGenerator)	Creates RecordDeserializer with the default record.
R	deserialize(@NotNull MapNode input)	Deserializes the object.

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.Deserializer

andThen, apply, compose

Method Details

create

@Contract("_ -> new")
@NotNull
public static <R extends Record>
@NotNull RecordDeserializer<R> create(@NotNull
 @NotNull Class<? extends R> recordClass)

Creates RecordDeserializer of the specified Record class.

Type Parameters:

R - the type of the Record

Parameters:

recordClass - the class of the Record

Returns:

RecordDeserializer of the specified Record class

create

@Contract("_, _ -> new")
@NotNull
public static <R extends Record>
@NotNull RecordDeserializer<R> create(@NotNull
 @NotNull Class<? extends R> recordClass,
 @NotNull
 @NotNull KeyGenerator keyGenerator)

Creates RecordDeserializer of the specified Record class.

Type Parameters:

R - the type of the Record

Parameters:

recordClass - the class of the Record

keyGenerator - the KeyGenerator to generate keys from field names

Returns:

RecordDeserializer of the specified Record class

create

@Contract("_ -> new")
@NotNull
public static <R extends Record>
@NotNull RecordDeserializer<R> create(@NotNull
 R defaultRecord)

Creates RecordDeserializer with the default record.

Type Parameters:

R - the type of the Record

Parameters:

defaultRecord - the default Record to get the default value if the value is not found in the MapNode

Returns:

RecordDeserializer of the specified Record class

create

@Contract("_, _ -> new")
@NotNull
public static <R extends Record>
@NotNull RecordDeserializer<R> create(@NotNull
 R defaultRecord,
 @NotNull
 @NotNull KeyGenerator keyGenerator)

Creates RecordDeserializer with the default record.

Type Parameters:

R - the type of the Record

Parameters:

defaultRecord - the default Record to get the default value if the value is not found in the MapNode

keyGenerator - the KeyGenerator to generate keys from field names

Returns:

RecordDeserializer of the specified Record class

builder

@Contract("_ -> new")
@NotNull
public static <R extends Record>
@NotNull RecordDeserializer.Builder<R> builder(@NotNull
 @NotNull Class<? extends R> recordClass)

Creates a new RecordDeserializer.Builder of the specified Record class.

Type Parameters:

R - the type of the Record

Parameters:

recordClass - the class of the Record

Returns:

RecordDeserializer.Builder of the specified Record class

builder

@Contract("_ -> new")
@NotNull
public static <R extends Record>
@NotNull RecordDeserializer.Builder<R> builder(@NotNull
 R defaultRecord)

Creates a new RecordDeserializer.Builder with the default record.

Type Parameters:

R - the type of the Record

Parameters:

defaultRecord - the default Record to get the default value if the value is not found in the MapNode

Returns:

RecordDeserializer.Builder of the specified Record class

deserialize

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

Deserializes the object.

Specified by:

deserialize in interface Deserializer<MapNode,R extends Record>

Parameters:

input - the object to deserialize

Returns:

the deserialized result

Throws:

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