net.sergeych.biserializer

Class BiMapper

java.lang.Object

net.sergeych.biserializer.BiMapper

public class BiMapper
extends java.lang.Object

Mapper allows sny object types to have registered procedures to de/serialize self to the Map structures, e.g. Binders.

To provide support for your own class, implement BiSerializable in it and register it with registerClass(Class), in a static constructor or explicitly. If you can't or don't like to integrate it into the class, write custom BiAdapter for it and register it with registerAdapter(Class, BiAdapter).

There is a DefaultBiMapper to reigister all general-purpose classes and adapters. If you don't want to expose it globally, create custom BiMapper instance and register your private stuff with it, then get newSerializer() and newDeserializer() or construct these directly using your private mapper.

This could be tricky as it can not reconstruct reference trees, unlike, for example, Boss serializer, so your serialization code must do its best to properly reconstruct links in your object tree.

Constructor Summary

Constructors

Constructor and Description
BiMapper() Create empty mapper, knowing nothing about serialization.
BiMapper(BiMapper parent) Create a mapper with copy of serialization information from a given mapper.

Method Summary

Modifier and Type	Method and Description
<T> T	deserialize(java.util.Map map) deserialize(Map, BiDeserializer) using default BiDeserializer.
<T> T	deserialize(java.util.Map map, BiDeserializer deserializer) Try to deserialize map containing serialized object, e.g.
void	deserializeInPlace(java.util.Map map, BiDeserializer deserializer) Update the map deserialziing it's values - e.g.
<T> T	deserializeObject(java.lang.Object x)
<T> T	deserializeObject(java.lang.Object obj, BiDeserializer deserializer) Deserialize any object, if possible.
BiDeserializer	newDeserializer() Construct new deserializer to use this mapper
BiSerializer	newSerializer() Construct new serializer to use this mapper
<T> void	registerAdapter(java.lang.Class<T> klass, BiAdapter adapter)
void	registerClass(java.lang.Class<? extends BiSerializable> klass) Add a class to serializable with this mapper.
<T> T	serialize(java.lang.Object x) Same as serialize(Object, BiSerializer) with default BiSerializer.
<T> T	serialize(java.lang.Object x, BiSerializer serializer) Try to serialize object to Binder using current set of BiAdapter.
boolean	unregister(java.lang.Class klass) unregister class.

Methods inherited from class java.lang.Object

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

Constructor Detail

BiMapper

public BiMapper()

Create empty mapper, knowing nothing about serialization. Populate it with registerAdapter(Class, BiAdapter) and/or registerClass(Class) before use.

BiMapper

public BiMapper(BiMapper parent)

Create a mapper with copy of serialization information from a given mapper. Note that the class receives a copy of it, so later changes in a parent class won't affect this instance and vice versa.

Parameters:

parent - mapper to copy serialization information from

Method Detail

deserializeInPlace

public void deserializeInPlace(java.util.Map map,
                               BiDeserializer deserializer)

Update the map deserialziing it's values - e.g. in place. Saves memory but has strong side effects of discarding source data.

Parameters:

map - to update

deserializer - to use to deserialize map values

deserialize

public <T> T deserialize(java.util.Map map,
                         BiDeserializer deserializer)

Try to deserialize map containing serialized object, e.g. having "__type" or "__t" key. Important. Is this implementation can't deserialize the map, what usually means it has no known/properly serialized object in it, it juts desearliazes it in place with deserializeInPlace(Map, BiDeserializer) and return the same (but updated) map instance.

Type Parameters:

T -

Parameters:

map - possible containing the serialized object

Returns:

deserialized object or deserialized map

deserialize

public <T> T deserialize(java.util.Map map)

deserialize(Map, BiDeserializer) using default BiDeserializer.

Type Parameters:

T -

Parameters:

map - to deserialize

Returns:

deserialized object of the map with deserialized values.

deserializeObject

public <T> T deserializeObject(java.lang.Object x)

deserializeObject

public <T> T deserializeObject(java.lang.Object obj,
                               BiDeserializer deserializer)

Deserialize any object, if possible.

• if the object is a simple type, e.g. number, string, boolean, it will be simply retured.
• if the object is a collection, every item of it will be deserialized the sam way and the result will be returned as a List with random access (like ArrayList)
• if the object is a map, it will be processed as with deserialize(Map, BiDeserializer)

Type Parameters:

T -

Parameters:

obj - to deserealize

deserializer - to

Returns:

serialize

public <T> T serialize(java.lang.Object x,
                       BiSerializer serializer)

Try to serialize object to Binder using current set of BiAdapter. See registerAdapter(Class, BiAdapter), registerClass(Class) for more. This method properly serializes Maps and Collections, serializing it contents.

Type Parameters:

T -

Parameters:

x - object to serialize (can be array, list, map, binder or any object with registered adapter. processes in depth, e.g. all values in the map or items in the list.

Returns:

either a Binder or a simple object x (e.g. String if x instanceof String).

Throws:

java.lang.IllegalArgumentException - if unkonwn ibject ecnountered which can not be serialized.

serialize

public <T> T serialize(java.lang.Object x)

Same as serialize(Object, BiSerializer) with default BiSerializer.

registerAdapter

public <T> void registerAdapter(java.lang.Class<T> klass,
                                BiAdapter adapter)

unregister

public boolean unregister(java.lang.Class klass)

unregister class. All associated adapters will be removed.

Parameters:

klass -

Returns:

true if the class was registered before, wither as BiSerializable class or with BiAdapter.

registerClass

public void registerClass(java.lang.Class<? extends BiSerializable> klass)

Add a class to serializable with this mapper. Remeber to have nonparametric constructor (possibly private) so deserializer could create its instances.

Parameters:

klass - to register

newSerializer

public BiSerializer newSerializer()

Construct new serializer to use this mapper

newDeserializer

public BiDeserializer newDeserializer()

Construct new deserializer to use this mapper