com.opencloud.util

Class FastSerialize

java.lang.Object

com.opencloud.util.FastSerialize

public class FastSerialize
extends java.lang.Object

Provides a framework for generating code that uses the FastSerializable interface to serialize and deserialize state.

See FastSerializable for caveats on using this approach.

Constructor Summary

Constructors

Constructor and Description
FastSerialize()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.Object	fastDeserialize(byte[] data) Deserialize an object from a byte array using a custom FastSerializable approach.
static java.lang.Object	fastDeserialize(byte[] data, java.lang.ClassLoader cl) Deserialize an object from a byte array using a custom FastSerializable approach.
static java.lang.Object	fastDeserialize(byte[] data, int offset, int length) Deserialize an object from a byte array using a custom FastSerializable approach.
static java.lang.Object	fastDeserialize(byte[] data, int offset, int length, java.lang.ClassLoader cl) Deserialize an object from a byte array using a custom FastSerializable approach.
static byte[]	fastSerialize(java.lang.Object obj) Serialize an object to a byte array using a custom FastSerializable approach.
static java.lang.Object	fromStream(java.io.DataInput in) Deserialize an object using a custom FastSerializable approach to a stream.
static java.lang.Object	fromStream(java.io.DataInput in, java.lang.ClassLoader cl) Deserialize an object using a custom FastSerializable approach to a stream.
static java.lang.String	getDeserializeFragment(java.lang.Class type, java.lang.String source, java.lang.String dest) Generate a code fragment that deserializes an expression from a byte array.
static java.lang.String	getDeserializeFragment(java.lang.Class type, java.lang.String source, java.lang.String dest, java.lang.String clExpr) Generate a code fragment that deserializes an expression from a byte array.
static java.lang.String	getFromStreamFragment(java.lang.Class type, java.lang.String dest, java.lang.String stream) Generate a code fragment that deserializes an expression from a stream.
static java.lang.String	getFromStreamFragment(java.lang.Class type, java.lang.String dest, java.lang.String stream, java.lang.String clExpr) Generate a code fragment that deserializes an expression from a stream.
static java.lang.String	getSerializeFragment(java.lang.Class type, java.lang.String source, java.lang.String dest) Generate a code fragment that serializes an expression to a byte array.
static java.lang.String	getToStreamFragment(java.lang.Class type, java.lang.String source, java.lang.String stream) Generate a code fragment that serializes an expression to a stream.
static boolean	isSupported(java.lang.Class type) Check if a given type can be directly handled by getDeserializeFragment(java.lang.Class, java.lang.String, java.lang.String) etc.
static ProfileID	readProfileID(java.io.DataInput in, java.lang.ClassLoader cl)
static java.lang.String	readString(java.io.DataInput inStream)
static java.lang.Object	standardDeserialize(byte[] byteArray) Deserialize an object from a byte array using the standard Serializable approach.
static java.lang.Object	standardDeserialize(byte[] byteArray, java.lang.ClassLoader classLoader) Deserialize an object from a byte array using the standard Serializable approach.
static java.lang.Object	standardDeserialize(byte[] byteArray, int offset, int length) Deserialize an object from a byte array using the standard Serializable approach.
static java.lang.Object	standardDeserialize(byte[] byteArray, int offset, int length, java.lang.ClassLoader classLoader) Deserialize an object from a byte array using the standard Serializable approach.
static byte[]	standardSerialize(java.lang.Object toSerialize) Serialize an object to a byte array using the standard Serializable approach.
static void	toStream(java.lang.Object obj, java.io.DataOutput out) Serialize an object using a custom FastSerializable approach to a stream.
static void	writeProfileID(java.io.DataOutput out, ProfileID profileID)
static void	writeString(java.lang.String value, java.io.DataOutput outStream)

Methods inherited from class java.lang.Object

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

Constructor Detail

FastSerialize

public FastSerialize()

Method Detail

getToStreamFragment

public static java.lang.String getToStreamFragment(java.lang.Class type,
                                   java.lang.String source,
                                   java.lang.String stream)

Generate a code fragment that serializes an expression to a stream. The framework attempts to determine the best way to do this based on the type of the expression:

• primitive types are stored directly;
• objects implementing FastSerializable are stored using that interface
• byte arrays are stored directly, preceded by a length
• other primitive arrays are stored as a length followed by the values themselves
• arrays of (arrays of ...) FastSerializable objects are stored as a length followed by the components of the array itself
• all other objects are serialized via an ObjectOutputStream, and the resulting byte array stored (this can be slow)

Parameters:

type - the type of the expression to be serialized

source - an expression evaluating to the value to serialize

stream - an expression evaluating to the stream to serialize to. This should be a java.io.DataOutput object.

