org.hibernate.util

Class SerializationHelper

java.lang.Object

org.hibernate.util.SerializationHelper

public final class SerializationHelper
extends java.lang.Object

Assists with the serialization process and performs additional functionality based on serialization.

• Deep clone using serialization
• Serialize managing finally and IOException
• Deserialize managing finally and IOException

This class throws exceptions for invalid null inputs. Each method documents its behaviour in more detail.

Since:

1.0

Version:

$Id: SerializationHelper.java 9180 2006-01-30 23:51:27Z steveebersole $

Author:

Nissim Karpenstein, Janek Bogucki, Daniel Rall, Stephen Colebourne, Jeff Varszegi, Gary Gregory

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.Object	clone(java.io.Serializable object) Deep clone an Object using serialization.
static java.lang.ClassLoader	defaultClassLoader() Returns the Thread Context ClassLoader (TCCL).
static java.lang.Object	deserialize(byte[] objectData) Deserializes an object from an array of bytes using the Thread Context ClassLoader (TCCL).
static java.lang.Object	deserialize(byte[] objectData, java.lang.ClassLoader loader) Deserializes an object from an array of bytes.
static java.lang.Object	deserialize(java.io.InputStream inputStream) Deserializes an object from the specified stream using the Thread Context ClassLoader (TCCL).
static java.lang.Object	deserialize(java.io.InputStream inputStream, java.lang.ClassLoader loader) Deserializes an object from the specified stream using the Thread Context ClassLoader (TCCL).
static java.lang.Object	doDeserialize(java.io.InputStream inputStream, java.lang.ClassLoader loader, java.lang.ClassLoader fallbackLoader1, java.lang.ClassLoader fallbackLoader2)
static java.lang.ClassLoader	hibernateClassLoader()
static byte[]	serialize(java.io.Serializable obj) Serializes an Object to a byte array for storage/serialization.
static void	serialize(java.io.Serializable obj, java.io.OutputStream outputStream) Serializes an Object to the specified stream.

Methods inherited from class java.lang.Object

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

Method Detail

clone

public static java.lang.Object clone(java.io.Serializable object)
                              throws SerializationException

Deep clone an Object using serialization.

This is many times slower than writing clone methods by hand on all objects in your object graph. However, for complex object graphs, or for those that don't support deep cloning this can be a simple alternative implementation. Of course all the objects must be Serializable.

Parameters:

object - the Serializable object to clone

Returns:

the cloned object

Throws:

SerializationException - (runtime) if the serialization fails

serialize

public static void serialize(java.io.Serializable obj,
             java.io.OutputStream outputStream)
                      throws SerializationException

Serializes an Object to the specified stream.

The stream will be closed once the object is written. This avoids the need for a finally clause, and maybe also exception handling, in the application code.

The stream passed in is not buffered internally within this method. This is the responsibility of your application if desired.

Parameters:

obj - the object to serialize to bytes, may be null

outputStream - the stream to write to, must not be null

Throws:

java.lang.IllegalArgumentException - if outputStream is null

SerializationException - (runtime) if the serialization fails

serialize

public static byte[] serialize(java.io.Serializable obj)
                        throws SerializationException

Serializes an Object to a byte array for storage/serialization.

Parameters:

obj - the object to serialize to bytes

Returns:

a byte[] with the converted Serializable

Throws:

SerializationException - (runtime) if the serialization fails

deserialize

public static java.lang.Object deserialize(java.io.InputStream inputStream)
                                    throws SerializationException

Deserializes an object from the specified stream using the Thread Context ClassLoader (TCCL).

Delegates to doDeserialize(java.io.InputStream, java.lang.ClassLoader, java.lang.ClassLoader, java.lang.ClassLoader)

Parameters:

inputStream - the serialized object input stream, must not be null

Returns:

the deserialized object

Throws:

java.lang.IllegalArgumentException - if inputStream is null

SerializationException - (runtime) if the serialization fails

defaultClassLoader

public static java.lang.ClassLoader defaultClassLoader()

Returns the Thread Context ClassLoader (TCCL).

Returns:

The current TCCL

hibernateClassLoader

public static java.lang.ClassLoader hibernateClassLoader()

deserialize

public static java.lang.Object deserialize(java.io.InputStream inputStream,
                           java.lang.ClassLoader loader)
                                    throws SerializationException

Deserializes an object from the specified stream using the Thread Context ClassLoader (TCCL). If there is no TCCL set, the classloader of the calling class is used.

The stream will be closed once the object is read. This avoids the need for a finally clause, and maybe also exception handling, in the application code.

The stream passed in is not buffered internally within this method. This is the responsibility of the caller, if desired.

Parameters:

inputStream - the serialized object input stream, must not be null

loader - The classloader to use

Returns:

the deserialized object

Throws:

java.lang.IllegalArgumentException - if inputStream is null

SerializationException - (runtime) if the serialization fails

doDeserialize

public static java.lang.Object doDeserialize(java.io.InputStream inputStream,
                             java.lang.ClassLoader loader,
                             java.lang.ClassLoader fallbackLoader1,
                             java.lang.ClassLoader fallbackLoader2)
                                      throws SerializationException

Throws:

SerializationException

deserialize

public static java.lang.Object deserialize(byte[] objectData)
                                    throws SerializationException

Deserializes an object from an array of bytes using the Thread Context ClassLoader (TCCL). If there is no TCCL set, the classloader of the calling class is used.

Delegates to deserialize(byte[], ClassLoader)

Parameters:

objectData - the serialized object, must not be null

Returns:

the deserialized object

Throws:

java.lang.IllegalArgumentException - if objectData is null

SerializationException - (runtime) if the serialization fails

deserialize

public static java.lang.Object deserialize(byte[] objectData,
                           java.lang.ClassLoader loader)
                                    throws SerializationException

Deserializes an object from an array of bytes.

Delegates to deserialize(java.io.InputStream, ClassLoader) using a ByteArrayInputStream to wrap the array.

Parameters:

objectData - the serialized object, must not be null

loader - The classloader to use

Returns:

the deserialized object

Throws:

java.lang.IllegalArgumentException - if objectData is null

SerializationException - (runtime) if the serialization fails