Package org.mapdb.elsa

Class ElsaSerializerPojo

java.lang.Object

org.mapdb.elsa.ElsaSerializerBase

org.mapdb.elsa.ElsaSerializerPojo

All Implemented Interfaces:

Serializable, ElsaSerializer

public class ElsaSerializerPojo
extends ElsaSerializerBase
implements Serializable

Advanced Elsa Serializer. On top of well known objects from ElsaSerializerBase, it can serialize any class by analyzing its fields.

TODO more javadoc

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ElsaSerializerPojo.ClassInfo	Stores info about single class stored in MapDB.
static class	ElsaSerializerPojo.FieldInfo	Stores info about single field stored in MapDB.

Nested classes/interfaces inherited from class org.mapdb.elsa.ElsaSerializerBase

ElsaSerializerBase.Deserializer<A>, ElsaSerializerBase.DeserInt, ElsaSerializerBase.DeserLong, ElsaSerializerBase.DeserSingleton, ElsaSerializerBase.DeserStringLen, ElsaSerializerBase.Header, ElsaSerializerBase.Serializer<A>, ElsaSerializerBase.UserSerializer

Field Summary

Fields

Modifier and Type	Field	Description
protected static Method	androidConstructor
private static Method	androidConstructorGinger
private static Method	androidConstructorJelly
protected static Map<Class<?>,Constructor<?>>	class2constuctor
protected static Map<Class,ElsaSerializerPojo.ClassInfo>	classInfoCache
protected final ElsaClassInfoResolver	classInfoResolver
private static Object	constructorId
private static final Logger	LOG
protected final ElsaClassCallback	missingClassNotification
private static final long	serialVersionUID
protected static Method	sunConstructor
protected static Object	sunReflFac

Fields inherited from class org.mapdb.elsa.ElsaSerializerBase

classCache, classLoader, DESER_BYTE_ARRAY, headerDeser, objectStackType, ser, SER_BOOLEAN, SER_BYTE, SER_BYTE_ARRAY, SER_CHAR, SER_DOUBLE, SER_FLOAT, SER_INT, SER_INT_ARRAY, SER_LONG, SER_LONG_ARRAY, SER_SHORT, SER_STRING, singletons, singletonsReverse, userDeser

Constructor Summary

Constructors

Constructor	Description
ElsaSerializerPojo()
ElsaSerializerPojo(ClassLoader classLoader, int objectStackType, Object[] singletons, Map<Class,ElsaSerializerBase.Serializer> userSer, Map<Class,Integer> userSerHeaders, Map<Integer,ElsaSerializerBase.Deserializer> userDeser, ElsaClassCallback missingClassNotification, ElsaClassInfoResolver classInfoResolver)

Method Summary

Modifier and Type	Method	Description
protected void	assertClassSerializable(Class<?> clazz)
protected static Class	classForName(String className, ClassLoader loader)
ElsaSerializerPojo.ClassInfo	classInfoDeserialize(DataInput in)
void	classInfoSerialize(DataOutput out, ElsaSerializerPojo.ClassInfo ci)
int	classToId(String className)
protected <T> T	createInstanceSkippinkConstructor(Class<T> clazz)	For pojo serialization we need to instantiate class without invoking its constructor.
protected Object	deserializeUnknownHeader(DataInput in, int head, ElsaStack objectStack)	override this method to extend ElsaSerializerBase functionality
protected ObjectStreamField[]	fieldsForClass(Class<?> clazz)
protected ElsaSerializerPojo.ClassInfo	getClassInfo(int classId)
Object	getFieldValue(ElsaSerializerPojo.FieldInfo fieldInfo, Object object)
boolean	isSerializable(Object o)	Checks if given object is known to Elsa.
private static Class	loadClassStaticUnchecked(String name, ClassLoader classLoader)
static ElsaSerializerPojo.ClassInfo	makeClassInfo(Class clazz, ClassLoader classLoader)
protected static ElsaSerializerPojo.ClassInfo	makeClassInfo2(Class clazz, ClassLoader classLoader)
private static ObjectStreamField[]	makeFieldsForClass(Class<?> clazz)
protected void	notifyMissingClassInfo(Class className)
protected void	serializeUnknownObject(DataOutput out, Object obj, ElsaStack objectStack)	override this method to extend ElsaSerializerBase functionality
void	setFieldValue(ElsaSerializerPojo.FieldInfo fieldInfo, Object object, Object value)
protected static boolean	useJavaSerialization(Class<?> clazz)	if class uses 'Java Serialization' trick such as `Externalizable`, `writeObject`, `writeReplace`...
private InputStream	wrapStream(DataInput in)

Methods inherited from class org.mapdb.elsa.ElsaSerializerBase

clone, defaultClassLoaderIfNull, deserialize, deserialize, deserializeSingleton, deserializeString, initHeaderDeser, initSer, loadClassCached, loadClassCached, loadClassCachedUnchecked, newElsaStack, readBooleanArray, serialize, serialize, serializeClass, serializeObjectArray, writeBooleanArray

