Assists with the serialization process and performs additional functionality based * on serialization.
**
This class throws exceptions for invalid null inputs.
* Each method documents its behaviour in more detail.
SerializationUtils instances should NOT be constructed in standard programming.
* Instead, the class should be used as SerializationUtils.clone(object).
This constructor is public to permit tools that require a JavaBean instance * to operate.
* @since 2.0 */ public SerializationUtils() { super(); } // Clone //----------------------------------------------------------------------- /** *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.
Serializable object to clone
* @return the cloned object
* @throws SerializationException (runtime) if the serialization fails
*/
public static Object clone(Serializable object) {
return deserialize(serialize(object));
}
// Serialize
//-----------------------------------------------------------------------
/**
* 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.
* * @param obj the object to serialize to bytes, may be null * @param outputStream the stream to write to, must not be null * @throws IllegalArgumentException ifoutputStream is null
* @throws SerializationException (runtime) if the serialization fails
*/
public static void serialize(Serializable obj, OutputStream outputStream) {
if (outputStream == null) {
throw new IllegalArgumentException("The OutputStream must not be null");
}
ObjectOutputStream out = null;
try {
// stream closed in the finally
out = new ObjectOutputStream(outputStream);
out.writeObject(obj);
} catch (IOException ex) {
throw new SerializationException(ex);
} finally {
try {
if (out != null) {
out.close();
}
} catch (IOException ex) {
// ignore;
}
}
}
/**
* Serializes an Object to a byte array for
* storage/serialization.
Deserializes an Object from 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.
* * @param inputStream the serialized object input stream, must not be null * @return the deserialized object * @throws IllegalArgumentException ifinputStream is null
* @throws SerializationException (runtime) if the serialization fails
*/
public static Object deserialize(InputStream inputStream) {
if (inputStream == null) {
throw new IllegalArgumentException("The InputStream must not be null");
}
ObjectInputStream in = null;
try {
// stream closed in the finally
in = new ObjectInputStream(inputStream);
return in.readObject();
} catch (ClassNotFoundException ex) {
throw new SerializationException(ex);
} catch (IOException ex) {
throw new SerializationException(ex);
} finally {
try {
if (in != null) {
in.close();
}
} catch (IOException ex) {
// ignore
}
}
}
/**
* Deserializes a single Object from an array of bytes.
objectData is null
* @throws SerializationException (runtime) if the serialization fails
*/
public static Object deserialize(byte[] objectData) {
if (objectData == null) {
throw new IllegalArgumentException("The byte[] must not be null");
}
ByteArrayInputStream bais = new ByteArrayInputStream(objectData);
return deserialize(bais);
}
}