de.cismet.tools

Class Converter

java.lang.Object

de.cismet.tools.Converter

public final class Converter
extends Object

Helper class for various convertion related tasks like (de)serialisation.

Version:

$Revision$, $Date$

Author:

martin.scholl@cismet.de

Method Summary

Modifier and Type	Method and Description
static <T> T	deserialise(byte[] bytes, Class<T> type) Deserialises an object from a byte[] using an ObjectInputStream.
static <T> T	deserialiseFromBase64(byte[] bytes, Class<T> type) Deserialises the given base64 encoded bate[] to the desired Object.
static <T> T	deserialiseFromGzip(byte[] bytes, Class<T> type) DOCUMENT ME!
static <T> T	deserialiseFromString(String s, Class<T> type, boolean compressionEnabled) Creates an Object from an ASCII encoded String.
static byte[]	fromBase64(byte[] bytes) Decodes the given byte[] from base64.
static byte[]	fromString(String bytes) Create a byte[] from the given String.
static byte[]	serialise(Object o) Serialises an object into a byte[] using an ObjectOutputStream.
static byte[]	serialiseToBase64(Object o) Serialises the given Object to a base64 encoded byte[].
static byte[]	serialiseToGzip(Object o) DOCUMENT ME!
static String	serialiseToString(Object o, boolean compressionEnabled) Creates an ASCII encoded String from an Object.
static byte[]	toBase64(byte[] bytes) Encodes the given byte[] to base64.
static String	toString(byte[] bytes) Create a String from a given byte[].

Methods inherited from class java.lang.Object

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

Method Detail

serialise

public static byte[] serialise(Object o)
                        throws IOException

Serialises an object into a byte[] using an ObjectOutputStream.

Parameters:

o - the object to serialise

Returns:

the serialised object in a byte[]

Throws:

IOException - if an error occurs during serialisation

deserialise

public static <T> T deserialise(byte[] bytes,
                                Class<T> type)
                         throws IOException,
                                ClassNotFoundException

Deserialises an object from a byte[] using an ObjectInputStream.

Type Parameters:

T - the type of the resulting Object

Parameters:

bytes - the serialised byte[]

type - the Class of the resulting Object

Returns:

the deserialised object or null if the given byte[] is null

Throws:

IOException - if an error occurs during deserialisation

ClassNotFoundException - if any of the classes of the object cannot be found

serialiseToBase64

public static byte[] serialiseToBase64(Object o)
                                throws IOException

Serialises the given Object to a base64 encoded byte[].

Parameters:

o - the Object to serialise

Returns:

a base64 encoded byte[]

Throws:

IOException - if any error occurs during serialisation

See Also:

toBase64(byte[]), serialise(java.lang.Object)

deserialiseFromBase64

public static <T> T deserialiseFromBase64(byte[] bytes,
                                          Class<T> type)
                                   throws IOException,
                                          ClassNotFoundException

Deserialises the given base64 encoded bate[] to the desired Object.

Type Parameters:

T - the type of the resulting Object

Parameters:

bytes - the serialised base64 encoded byte[]

type - the Class of the resulting Object

Returns:

the deserialised Object or null if the given byte[] is null

Throws:

IOException - if an error occurs during deserialisation

ClassNotFoundException - if any of the classes of the object cannot be found

See Also:

deserialise(byte[], java.lang.Class), fromBase64(byte[])

toBase64

public static byte[] toBase64(byte[] bytes)

Encodes the given byte[] to base64.

Parameters:

bytes - bytes to encode

Returns:

the base64 encoded bytes

See Also:

Base64.encodeBase64(byte[])

fromBase64

public static byte[] fromBase64(byte[] bytes)

Decodes the given byte[] from base64.

Parameters:

bytes - bytes to decode

Returns:

the system encoded bytes or null if the given byte[] is null

See Also:

Base64.decodeBase64(byte[])

toString

public static String toString(byte[] bytes)

Create a String from a given byte[]. The given bytes will be base64 encoded and the resulting String will have ASCII encoding.

Parameters:

bytes - the bytes that shall be represented as String

Returns:

an ASCII encoded String

Throws:

IllegalStateException - if the system does not support ASCII encoding

See Also:

toBase64(byte[])

fromString

public static byte[] fromString(String bytes)

Create a byte[] from the given String. The given String is supposed to be ASCII encoded.

Parameters:

bytes - the String to be converted

Returns:

an system encoded byte[] or null if the given String is null

Throws:

IllegalStateException - if the system does not support ASCII encoding

See Also:

fromBase64(byte[])

serialiseToString

public static String serialiseToString(Object o,
                                       boolean compressionEnabled)
                                throws IOException

Creates an ASCII encoded String from an Object.

Parameters:

o - the object to serialise

compressionEnabled - DOCUMENT ME!

Returns:

the ASCII encoded String representation of an Object

Throws:

IOException - if any error occurs during serialisation

See Also:

toString(byte[]), serialise(java.lang.Object)

deserialiseFromString

public static <T> T deserialiseFromString(String s,
                                          Class<T> type,
                                          boolean compressionEnabled)
                                   throws IOException,
                                          ClassNotFoundException

Creates an Object from an ASCII encoded String.

Type Parameters:

T - the type of the Object to be created

Parameters:

s - the ASCII encoded String representation of an Object

type - the type class fo the Object to be created

compressionEnabled - DOCUMENT ME!

Returns:

the Object create from the ASCII encoded String or null if the given String is null

Throws:

IOException - if any error occurs during deserialisation

ClassNotFoundException - if the desired Class cannot be found

See Also:

deserialise(byte[], java.lang.Class), fromString(java.lang.String)

deserialiseFromGzip

public static <T> T deserialiseFromGzip(byte[] bytes,
                                        Class<T> type)
                                 throws IOException,
                                        ClassNotFoundException

DOCUMENT ME!

Type Parameters:

T - DOCUMENT ME!

Parameters:

bytes - DOCUMENT ME!

type - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

IOException - DOCUMENT ME!

ClassNotFoundException - DOCUMENT ME!

serialiseToGzip

public static byte[] serialiseToGzip(Object o)
                              throws IOException

DOCUMENT ME!

Parameters:

o - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

IOException - DOCUMENT ME!