Module tcconfig.core

Package xyz.tozymc.configuration.serialization

Class TcConfigSerializations

java.lang.Object

xyz.tozymc.configuration.serialization.TcConfigSerializations

public final class TcConfigSerializations
extends Object

Backend for object serialization.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
static void	clearCache()	Clears the reflection cache.
static <T> T	deserializeObject(@NotNull Class<T> type, Map<String,?> serialized)	Creates new object from represented map.
static void	registerSerializer(@NotNull TcConfigSerializer<?> serializer)	Registers the serializer to the backend.
static void	registerSerializers(TcConfigSerializer<?> @NotNull ... serializers)	Registers the serializers to the backend.
static @NotNull Map<String,?>	serializeObject(@NotNull Object object)	Creates map represented the object.
static void	unregisterSerializer(@NotNull TcConfigSerializer<?> serializer)	Unregisters the serializer to the backend.
static void	unregisterSerializers(TcConfigSerializer<?> @NotNull ... serializers)	Unregisters the serializers to the backend.

Methods inherited from class java.lang.Object

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

Method Detail

clearCache

public static void clearCache()

Clears the reflection cache.

ReflectionCache cache constructor, and field need for serialization.

registerSerializer

public static void registerSerializer(@NotNull
                                      @NotNull TcConfigSerializer<?> serializer)

Registers the serializer to the backend.

Parameters:

serializer - Serializer to register.

Throws:

IllegalStateException - Thrown when serializer is registered.

registerSerializers

public static void registerSerializers(TcConfigSerializer<?> @NotNull ... serializers)

Registers the serializers to the backend.

Parameters:

serializers - Serializers to register.

Throws:

IllegalStateException - Thrown when serializer is registered.

unregisterSerializer

public static void unregisterSerializer(@NotNull
                                        @NotNull TcConfigSerializer<?> serializer)

Unregisters the serializer to the backend.

Parameters:

serializer - Serializer to unregister.

Throws:

IllegalStateException - Thrown when serializer isn't registered.

unregisterSerializers

public static void unregisterSerializers(TcConfigSerializer<?> @NotNull ... serializers)

Unregisters the serializers to the backend.

Parameters:

serializers - Serializers to unregister.

Throws:

IllegalStateException - Thrown when serializer isn't registered.

serializeObject

@NotNull
public static @NotNull Map<String,?> serializeObject(@NotNull
                                                           @NotNull Object object)

Creates map represented the object.

Parameters:

object - Object to serialize

Returns:

Map represented the object.

Throws:

TcConfigSerializationException - Thrown when no serializer represented the type.

deserializeObject

@NotNull
public static <T> T deserializeObject(@NotNull
                                      @NotNull Class<T> type,
                                      Map<String,?> serialized)

Creates new object from represented map.

Type Parameters:

T - Type of serializable object.

Parameters:

type - The class type of deserializable object.

serialized - Map represented the object.

Returns:

New object created from represented map.

Throws:

TcConfigSerializationException - Thrown when no serializer represented the type.