Package com.github.siroshun09.configapi.core.serialization.registry

Interface SerializerRegistry<S>

Type Parameters:

S - a type of objects after serializing

public sealed interface SerializerRegistry<S>

A registry that manages Serializers.

The implementations of this interface are thread-safe.

Method Summary

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

Method Details

create

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

Creates a new SerializerRegistry.

Type Parameters:

S - a type of objects after serializing

Returns:

a new SerializerRegistry

empty

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

Returns an empty SerializerRegistry.

The returning SerializerRegistry is frozen.

Type Parameters:

S - a type of objects after serializing

Returns:

an empty SerializerRegistry

get

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

Gets the Serializer associated with the specified class.

Type Parameters:

T - a type of object to serialize

Parameters:

clazz - the class to get Serializer

Returns:

the Serializer associated with the specified class, or null

getAsOptional

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

Gets the Serializer associated with the specified class.

Type Parameters:

T - a type of object to serialize

Parameters:

clazz - the class to get Serializer

Returns:

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

register

@Contract("_, _ -> this")
@NotNull
<T> @NotNull SerializerRegistry<S> register(@NotNull
 @NotNull Class<T> clazz,
 @NotNull
 @NotNull Serializer<? super T,? extends S> serializer)

Registers Serializer.

Type Parameters:

T - a type of object to serialize

Parameters:

clazz - a class to associate Serializer with

serializer - a Serializer to register

Returns:

this SerializerRegistry instance

registerAll

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

Registers Serializers in the given SerializerRegistry.

Parameters:

registry - a SerializerRegistry that contains Serializers to register

Returns:

this SerializerRegistry instance

freeze

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

Freezes this SerializerRegistry.

After calling this method, register(Class, Serializer) and registerAll(SerializerRegistry) will throw IllegalStateException.

This method can be called multiple times.

Returns:

this SerializerRegistry instance

isFrozen

boolean isFrozen()

Checks if this SerializerRegistry is frozen.

Returns:

true if this SerializerRegistry is frozen, otherwise false