dev.dejvokep.boostedyaml.serialization.standard

Interface TypeAdapter<T>

Type Parameters:

T - type of the adapter

public interface TypeAdapter<T>

Interface used to (de-)serialize custom types with StandardSerializer.

Please note that classes implementing this interface must also be registered to the used serializer instance. See StandardSerializer.register(Class, TypeAdapter).

Method Summary

Modifier and Type	Method and Description
T	deserialize(Map<Object,Object> map) Deserializes the given map into instance of this type.
Map<Object,Object>	serialize(T object) Serializes the given instance into a map.
default Map<String,Object>	toStringKeyedMap(Map<?,?> map) Converts this map (including all sub-maps) to String=value HashMap.

Method Detail

serialize

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

Serializes the given instance into a map.

The returned map does not need to (but may) contain the type identifier: one entry in the top-level map (the one returned), where the key is defined by the serializer (== for StandardSerializer.getDefault()) and the value identifies the serialized type - either by the full canonical classname (e.g. me.name.project.objects.CustomObject) or it's alias. If you decide to include a type identifier, it must be registered (this requirement is not verified).

If the returned map does not contain the identifier, the serializer will automatically use the full classname.

Parameters:

object - object to serialize

Returns:

the serialized object

deserialize

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

Deserializes the given map into instance of this type.

The given map is a raw object map; there are no blocks, just native Java objects themselves.

Use toStringKeyedMap(Map) to convert the map.

Parameters:

map - the raw map to deserialize

Returns:

the deserialized object

toStringKeyedMap

@NotNull
default Map<String,Object> toStringKeyedMap(@NotNull
                                                      Map<?,?> map)

Converts this map (including all sub-maps) to String=value HashMap.

Parameters:

map - the map to convert

Returns:

the converted map