org.josef.util

Class Serializer

java.lang.Object

org.josef.util.Serializer

@Status(stage=DEVELOPMENT,
        unitTests=COMPLETE)
 @Review(by="Kees Schotanus",
        at="2009-11-20",
        reason="Initial review")
public final class Serializer
extends Object

Utility class to perform serialization.

Version:

1.0 $Revision: 5775 $

Author:

Kees Schotanus

Method Summary

Modifier and Type	Method and Description
static Object	deserializeFromObject(File file) Deserializes an object, previously serialized by serializeAsObject(Serializable, File).
static Object	deserializeFromObject(InputStream inputStream) Deserializes an object, previously serialized by serializeAsObject(Serializable, OutputStream).
static Object	deserializeFromXml(File file) Deserializes an object, previously serialized by serializeAsXml(Object, OutputStream).
static Object	deserializeFromXml(InputStream inputStream) Deserializes an object, previously serialized by serializeAsXml(Object, OutputStream).
static void	serializeAsObject(Serializable serializable, File file) Serializes the supplied object to the supplied file, in standard Java serialization (object) format.
static void	serializeAsObject(Serializable serializable, OutputStream outputStream) Serializes the supplied object to the supplied outputStream, in standard Java serialization (object) format.
static void	serializeAsXml(Object object, File file) Serializes the supplied object to the supplied file, in XML format.
static void	serializeAsXml(Object object, OutputStream outputStream) Serializes the supplied object to the supplied outputStream, in XML format.

Methods inherited from class java.lang.Object

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

Method Detail

serializeAsObject

public static void serializeAsObject(Serializable serializable,
                                     File file)
                              throws IOException

Serializes the supplied object to the supplied file, in standard Java serialization (object) format.

Parameters:

serializable - The Object to serialize.

file - The File to serialize to.

Throws:

IOException - When the supplied serializable could not be serialized.

NullPointerException - When either the supplied serializable or file is null.

deserializeFromObject

public static Object deserializeFromObject(File file)
                                    throws ClassNotFoundException,
                                           IOException

Deserializes an object, previously serialized by serializeAsObject(Serializable, File).

Parameters:

file - The File to deserialize from.

Returns:

The deserialized Object.

Throws:

ClassNotFoundException - When the Class of the serialized Object could not be found.

IOException - When the Object could not be deserialized.

NullPointerException - When the supplied file is null.

serializeAsObject

public static void serializeAsObject(Serializable serializable,
                                     OutputStream outputStream)
                              throws IOException

Serializes the supplied object to the supplied outputStream, in standard Java serialization (object) format.

Parameters:

serializable - The Object to serialize.

outputStream - The output stream to serialize to.

Throws:

IOException - When the supplied serializable could not be serialized.

NullPointerException - When either the supplied serializable or outputStream is null.

deserializeFromObject

public static Object deserializeFromObject(InputStream inputStream)
                                    throws ClassNotFoundException,
                                           IOException

Deserializes an object, previously serialized by serializeAsObject(Serializable, OutputStream).

Parameters:

inputStream - The input stream to deserialize from.

Returns:

The deserialized Object.

Throws:

ClassNotFoundException - When the Class of the serialized Object could not be found.

IOException - When the Object could not be deserialized.

NullPointerException - When the supplied inputStream is null.

serializeAsXml

public static void serializeAsXml(Object object,
                                  File file)
                           throws IOException

Serializes the supplied object to the supplied file, in XML format.

Parameters:

object - The Object to serialize.

file - The file to serialize to.

Throws:

IOException - When the supplied object could not be serialized.

NullPointerException - When either the supplied object or file is null.

deserializeFromXml

public static Object deserializeFromXml(File file)
                                 throws IOException

Deserializes an object, previously serialized by serializeAsXml(Object, OutputStream).

Parameters:

file - The File to deserialize from.

Returns:

The deserialized Object.

Throws:

IOException - When the supplied serializable could not be serialized.

NullPointerException - When the supplied file is null.

serializeAsXml

public static void serializeAsXml(Object object,
                                  OutputStream outputStream)

Serializes the supplied object to the supplied outputStream, in XML format.

Parameters:

object - The Object to serialize.

outputStream - The output stream to serialize to.

Throws:

NullPointerException - When either the supplied object or outputStream is null.

deserializeFromXml

public static Object deserializeFromXml(InputStream inputStream)

Deserializes an object, previously serialized by serializeAsXml(Object, OutputStream).

Parameters:

inputStream - The input stream to deserialize from.

Returns:

The deserialized Object.

Throws:

NullPointerException - When the supplied inputStream is null.