Package org.mapdb.elsa

Class ElsaSerializerBase

java.lang.Object

org.mapdb.elsa.ElsaSerializerBase

All Implemented Interfaces:

ElsaSerializer

Direct Known Subclasses:

ElsaSerializerPojo

public class ElsaSerializerBase
extends Object
implements ElsaSerializer

Basic Elsa serializer and deserializer. It recognizes some 'java.lang.*' and 'java.util.*' classes such as Long, String, HashMap...

This serializer does not analyze class structure and fields. This functionality is in ElsaSerializerPojo Internally it uses Map<Class,Serializer> to decide what way to serialize class and Map<HeaderByte, Deserializer> to deserialize data.

If this serializer finds unknown class at graph traversal, it will pass it to serializeUnknownObject(DataOutput, Object, ElsaStack) function for serialization. By default this throws an NotSerializableException. But this method can be overridden in subclasses to add extra functionality(ElsaSerializerPojo is subclass).

If this deserializer finds unknown Header Byte (binary data type), it will pass it to deserializeUnknownHeader(DataInput, int, ElsaStack) function for deserialization. By default this throws an IOException. But this method can be overridden in subclasses to add extra functionality(ElsaSerializerPojo is subclass).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ElsaSerializerBase.Deserializer<A>	Interface internally used by Elsa to deserialize concrete Header Byte.
protected static final class	ElsaSerializerBase.DeserInt
protected static final class	ElsaSerializerBase.DeserLong
protected final class	ElsaSerializerBase.DeserSingleton	always returns single object without reading anything
protected static final class	ElsaSerializerBase.DeserStringLen
protected static interface	ElsaSerializerBase.Header	Header byte, is used at start of each record to indicate data type WARNING !!! values bellow must be unique !!!!!
static class	ElsaSerializerBase.Serializer<A>	Interface internally used by Elsa to serialize concrete single class.
protected static final class	ElsaSerializerBase.UserSerializer	User Serializers have designated Header Byte, followed by packed Int which identifies User Serializer.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,Class>	classCache
protected final ClassLoader	classLoader
protected static final ElsaSerializerBase.Deserializer<byte[]>	DESER_BYTE_ARRAY
protected final ElsaSerializerBase.Deserializer[]	headerDeser
protected final int	objectStackType
protected final Map<Class,ElsaSerializerBase.Serializer>	ser
protected static final ElsaSerializerBase.Serializer	SER_BOOLEAN
protected static final ElsaSerializerBase.Serializer	SER_BYTE
protected static final ElsaSerializerBase.Serializer<byte[]>	SER_BYTE_ARRAY
protected static final ElsaSerializerBase.Serializer	SER_CHAR
protected static final ElsaSerializerBase.Serializer	SER_DOUBLE
protected static final ElsaSerializerBase.Serializer	SER_FLOAT
protected static final ElsaSerializerBase.Serializer	SER_INT
protected static final ElsaSerializerBase.Serializer	SER_INT_ARRAY
protected static final ElsaSerializerBase.Serializer	SER_LONG
protected static final ElsaSerializerBase.Serializer	SER_LONG_ARRAY
protected static final ElsaSerializerBase.Serializer	SER_SHORT
protected static final ElsaSerializerBase.Serializer	SER_STRING
protected final Object[]	singletons
protected final IdentityHashMap<Object,Integer>	singletonsReverse
protected final ElsaSerializerBase.Deserializer[]	userDeser

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
<E> E	clone(E value)	Deep binary clone.
protected static ClassLoader	defaultClassLoaderIfNull(ClassLoader classLoader)
<E> E	deserialize(DataInput input)	Reads binary data from input and converts them into object instances.
Object	deserialize(DataInput in, ElsaStack objectStack)
private ArrayList<Object>	deserializeArrayList(DataInput is, ElsaStack objectStack)
private Object[]	deserializeArrayObject(DataInput is, ElsaStack objectStack)
private HashMap<Object,Object>	deserializeHashMap(DataInput is, ElsaStack objectStack)
private HashSet<Object>	deserializeHashSet(DataInput is, ElsaStack objectStack)
private LinkedHashMap<Object,Object>	deserializeLinkedHashMap(DataInput is, ElsaStack objectStack)
private LinkedHashSet<Object>	deserializeLinkedHashSet(DataInput is, ElsaStack objectStack)
private LinkedList	deserializeLinkedList(DataInput is, ElsaStack objectStack)
private Properties	deserializeProperties(DataInput is, ElsaStack objectStack)
protected Object	deserializeSingleton(DataInput is, ElsaStack objectStack)
(package private) static String	deserializeString(DataInput buf, int len)
private TreeMap<Object,Object>	deserializeTreeMap(DataInput is, ElsaStack objectStack)
private TreeSet<Object>	deserializeTreeSet(DataInput is, ElsaStack objectStack)
protected Object	deserializeUnknownHeader(DataInput is, int head, ElsaStack objectStack)	override this method to extend ElsaSerializerBase functionality
protected void	initHeaderDeser()
protected void	initSer()
boolean	isSerializable(Object o)	Checks if given object is known to Elsa.
protected Class<?>	loadClassCached(String name)
protected Class<?>	loadClassCached(String name, ClassLoader classLoader)
protected Class	loadClassCachedUnchecked(String name)
protected ElsaStack	newElsaStack()
protected static boolean[]	readBooleanArray(int numBools, DataInput is)	Unpacks boolean[], each value in array is represented by single bite
void	serialize(DataOutput output, Object obj)	Converts object instance into binary form
void	serialize(DataOutput out, Object obj, ElsaStack objectStack)
protected void	serializeClass(DataOutput out, Class clazz)
private void	serializeCollection(int header, DataOutput out, Object obj, ElsaStack objectStack)
private void	serializeMap(int header, DataOutput out, Object obj, ElsaStack objectStack)
void	serializeObjectArray(DataOutput out, Object[] b, ElsaStack objectStack)
protected void	serializeUnknownObject(DataOutput out, Object obj, ElsaStack objectStack)	override this method to extend ElsaSerializerBase functionality
protected static void	writeBooleanArray(DataOutput out, boolean[] bool)	Writes boolean[] into output, each value in array is represented by single byte

