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

Interface DeserializerRegistry<S>

Type Parameters:

S - a type of objects to deserialize

public sealed interface DeserializerRegistry<S>

A registry that manages Deserializers.

The implementations of this interface are thread-safe.

Method Summary

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

Method Details

create

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

Creates a new DeserializerRegistry.

Type Parameters:

S - a type of objects to deserialize

Returns:

a new DeserializerRegistry

empty

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

Returns an empty DeserializerRegistry.

The returning DeserializerRegistry is frozen.

Type Parameters:

S - a type of objects to deserialize

Returns:

an empty DeserializerRegistry

get

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

Gets the Deserializer associated with the specified class.

Type Parameters:

T - a type of object after deserialization

Parameters:

clazz - the class to get Deserializer

Returns:

the Deserializer associated with the specified class, or null

getAsOptional

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

Gets the Deserializer associated with the specified class.

Type Parameters:

T - a type of object after deserialization

Parameters:

clazz - the class to get Deserializer

Returns:

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

register

@Contract("_, _ -> this")
@NotNull
<T> @NotNull DeserializerRegistry<S> register(@NotNull
 @NotNull Class<T> clazz,
 @NotNull
 @NotNull Deserializer<? super S,? extends T> deserializer)

Registers Deserializer.

Type Parameters:

T - a type of object after deserialization

Parameters:

clazz - a class to associate Deserializer with

deserializer - a Deserializer to register

Returns:

this DeserializerRegistry instance

registerAll

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

Registers Deserializers in the given DeserializerRegistry.

Parameters:

registry - a DeserializerRegistry that contains Deserializers to register

Returns:

this DeserializerRegistry instance

freeze

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

Freezes this DeserializerRegistry.

After calling this method, register(Class, Deserializer) and registerAll(DeserializerRegistry) will throw IllegalStateException.

This method can be called multiple times.

Returns:

this DeserializerRegistry instance

isFrozen

boolean isFrozen()

Checks if this DeserializerRegistry is frozen.

Returns:

true if this DeserializerRegistry is frozen, otherwise false