io.appulse.utils

Class SerializationUtils

java.lang.Object

io.appulse.utils.SerializationUtils

public final class SerializationUtils
extends Object

Different serialization helpers.

Since:

1.8.0

Author:

Artem Labazin

Method Summary

Modifier and Type	Method and Description
static <T> T	deserialize(@NonNull byte[] objectData) Deserializes a single Object from an array of bytes.
static <T> T	deserialize(@NonNull InputStream inputStream) Deserializes an Object from the specified stream.
static byte[]	serialize(Serializable obj) Serializes an Object to a byte array for storage/serialization.
static void	serialize(Serializable object, @NonNull 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

serialize

public static void serialize(Serializable object,
                             @NonNull
                             @NonNull OutputStream outputStream)

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:

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

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

Throws:

NullPointerException - if outputStream is null

SerializationException - (runtime) if the serialization fails

Since:

1.8.0

serialize

public static byte[] serialize(Serializable obj)

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

Since:

1.8.0

deserialize

public static <T> T deserialize(@NonNull
                                @NonNull InputStream inputStream)

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.

If the call site incorrectly types the return value, a ClassCastException is thrown from the call site. Without Generics in this declaration, the call site must type cast and can cause the same ClassCastException. Note that in both cases, the ClassCastException is in the call site, not in this method.

Type Parameters:

T - the object type to be deserialized

Parameters:

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

Returns:

the deserialized object

Throws:

NullPointerException - if inputStream is null

SerializationException - (runtime) if the serialization fails

Since:

1.8.0

deserialize

public static <T> T deserialize(@NonNull
                                @NonNull byte[] objectData)

Deserializes a single Object from an array of bytes.

If the call site incorrectly types the return value, a ClassCastException is thrown from the call site. Without Generics in this declaration, the call site must type cast and can cause the same ClassCastException. Note that in both cases, the ClassCastException is in the call site, not in this method.

Type Parameters:

T - the object type to be deserialized

Parameters:

objectData - the serialized object, must not be null

Returns:

the deserialized object

Throws:

NullPointerException - if objectData is null

SerializationException - (runtime) if the serialization fails

Since:

1.8.0