Methods inherited from class java.lang.Object

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

Field Details

objectStackType

protected final int objectStackType

singletons

protected final Object[] singletons

singletonsReverse

protected final IdentityHashMap<Object,Integer> singletonsReverse

ser

protected final Map<Class,ElsaSerializerBase.Serializer> ser

classCache

protected final Map<String,Class> classCache

headerDeser

protected final ElsaSerializerBase.Deserializer[] headerDeser

userDeser

protected final ElsaSerializerBase.Deserializer[] userDeser

classLoader

protected final ClassLoader classLoader

SER_STRING

protected static final ElsaSerializerBase.Serializer SER_STRING

SER_LONG_ARRAY

protected static final ElsaSerializerBase.Serializer SER_LONG_ARRAY

SER_INT_ARRAY

protected static final ElsaSerializerBase.Serializer SER_INT_ARRAY

SER_DOUBLE

protected static final ElsaSerializerBase.Serializer SER_DOUBLE

SER_FLOAT

protected static final ElsaSerializerBase.Serializer SER_FLOAT

SER_SHORT

protected static final ElsaSerializerBase.Serializer SER_SHORT

SER_CHAR

protected static final ElsaSerializerBase.Serializer SER_CHAR

SER_BYTE

protected static final ElsaSerializerBase.Serializer SER_BYTE

SER_BOOLEAN

protected static final ElsaSerializerBase.Serializer SER_BOOLEAN

SER_LONG

protected static final ElsaSerializerBase.Serializer SER_LONG

SER_INT

protected static final ElsaSerializerBase.Serializer SER_INT

SER_BYTE_ARRAY

protected static final ElsaSerializerBase.Serializer<byte[]> SER_BYTE_ARRAY

DESER_BYTE_ARRAY

protected static final ElsaSerializerBase.Deserializer<byte[]> DESER_BYTE_ARRAY

Constructor Details

ElsaSerializerBase

public ElsaSerializerBase()

ElsaSerializerBase

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

Method Details

loadClassCached

protected Class<?> loadClassCached(String name)
                            throws ClassNotFoundException

Throws:

ClassNotFoundException

loadClassCached

protected Class<?> loadClassCached(String name,
 ClassLoader classLoader)
                            throws ClassNotFoundException

Throws:

ClassNotFoundException

loadClassCachedUnchecked

protected Class loadClassCachedUnchecked(String name)

defaultClassLoaderIfNull

protected static ClassLoader defaultClassLoaderIfNull(ClassLoader classLoader)

initSer

protected void initSer()

serializeObjectArray

public void serializeObjectArray(DataOutput out,
 Object[] b,
 ElsaStack objectStack)
                          throws IOException

Throws:

IOException

initHeaderDeser

protected void initHeaderDeser()

serialize

public void serialize(DataOutput output,
 Object obj)
               throws IOException

Description copied from interface: ElsaSerializer

Converts object instance into binary form

Specified by:

serialize in interface ElsaSerializer

Parameters:

output - output into which binary data will be written while object is serialized

obj - object instance to be serialized

Throws:

IOException - an exception from underlying stream

newElsaStack

protected ElsaStack newElsaStack()

clone

public <E> E clone(E value)
            throws IOException

