dev.dejvokep.boostedyaml.serialization

Interface YamlSerializer

All Known Implementing Classes:

StandardSerializer

public interface YamlSerializer

Interface used by custom serializer implementations. If you are looking into building your own implementation, it is recommended that you read the wiki.

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.
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> Map<Object,Object>	serialize(T object, MapSupplier supplier) Attempts to serialize the given object into a map and returns it.

Method Detail

deserialize

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

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.

Parameters:

map - the raw map to deserialize

Returns:

the deserialized object

serialize

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

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

The given object is guaranteed to be:

1. of type contained within getSupportedClasses(),
2. a sub-class of any of 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.

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
Set<Class<?>> getSupportedClasses()

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.

Returns:

the set of supported classes

getSupportedParentClasses

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

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.

Returns:

the set of supported parent classes