Returns:

a code fragment performing the serialization

getFromStreamFragment

public static java.lang.String getFromStreamFragment(java.lang.Class type,
                                     java.lang.String dest,
                                     java.lang.String stream)

Generate a code fragment that deserializes an expression from a stream. This assumes the data was serialized by code generated from getToStreamFragment(java.lang.Class, java.lang.String, java.lang.String). The thread context classloader (at the time of execution of the generated fragment!) is used for deserialization.

Parameters:

type - the type of the expression to be deserialized

dest - a lvalue to assign the deserialized value to

stream - an expression evaluating to the stream to deserialize from. This should be a java.io.DataInput object.

Returns:

a code fragment performing the deserialization

getFromStreamFragment

public static java.lang.String getFromStreamFragment(java.lang.Class type,
                                     java.lang.String dest,
                                     java.lang.String stream,
                                     java.lang.String clExpr)

Generate a code fragment that deserializes an expression from a stream. This assumes the data was serialized by code generated from getToStreamFragment(java.lang.Class, java.lang.String, java.lang.String).

Parameters:

type - the type of the expression to be deserialized

dest - a lvalue to assign the deserialized value to

stream - an expression evaluating to the stream to deserialize from. This should be a java.io.DataInput object.

clExpr - a classloader expression fragment to use as the deserialization classloader

Returns:

a code fragment performing the deserialization

getSerializeFragment

public static java.lang.String getSerializeFragment(java.lang.Class type,
                                    java.lang.String source,
                                    java.lang.String dest)

Generate a code fragment that serializes an expression to a byte array. This uses getToStreamFragment() and handles the construction of a ByteArrayOutputStream.

Parameters:

type - the type of the expression to be deserialized

source - an expression evaluating to the value to serialize

dest - a lvalue to assign the resulting bytearray to

Returns:

a code fragment performing the serialization

getDeserializeFragment

public static java.lang.String getDeserializeFragment(java.lang.Class type,
                                      java.lang.String source,
                                      java.lang.String dest)

Generate a code fragment that deserializes an expression from a byte array. This uses getFromStreamFragment() and handles the construction of a ByteArrayInputStream. The thread context classloader (at the time of execution of the generated fragment!) is used for deserialization.

Parameters:

type - the type of the expression to be deserialized

source - an expression evaluating to the byte array to deserialize from

dest - a lvalue to assign the deserialized value to

Returns:

a code fragment performing the deserialization

getDeserializeFragment

public static java.lang.String getDeserializeFragment(java.lang.Class type,
                                      java.lang.String source,
                                      java.lang.String dest,
                                      java.lang.String clExpr)

Generate a code fragment that deserializes an expression from a byte array. This uses getFromStreamFragment() and handles the construction of a ByteArrayInputStream.

Parameters:

type - the type of the expression to be deserialized

source - an expression evaluating to the byte array to deserialize from

dest - a lvalue to assign the deserialized value to

clExpr - a classloader expression fragment to use as the deserialization classloader

Returns:

a code fragment performing the deserialization

isSupported

public static boolean isSupported(java.lang.Class type)

Check if a given type can be directly handled by getDeserializeFragment(java.lang.Class, java.lang.String, java.lang.String) etc.

Parameters:

type - the type to check.

Returns:

true if type will be directly handled; false if it will use standard serialization

readString

public static final java.lang.String readString(java.io.DataInput inStream)
                                         throws java.io.IOException

Throws:

java.io.IOException

writeString

public static final void writeString(java.lang.String value,
               java.io.DataOutput outStream)
                              throws java.io.IOException

Throws:

java.io.IOException

standardSerialize

public static byte[] standardSerialize(java.lang.Object toSerialize)
                                throws java.io.IOException

Serialize an object to a byte array using the standard Serializable approach. Not a code generator!

Parameters:

toSerialize - the object to serialize

Returns:

the serialized form of the object

Throws:

java.io.IOException - if serialization failed

standardDeserialize

public static java.lang.Object standardDeserialize(byte[] byteArray)
                                            throws java.io.IOException

Deserialize an object from a byte array using the standard Serializable approach. Uses the current threads context class loader. Not a code generator!

Parameters:

byteArray - the serialized data to deserialize

Returns:

the deserialized object

Throws:

java.io.IOException - if deserialization failed

standardDeserialize

public static java.lang.Object standardDeserialize(byte[] byteArray,
                                   java.lang.ClassLoader classLoader)
                                            throws java.io.IOException

Deserialize an object from a byte array using the standard Serializable approach. Not a code generator!

Parameters:

byteArray - the serialized data to deserialize

classLoader - the class loader to be used during deserialisation

Returns:

the deserialized object

Throws:

java.io.IOException - if deserialization failed