Description copied from interface: ElsaSerializer

Deep binary clone. Serialize object into binary form, and then use data to deserialize it. Returned object should be equal to original, but is completely different instance.

Specified by:

clone in interface ElsaSerializer

Type Parameters:

E - type of cloned object

Parameters:

value - object instance to be cloned

Returns:

deep clone

Throws:

IOException - an exception from underlying stream

serialize

public void serialize(DataOutput out,
 Object obj,
 ElsaStack objectStack)
               throws IOException

Throws:

IOException

serializeClass

protected void serializeClass(DataOutput out,
 Class clazz)
                       throws IOException

Throws:

IOException

serializeMap

private void serializeMap(int header,
 DataOutput out,
 Object obj,
 ElsaStack objectStack)
                   throws IOException

Throws:

IOException

serializeCollection

private void serializeCollection(int header,
 DataOutput out,
 Object obj,
 ElsaStack objectStack)
                          throws IOException

Throws:

IOException

deserializeString

static String deserializeString(DataInput buf,
 int len)
                         throws IOException

Throws:

IOException

deserialize

public <E> E deserialize(DataInput input)
                  throws IOException

Description copied from interface: ElsaSerializer

Reads binary data from input and converts them into object instances.

Specified by:

deserialize in interface ElsaSerializer

Type Parameters:

E - type of deserialized object

Parameters:

input - input to read data from

Returns:

deserialized object

Throws:

IOException - an exception from underlying stream

deserialize

public Object deserialize(DataInput in,
 ElsaStack objectStack)
                   throws IOException

Throws:

IOException

deserializeSingleton

protected Object deserializeSingleton(DataInput is,
 ElsaStack objectStack)
                               throws IOException

Throws:

IOException

deserializeArrayObject

private Object[] deserializeArrayObject(DataInput is,
 ElsaStack objectStack)
                                 throws IOException

Throws:

IOException

deserializeArrayList

private ArrayList<Object> deserializeArrayList(DataInput is,
 ElsaStack objectStack)
                                        throws IOException

Throws:

IOException

deserializeLinkedList

private LinkedList deserializeLinkedList(DataInput is,
 ElsaStack objectStack)
                                  throws IOException

Throws:

IOException

deserializeHashSet

private HashSet<Object> deserializeHashSet(DataInput is,
 ElsaStack objectStack)
                                    throws IOException

Throws:

IOException

deserializeLinkedHashSet

private LinkedHashSet<Object> deserializeLinkedHashSet(DataInput is,
 ElsaStack objectStack)
                                                throws IOException

Throws:

IOException

deserializeTreeSet

private TreeSet<Object> deserializeTreeSet(DataInput is,
 ElsaStack objectStack)
                                    throws IOException

Throws:

IOException

deserializeTreeMap

private TreeMap<Object,Object> deserializeTreeMap(DataInput is,
 ElsaStack objectStack)
                                           throws IOException

Throws:

IOException

deserializeHashMap

private HashMap<Object,Object> deserializeHashMap(DataInput is,
 ElsaStack objectStack)
                                           throws IOException

Throws:

IOException

deserializeLinkedHashMap

private LinkedHashMap<Object,Object> deserializeLinkedHashMap(DataInput is,
 ElsaStack objectStack)
                                                       throws IOException

Throws:

IOException

deserializeProperties

private Properties deserializeProperties(DataInput is,
 ElsaStack objectStack)
                                  throws IOException

Throws:

IOException

serializeUnknownObject

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

override this method to extend ElsaSerializerBase functionality

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 is,
 int head,
 ElsaStack objectStack)
                                   throws IOException

override this method to extend ElsaSerializerBase functionality

Parameters:

is - read binary data from here

head - binary header read from input stream

objectStack - objectStack for handling backward references

Returns:

deserialized object

Throws:

ElsaException.UnknownHeaderByte - in default implementation if unknown Header Byte

IOException - an exception from underlying stream

writeBooleanArray

protected static void writeBooleanArray(DataOutput out,
 boolean[] bool)
                                 throws IOException

Writes boolean[] into output, each value in array is represented by single byte

Parameters:

out - write binary data here

bool - The booleans to be writen

Throws:

IOException - an exception from underlying stream

readBooleanArray

protected static boolean[] readBooleanArray(int numBools,
 DataInput is)
                                     throws IOException

Unpacks boolean[], each value in array is represented by single bite

Parameters:

numBools - number of booleans to read

is - read data from here

Returns:

The boolean array decompressed from the bytes read in.

Throws:

IOException - If an error occurred while reading.

isSerializable

public boolean isSerializable(Object o)

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

Parameters:

o - object to be checked

Returns:

true if mapdb knows howto serialize given object