Package dev.siroshun.configapi.core.serialization.registry

Interface SerializationRegistry<S>

Type Parameters:

S - a type of objects after serializing

public sealed interface SerializationRegistry<S>

A registry that manages Serializations.

The implementations of this interface are thread-safe.

Method Summary

Modifier and Type	Method	Description
@NotNull DeserializerRegistry<S>	asDeserializerRegistry()	Gets the DeserializerRegistry that refers this SerializationRegistry.
@NotNull SerializerRegistry<S>	asSerializerRegistry()	Gets the SerializerRegistry that refers this SerializationRegistry.
static <S> @NotNull SerializationRegistry<S>	create()	Creates a new SerializationRegistry.
static <S> @NotNull SerializationRegistry<S>	empty()	Returns an empty SerializationRegistry.
@NotNull SerializationRegistry<S>	freeze()	Freezes this SerializationRegistry.
<T> @Nullable Serialization<T,S>	get(@NotNull Class<T> clazz)	Gets the Serialization associated with the specified class.
default <T> @NotNull Optional<Serialization<T,S>>	getAsOptional(@NotNull Class<T> clazz)	Gets the Serialization associated with the specified class.
boolean	isFrozen()	Checks if this SerializationRegistry is frozen.
<T> @NotNull SerializationRegistry<S>	register(@NotNull Class<T> clazz, @NotNull Serialization<? super T,? extends S> serialization)	Registers Serialization.
@NotNull SerializationRegistry<S>	registerAll(@NotNull SerializationRegistry<S> registry)	Registers Serializations in the given SerializationRegistry.

Method Details

create

@Contract(" -> new")
@NotNull
static <S> @NotNull SerializationRegistry<S> create()

Creates a new SerializationRegistry.

Type Parameters:

S - a type of objects after serializing

Returns:

a new SerializationRegistry

empty

@NotNull
static <S> @NotNull SerializationRegistry<S> empty()

Returns an empty SerializationRegistry.

The returning SerializationRegistry is frozen.

Type Parameters:

S - a type of objects after serializing

Returns:

an empty SerializationRegistry

get

@Nullable
<T> @Nullable Serialization<T,S> get(@NotNull
 @NotNull Class<T> clazz)

Gets the Serialization associated with the specified class.

Type Parameters:

T - a type of objects after serializing

Parameters:

clazz - the class to get Serialization

Returns:

the Serialization associated with the specified class, or null

getAsOptional

@NotNull
default <T> @NotNull Optional<Serialization<T,S>> getAsOptional(@NotNull
 @NotNull Class<T> clazz)

Gets the Serialization associated with the specified class.

Type Parameters:

T - a type of objects after serializing

Parameters:

clazz - the class to get Serialization

Returns:

the Serialization associated with the specified class, or Optional.empty()

register

@Contract("_, _ -> this")
@NotNull
<T> @NotNull SerializationRegistry<S> register(@NotNull
 @NotNull Class<T> clazz,
 @NotNull
 @NotNull Serialization<? super T,? extends S> serialization)

Registers Serialization.

Type Parameters:

T - a type of objects after serializing

Parameters:

clazz - a class to associate Serialization with

serialization - a Serialization to register

Returns:

this SerializationRegistry instance

registerAll

@Contract("_ -> this")
@NotNull
@NotNull SerializationRegistry<S> registerAll(@NotNull
 @NotNull SerializationRegistry<S> registry)

Registers Serializations in the given SerializationRegistry.

Parameters:

registry - a Serialization that contains Serializations to register

Returns:

this SerializationRegistry instance

freeze

@Contract("-> this")
@NotNull
@NotNull SerializationRegistry<S> freeze()

Freezes this SerializationRegistry.

After calling this method, register(Class, Serialization) and registerAll(SerializationRegistry) will throw IllegalStateException.

This method can be called multiple times.

Returns:

this SerializationRegistry instance

isFrozen

boolean isFrozen()

Checks if this SerializationRegistry is frozen.

Returns:

true if this SerializationRegistry is frozen, otherwise false

asSerializerRegistry

@NotNull
@NotNull SerializerRegistry<S> asSerializerRegistry()

Gets the SerializerRegistry that refers this SerializationRegistry.

When calling SerializerRegistry.register(Class, Serializer) or SerializerRegistry.registerAll(SerializerRegistry), the returning SerializerRegistry will register it to this registry using Serialization.onlySerializer(Serializer) or Serialization.create(Serializer, Deserializer) (if Deserializer exists)

Returns:

the SerializerRegistry that refers this SerializationRegistry

asDeserializerRegistry

@NotNull
@NotNull DeserializerRegistry<S> asDeserializerRegistry()

Gets the DeserializerRegistry that refers this SerializationRegistry.

When calling DeserializerRegistry.register(Class, Deserializer) or DeserializerRegistry.registerAll(DeserializerRegistry), the returning DeserializerRegistry will register it to this registry using Serialization.onlyDeserializer(Deserializer) or Serialization.create(Serializer, Deserializer) (if Serializer exists)

Returns:

the DeserializerRegistry that refers this SerializationRegistry