org.mapdb

Class SerializerPojo

java.lang.Object

org.mapdb.SerializerBase

org.mapdb.SerializerPojo

All Implemented Interfaces:

java.io.Serializable, Serializer<java.lang.Object>

public class SerializerPojo
extends SerializerBase
implements java.io.Serializable

Serializer which handles POJO, object graphs etc.

Author:

Jan Kotek

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SerializerPojo.ClassInfo Stores info about single class stored in MapDB.
protected static class	SerializerPojo.FieldInfo Stores info about single field stored in MapDB.
protected class	SerializerPojo.ObjectInputStream2
protected class	SerializerPojo.ObjectOutputStream2

Nested classes/interfaces inherited from class org.mapdb.SerializerBase

SerializerBase.FastArrayList<K>, SerializerBase.Header, SerializerBase.HeaderMapDB, SerializerBase.singletons

Nested classes/interfaces inherited from interface org.mapdb.Serializer

Serializer.CompressionWrapper<E>

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.reflect.Method	androidConstructor
private static java.lang.reflect.Method	androidConstructorGinger
protected java.util.Map<java.lang.Class<?>,java.lang.Integer>	class2classId
protected static java.util.Map<java.lang.Class<?>,java.lang.reflect.Constructor<?>>	class2constuctor
protected java.util.Map<java.lang.Integer,java.lang.Class<?>>	classId2class
private static java.lang.Object	constructorId
protected DB	db
protected java.util.concurrent.locks.ReentrantReadWriteLock	lock
protected int	oldSize
protected java.util.concurrent.CopyOnWriteArrayList<SerializerPojo.ClassInfo>	registered
protected java.util.concurrent.CopyOnWriteArrayList<Fun.Function1>	serializationTransformsDeserialize
protected java.util.concurrent.CopyOnWriteArrayList<Fun.Function1>	serializationTransformsSerialize
protected static Serializer<java.util.concurrent.CopyOnWriteArrayList<SerializerPojo.ClassInfo>>	serializer
private static long	serialVersionUID
protected static java.lang.reflect.Method	sunConstructor
protected static java.lang.Object	sunReflFac

Fields inherited from class org.mapdb.SerializerBase

EMPTY_STRING

Fields inherited from interface org.mapdb.Serializer

BASIC, BOOLEAN, BYTE_ARRAY, BYTE_ARRAY_NOSIZE, CHAR_ARRAY, DOUBLE_ARRAY, ILLEGAL_ACCESS, INT_ARRAY, INTEGER, JAVA, LONG, LONG_ARRAY, STRING, STRING_ASCII, STRING_INTERN, STRING_NOSIZE, UUID

Constructor Summary

Constructors

Constructor and Description
SerializerPojo(java.util.concurrent.CopyOnWriteArrayList<SerializerPojo.ClassInfo> registered)

Method Summary

Modifier and Type	Method and Description
protected void	assertClassSerializable(java.lang.Class<?> clazz)
protected static java.lang.Class<?>	classForName(java.lang.String className)
boolean	containsClass(java.lang.Class<?> clazz)
protected <T> T	createInstanceSkippinkConstructor(java.lang.Class<T> clazz) For pojo serialization we need to instantiate class without invoking its constructor.
java.lang.Object	deserialize(java.io.DataInput is, int capacity) Deserialize the content of an object from a DataInput.
protected java.lang.Object	deserializeUnknownHeader(java.io.DataInput in, int head, SerializerBase.FastArrayList<java.lang.Object> objectStack) override this method to extend SerializerBase functionality
int	getClassId(java.lang.Class<?> clazz)
protected Engine	getEngine()
protected java.io.ObjectStreamField[]	getFields(java.lang.Class<?> clazz)
java.lang.Object	getFieldValue(SerializerPojo.FieldInfo fieldInfo, java.lang.Object object)
private static java.lang.reflect.Method	getInheritableMethod(java.lang.Class<?> cl, java.lang.String name, java.lang.Class<?>[] argTypes, java.lang.Class<?> returnType) Returns non-static, non-abstract method with given signature provided it is defined by or accessible (via inheritance) by the given class, or null if no match found.
boolean	hasUnsavedChanges()
void	registerClass(java.lang.Class<?> clazz)
void	save(Engine e)
protected void	saveClassInfo() action performed after classInfo was modified, feel free to override
void	serialize(java.io.DataOutput out, java.lang.Object obj) Serialize the content of an object into a ObjectOutput
<A,R> void	serializerTransformAdd(Fun.Function1<A,R> beforeSerialization, Fun.Function1<R,A> afterDeserialization) Add interceptor which may modify all deserialized/serialized objects
<A,R> void	serializerTransformRemove(Fun.Function1<A,R> beforeSerialization, Fun.Function1<R,A> afterDeserialization) Removes interceptor which may modify all deserialized/serialized objects
protected void	serializeUnknownObject(java.io.DataOutput out, java.lang.Object obj, SerializerBase.FastArrayList<java.lang.Object> objectStack) override this method to extend SerializerBase functionality
protected void	setDb(DB db)
void	setFieldValue(SerializerPojo.FieldInfo fieldInfo, java.lang.Object object, java.lang.Object value)
protected boolean	usesAdvancedSerialization(java.lang.Class<?> clazz)

