dev.dejvokep.boostedyaml.serialization.standard

Class StandardSerializer

java.lang.Object

dev.dejvokep.boostedyaml.serialization.standard.StandardSerializer

All Implemented Interfaces:

YamlSerializer

public class StandardSerializer
extends Object
implements YamlSerializer

Standard serializer.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERIALIZED_TYPE_KEY Default key for serialized class identifier.

Constructor Summary

Constructors

Constructor and Description
StandardSerializer(Object serializedTypeKey) Creates a serializer.

Method Summary

Modifier and Type	Method and Description
Object	deserialize(Map<Object,Object> map) Attempts to deserialize the given map into a class instance using this serializer.
static StandardSerializer	getDefault() Returns the default serializer, which uses DEFAULT_SERIALIZED_TYPE_KEY.
Set<Class<?>>	getSupportedClasses() Returns a set of all explicitly defined classes this serializer supports and can (de-)serialize.
Set<Class<?>>	getSupportedParentClasses() Returns a set of all parent classes (classes, interfaces...) instances of which this serializer supports and can (de-)serialize.
<T> void	register(Class<T> clazz, TypeAdapter<T> adapter) Registers the given type for serialization.
<T> void	register(String alias, Class<T> clazz) Registers the specified alias for the given type (represented by the class).
<T> Map<Object,Object>	serialize(T object, MapSupplier supplier) Attempts to serialize the given object into a map and returns it.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SERIALIZED_TYPE_KEY

public static final String DEFAULT_SERIALIZED_TYPE_KEY

Default key for serialized class identifier. Used by the default serializer defaultSerializer.

See Also:

Constant Field Values

Constructor Detail

StandardSerializer

public StandardSerializer(@NotNull
                          Object serializedTypeKey)

Creates a serializer.

Parameters:

serializedTypeKey - the key for serialized class identifier

Method Detail

register

public <T> void register(@NotNull
                         Class<T> clazz,
                         @NotNull
                         TypeAdapter<T> adapter)

Registers the given type for serialization. The type now will be recognizable by its full classname (e.g. me.name.project.objects.Custom).

If you also want to set an alias (maybe for compatibility reasons), please use register(String, Class) afterwards.

Type Parameters:

T - type to register

Parameters:

clazz - the class of the type to register

adapter - adapter for the type

register

public <T> void register(@NotNull
                         String alias,
                         @NotNull
                         Class<T> clazz)

Registers the specified alias for the given type (represented by the class).

The type must already be registered.

Type Parameters:

T - type to register

Parameters:

clazz - the class to register

alias - alias for the class to register

deserialize

@Nullable
public Object deserialize(@NotNull
                                     Map<Object,Object> map)

Description copied from interface: YamlSerializer

Attempts to deserialize the given map into a class instance using this serializer.

The given map is a raw object map - there are no Block instances, just the values themselves.

If the serializer does not recognize the map, or could not deserialize the map, this method must return null.

Specified by:

deserialize in interface YamlSerializer

Parameters:

map - the raw map to deserialize

Returns:

the deserialized object

serialize

@Nullable
public <T> Map<Object,Object> serialize(@NotNull
                                                   T object,
                                                   @NotNull
                                                   MapSupplier supplier)

Description copied from interface: YamlSerializer

Attempts to serialize the given object into a map and returns it.

The given object is guaranteed to be:

1. of type contained within YamlSerializer.getSupportedClasses(),
2. a sub-class of any of YamlSerializer.getSupportedParentClasses().

Map supplier is provided to supply default map as configured in GeneralSettings.getDefaultMapSupplier(). Serializers should not use their own map implementations, they should return the map provided by the supplier.

If could not serialize into a map, this method must return null.

Specified by:

serialize in interface YamlSerializer

Type Parameters:

T - type of the object to serialize

Parameters:

object - the object to serialize

supplier - the supplier used to supply default maps

Returns:

the serialized object

getSupportedClasses

@NotNull
public Set<Class<?>> getSupportedClasses()

Description copied from interface: YamlSerializer

Returns a set of all explicitly defined classes this serializer supports and can (de-)serialize.

The returned set cannot be null as indicated by the annotation.

Specified by:

getSupportedClasses in interface YamlSerializer

Returns:

the set of supported classes

getSupportedParentClasses

@NotNull
public Set<Class<?>> getSupportedParentClasses()

Description copied from interface: YamlSerializer

Returns a set of all parent classes (classes, interfaces...) instances of which this serializer supports and can (de-)serialize.

The returned set cannot be null as indicated by the annotation.

Specified by:

getSupportedParentClasses in interface YamlSerializer

Returns:

the set of supported parent classes

getDefault

public static StandardSerializer getDefault()

Returns the default serializer, which uses DEFAULT_SERIALIZED_TYPE_KEY.

Returns:

the default serializer