Methods inherited from class java.lang.Object

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

Field Details

LOG

private static final Logger LOG

missingClassNotification

protected final ElsaClassCallback missingClassNotification

classInfoResolver

protected final ElsaClassInfoResolver classInfoResolver

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

classInfoCache

protected static Map<Class,ElsaSerializerPojo.ClassInfo> classInfoCache

sunConstructor

protected static Method sunConstructor

sunReflFac

protected static Object sunReflFac

androidConstructor

protected static Method androidConstructor

androidConstructorGinger

private static Method androidConstructorGinger

androidConstructorJelly

private static Method androidConstructorJelly

constructorId

private static Object constructorId

class2constuctor

protected static Map<Class<?>,Constructor<?>> class2constuctor

Constructor Details

ElsaSerializerPojo

public ElsaSerializerPojo()

ElsaSerializerPojo

public ElsaSerializerPojo(ClassLoader classLoader,
 int objectStackType,
 Object[] singletons,
 Map<Class,ElsaSerializerBase.Serializer> userSer,
 Map<Class,Integer> userSerHeaders,
 Map<Integer,ElsaSerializerBase.Deserializer> userDeser,
 ElsaClassCallback missingClassNotification,
 ElsaClassInfoResolver classInfoResolver)

Method Details

classInfoSerialize

public void classInfoSerialize(DataOutput out,
 ElsaSerializerPojo.ClassInfo ci)
                        throws IOException

Throws:

IOException

classInfoDeserialize

public ElsaSerializerPojo.ClassInfo classInfoDeserialize(DataInput in)
                                                  throws IOException

Throws:

IOException

classForName

protected static Class classForName(String className,
 ClassLoader loader)

getClassInfo

protected ElsaSerializerPojo.ClassInfo getClassInfo(int classId)

notifyMissingClassInfo

protected void notifyMissingClassInfo(Class className)

makeClassInfo

public static ElsaSerializerPojo.ClassInfo makeClassInfo(Class clazz,
 ClassLoader classLoader)

makeClassInfo2

protected static ElsaSerializerPojo.ClassInfo makeClassInfo2(Class clazz,
 ClassLoader classLoader)

useJavaSerialization

protected static boolean useJavaSerialization(Class<?> clazz)

if class uses 'Java Serialization' trick such as `Externalizable`, `writeObject`, `writeReplace`... Elsa will use ObjectOutputStream to serialize it.

Parameters:

clazz - class to be checked for serializatio tricks

Returns:

true if Java Serialization should be used to serialize it

fieldsForClass

protected ObjectStreamField[] fieldsForClass(Class<?> clazz)

makeFieldsForClass

private static ObjectStreamField[] makeFieldsForClass(Class<?> clazz)

isSerializable

public boolean isSerializable(Object o)

Description copied from class: ElsaSerializerBase

Checks if given object is known to Elsa. If false is returned, Elsa will use less efficient field serializer.

Overrides:

isSerializable in class ElsaSerializerBase

Parameters:

o - object to be checked

Returns:

true if mapdb knows howto serialize given object

assertClassSerializable

protected void assertClassSerializable(Class<?> clazz)
                                throws NotSerializableException,
InvalidClassException

Throws:

NotSerializableException

InvalidClassException

getFieldValue

public Object getFieldValue(ElsaSerializerPojo.FieldInfo fieldInfo,
 Object object)

setFieldValue

public void setFieldValue(ElsaSerializerPojo.FieldInfo fieldInfo,
 Object object,
 Object value)

classToId

public int classToId(String className)

serializeUnknownObject

protected void serializeUnknownObject(DataOutput out,
 Object obj,
 ElsaStack objectStack)
                               throws IOException

Description copied from class: ElsaSerializerBase

override this method to extend ElsaSerializerBase functionality

Overrides:

serializeUnknownObject in class ElsaSerializerBase

Parameters:

out - put binary data here

obj - object to be serialized

objectStack - objectStack for handling backward references

Throws:

IOException - an exception from underlying stream

deserializeUnknownHeader

protected Object deserializeUnknownHeader(DataInput in,
 int head,
 ElsaStack objectStack)
                                   throws IOException

Description copied from class: ElsaSerializerBase

override this method to extend ElsaSerializerBase functionality

Overrides:

deserializeUnknownHeader in class ElsaSerializerBase

Parameters:

in - read binary data from here

head - binary header read from input stream

objectStack - objectStack for handling backward references

Returns:

deserialized object

Throws:

IOException - an exception from underlying stream

wrapStream

private InputStream wrapStream(DataInput in)
                        throws IOException

Throws:

IOException

loadClassStaticUnchecked

private static Class loadClassStaticUnchecked(String name,
 ClassLoader classLoader)

createInstanceSkippinkConstructor

protected <T> T createInstanceSkippinkConstructor(Class<T> clazz)

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

Type Parameters:

T - type of object

Parameters:

clazz - class of object

Returns:

instantiated object