Methods inherited from class org.mapdb.SerializerBase

assertSerializable, booleanToByteArray, deserialize, deserializeClass, deserializeMapDB, deserializeString, fixedSize, readBooleanArray, serialize, serializeClass

Methods inherited from class java.lang.Object

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

Field Detail

serializer

protected static final Serializer<java.util.concurrent.CopyOnWriteArrayList<SerializerPojo.ClassInfo>> serializer

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

lock

protected final java.util.concurrent.locks.ReentrantReadWriteLock lock

db

protected DB db

registered

protected java.util.concurrent.CopyOnWriteArrayList<SerializerPojo.ClassInfo> registered

class2classId

protected java.util.Map<java.lang.Class<?>,java.lang.Integer> class2classId

classId2class

protected java.util.Map<java.lang.Integer,java.lang.Class<?>> classId2class

sunConstructor

protected static java.lang.reflect.Method sunConstructor

sunReflFac

protected static java.lang.Object sunReflFac

androidConstructor

protected static java.lang.reflect.Method androidConstructor

androidConstructorGinger

private static java.lang.reflect.Method androidConstructorGinger

constructorId

private static java.lang.Object constructorId

class2constuctor

protected static java.util.Map<java.lang.Class<?>,java.lang.reflect.Constructor<?>> class2constuctor

oldSize

protected int oldSize

serializationTransformsSerialize

protected java.util.concurrent.CopyOnWriteArrayList<Fun.Function1> serializationTransformsSerialize

serializationTransformsDeserialize

protected java.util.concurrent.CopyOnWriteArrayList<Fun.Function1> serializationTransformsDeserialize

Constructor Detail

SerializerPojo

public SerializerPojo(java.util.concurrent.CopyOnWriteArrayList<SerializerPojo.ClassInfo> registered)

Method Detail

classForName

protected static java.lang.Class<?> classForName(java.lang.String className)

setDb

protected void setDb(DB db)

registerClass

public void registerClass(java.lang.Class<?> clazz)
                   throws java.io.IOException

Throws:

java.io.IOException

usesAdvancedSerialization

protected boolean usesAdvancedSerialization(java.lang.Class<?> clazz)

getInheritableMethod

private static java.lang.reflect.Method getInheritableMethod(java.lang.Class<?> cl,
                                                             java.lang.String name,
                                                             java.lang.Class<?>[] argTypes,
                                                             java.lang.Class<?> returnType)

Returns non-static, non-abstract method with given signature provided it is defined by or accessible (via inheritance) by the given class, or null if no match found. Access checks are disabled on the returned method (if any).

saveClassInfo

protected void saveClassInfo()

action performed after classInfo was modified, feel free to override

getFields

protected java.io.ObjectStreamField[] getFields(java.lang.Class<?> clazz)

assertClassSerializable

protected void assertClassSerializable(java.lang.Class<?> clazz)
                                throws java.io.NotSerializableException,
                                       java.io.InvalidClassException

