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

Class RecordSerialization<R extends Record>

java.lang.Object

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

Type Parameters:

R - the type of the Record

All Implemented Interfaces:

Serialization<R,MapNode>

@Experimental
public final class RecordSerialization<R extends Record>
extends Object
implements Serialization<R,MapNode>

A Serialization implementation for Record class.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static <R extends Record> @NotNull RecordSerialization.Builder<R>	builder(@NotNull Class<? extends R> recordClass)	Creates a new RecordSerialization.Builder of the specified Record class.
static <R extends Record> @NotNull RecordSerialization.Builder<R>	builder(R defaultRecord)	Creates a new RecordSerialization.Builder with the default record.
static <R extends Record> @NotNull RecordSerialization<R>	create(@NotNull Class<? extends R> recordClass)	Creates a new RecordSerialization of the specified Record class.
static <R extends Record> @NotNull RecordSerialization<R>	create(@NotNull Class<? extends R> recordClass, @NotNull KeyGenerator keyGenerator)	Creates a new RecordSerialization of the specified Record class.
static <R extends Record> @NotNull RecordSerialization<R>	create(R defaultRecord)	Creates a new RecordSerialization with the default record.
static <R extends Record> @NotNull RecordSerialization<R>	create(R defaultRecord, @NotNull KeyGenerator keyGenerator)	Creates a new RecordSerialization with the default record.
@NotNull RecordDeserializer<R>	deserializer()	Gets Deserializer which this Serialization has.
boolean	hasDeserializer()	Checks if this Serialization has Deserializer.
boolean	hasSerializer()	Checks if this Serialization has Serializer.
@NotNull RecordSerializer<R>	serializer()	Gets Serializer which this Serialization has.

Methods inherited from class java.lang.Object

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

Method Details

create

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

Creates a new RecordSerialization of the specified Record class.

Type Parameters:

R - the type of the Record

Parameters:

recordClass - a class of the Record

Returns:

a new RecordSerialization of the specified Record class

create

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

Creates a new RecordSerialization of the specified Record class.

Type Parameters:

R - the type of the Record

Parameters:

recordClass - a class of the Record

keyGenerator - the KeyGenerator to generate keys from field names

Returns:

a new RecordSerialization of the specified Record class

create

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

Creates a new RecordSerialization 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:

a new RecordSerialization of the specified Record class

create

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

Creates a new RecordSerialization 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:

a new RecordSerialization of the specified Record class

builder

@Contract(value="_ -> new",
          pure=true)
@NotNull
public static <R extends Record>
@NotNull RecordSerialization.Builder<R> builder(@NotNull
 @NotNull Class<? extends R> recordClass)

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

Type Parameters:

R - the type of the Record

Parameters:

recordClass - a class of the Record

Returns:

a new RecordSerialization.Builder of RecordSerialization for the specified Record class

builder

@Contract(value="_ -> new",
          pure=true)
@NotNull
public static <R extends Record>
@NotNull RecordSerialization.Builder<R> builder(@NotNull
 R defaultRecord)

Creates a new RecordSerialization.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:

a new RecordSerialization.Builder of RecordSerialization for the specified Record class

hasSerializer

public boolean hasSerializer()

Description copied from interface: Serialization

Checks if this Serialization has Serializer.

Specified by:

hasSerializer in interface Serialization<R extends Record,MapNode>

Returns:

true if this Serialization has Serializer, otherwise false

hasDeserializer

public boolean hasDeserializer()

Description copied from interface: Serialization

Checks if this Serialization has Deserializer.

Specified by:

hasDeserializer in interface Serialization<R extends Record,MapNode>

Returns:

true if this Serialization has Deserializer, otherwise false

serializer

@NotNull
public @NotNull RecordSerializer<R> serializer()

Description copied from interface: Serialization

Gets Serializer which this Serialization has.

Specified by:

serializer in interface Serialization<R extends Record,MapNode>

Returns:

Serializer which this Serialization has

deserializer

@NotNull
public @NotNull RecordDeserializer<R> deserializer()

Description copied from interface: Serialization

Gets Deserializer which this Serialization has.

Specified by:

deserializer in interface Serialization<R extends Record,MapNode>

Returns:

Deserializer which this Serialization has