standardDeserialize

public static java.lang.Object standardDeserialize(byte[] byteArray,
                                   int offset,
                                   int length)
                                            throws java.io.IOException

Deserialize an object from a byte array using the standard Serializable approach. Uses the current threads context class loader. Not a code generator!

Parameters:

byteArray - the serialized data to deserialize

offset - the offset within byteArray of the data

length - the length of data within byteArray

Returns:

the deserialized object

Throws:

java.io.IOException - if deserialization failed

standardDeserialize

public static java.lang.Object standardDeserialize(byte[] byteArray,
                                   int offset,
                                   int length,
                                   java.lang.ClassLoader classLoader)
                                            throws java.io.IOException

Deserialize an object from a byte array using the standard Serializable approach. Not a code generator!

Parameters:

byteArray - the serialized data to deserialize

offset - the offset within byteArray of the data

length - the length of data within byteArray

classLoader - the class loader to be used during deserialisation

Returns:

the deserialized object

Throws:

java.io.IOException - if deserialization failed

fastSerialize

public static byte[] fastSerialize(java.lang.Object obj)
                            throws java.io.IOException

Serialize an object to a byte array using a custom FastSerializable approach. Not a code generator! The resulting data should be deserialized via fastDeserialize(byte[])

Parameters:

obj - the object to serialize

Returns:

a byte array containing the serialized data

Throws:

java.io.IOException - if serialization failed

fastDeserialize

public static java.lang.Object fastDeserialize(byte[] data)
                                        throws java.io.IOException

Deserialize an object from a byte array using a custom FastSerializable approach. Not a code generator!

Parameters:

data - the serialized data (from fastSerialize(java.lang.Object)) to deserialize

Returns:

the deserialized object

Throws:

java.io.IOException - if deserialization failed

fastDeserialize

public static java.lang.Object fastDeserialize(byte[] data,
                               int offset,
                               int length)
                                        throws java.io.IOException

Deserialize an object from a byte array using a custom FastSerializable approach. Not a code generator!

Parameters:

data - the serialized data (from fastSerialize(java.lang.Object)) to deserialize

offset - the offset within byteArray of the data

length - the length of data within byteArray

Returns:

the deserialized object

Throws:

java.io.IOException - if deserialization failed

fastDeserialize

public static java.lang.Object fastDeserialize(byte[] data,
                               java.lang.ClassLoader cl)
                                        throws java.io.IOException

Deserialize an object from a byte array using a custom FastSerializable approach. Not a code generator!

Parameters:

data - the serialized data (from fastSerialize(java.lang.Object)) to deserialize

Returns:

the deserialized object

Throws:

java.io.IOException - if deserialization failed

fastDeserialize

public static java.lang.Object fastDeserialize(byte[] data,
                               int offset,
                               int length,
                               java.lang.ClassLoader cl)
                                        throws java.io.IOException

Deserialize an object from a byte array using a custom FastSerializable approach. Not a code generator!

Parameters:

data - the serialized data (from fastSerialize(java.lang.Object)) to deserialize

offset - the offset within byteArray of the data

length - the length of data within byteArray

Returns:

the deserialized object

Throws:

java.io.IOException - if deserialization failed

toStream

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

Serialize an object using a custom FastSerializable approach to a stream. Not a code generator! The resulting stream may be deserialized via fromStream(java.io.DataInput).

Parameters:

obj - the object to serialize

out - the stream to serialize to

Throws:

java.io.IOException - if serialization fails

fromStream

public static java.lang.Object fromStream(java.io.DataInput in)
                                   throws java.io.IOException

Deserialize an object using a custom FastSerializable approach to a stream. Not a code generator! The stream data should have been generated by toStream(java.lang.Object, java.io.DataOutput). The thread context classloader is used for deserialization.

Parameters:

in - the stream to deserialize

Returns:

the deserialized object

Throws:

java.io.IOException - if deserialization fails

fromStream

public static java.lang.Object fromStream(java.io.DataInput in,
                          java.lang.ClassLoader cl)
                                   throws java.io.IOException

Deserialize an object using a custom FastSerializable approach to a stream. Not a code generator! The stream data should have been generated by toStream(java.lang.Object, java.io.DataOutput).

Parameters:

in - the stream to deserialize

cl - the classloader to use for deserialization

Returns:

the deserialized object

Throws:

java.io.IOException - if deserialization fails

readProfileID

public static ProfileID readProfileID(java.io.DataInput in,
                      java.lang.ClassLoader cl)
                               throws java.io.IOException

Throws:

java.io.IOException

writeProfileID

public static void writeProfileID(java.io.DataOutput out,
                  ProfileID profileID)
                           throws java.io.IOException

Throws:

java.io.IOException