Throws:

java.io.NotSerializableException

java.io.InvalidClassException

getFieldValue

public java.lang.Object getFieldValue(SerializerPojo.FieldInfo fieldInfo,
                                      java.lang.Object object)

setFieldValue

public void setFieldValue(SerializerPojo.FieldInfo fieldInfo,
                          java.lang.Object object,
                          java.lang.Object value)

containsClass

public boolean containsClass(java.lang.Class<?> clazz)

getClassId

public int getClassId(java.lang.Class<?> clazz)

getEngine

protected Engine getEngine()

Overrides:

getEngine in class SerializerBase

serializeUnknownObject

protected void serializeUnknownObject(java.io.DataOutput out,
                                      java.lang.Object obj,
                                      SerializerBase.FastArrayList<java.lang.Object> objectStack)
                               throws java.io.IOException

Description copied from class: SerializerBase

override this method to extend SerializerBase functionality

Overrides:

serializeUnknownObject in class SerializerBase

Throws:

java.io.IOException

deserializeUnknownHeader

protected java.lang.Object deserializeUnknownHeader(java.io.DataInput in,
                                                    int head,
                                                    SerializerBase.FastArrayList<java.lang.Object> objectStack)
                                             throws java.io.IOException

Description copied from class: SerializerBase

override this method to extend SerializerBase functionality

Overrides:

deserializeUnknownHeader in class SerializerBase

Throws:

java.io.IOException

createInstanceSkippinkConstructor

protected <T> T createInstanceSkippinkConstructor(java.lang.Class<T> clazz)
                                           throws java.lang.NoSuchMethodException,
                                                  java.lang.reflect.InvocationTargetException,
                                                  java.lang.IllegalAccessException,
                                                  java.lang.InstantiationException

For pojo serialization we need to instantiate class without invoking its constructor. There are two ways to do it:

Using proprietary API on Oracle JDK and OpenJDK sun.reflect.ReflectionFactory.getReflectionFactory().newConstructorForSerialization() more at http://www.javaspecialists.eu/archive/Issue175.html

Using 'ObjectInputStream.newInstance' on Android http://stackoverflow.com/a/3448384

If non of these works we fallback into usual reflection which requires an no-arg constructor

Throws:

java.lang.NoSuchMethodException

java.lang.reflect.InvocationTargetException

java.lang.IllegalAccessException

java.lang.InstantiationException

hasUnsavedChanges

public boolean hasUnsavedChanges()

save

public void save(Engine e)

serializerTransformAdd

public <A,R> void serializerTransformAdd(Fun.Function1<A,R> beforeSerialization,
                                         Fun.Function1<R,A> afterDeserialization)

Add interceptor which may modify all deserialized/serialized objects

Parameters:

beforeSerialization - transform called on all object before they are serialized

afterDeserialization - transform called on all object after they are serialized

serializerTransformRemove

public <A,R> void serializerTransformRemove(Fun.Function1<A,R> beforeSerialization,
                                            Fun.Function1<R,A> afterDeserialization)

Removes interceptor which may modify all deserialized/serialized objects

Parameters:

beforeSerialization - transform called on all object before they are serialized

afterDeserialization - transform called on all object after they are serialized

serialize

public void serialize(java.io.DataOutput out,
                      java.lang.Object obj)
               throws java.io.IOException

Description copied from interface: Serializer

Serialize the content of an object into a ObjectOutput

Specified by:

serialize in interface Serializer<java.lang.Object>

Overrides:

serialize in class SerializerBase

Parameters:

out - ObjectOutput to save object into

obj - Object to serialize

Throws:

java.io.IOException

deserialize

public java.lang.Object deserialize(java.io.DataInput is,
                                    int capacity)
                             throws java.io.IOException

Description copied from interface: Serializer

Deserialize the content of an object from a DataInput.

Specified by:

deserialize in interface Serializer<java.lang.Object>

Overrides:

deserialize in class SerializerBase

Parameters:

is - to read serialized data from

capacity - how many bytes are available in DataInput for reading, may be -1 (in streams) or 0 (null).

Returns:

deserialized object

Throws:

java.io.IOException