javastrava.json

Interface JsonUtil

All Known Implementing Classes:

JsonUtilImpl

public interface JsonUtil

Abstracted JSON utilities for serialisation and de-serialisation, so we're not reliant on any one JSON library for the basic code

Author:

Dan Shannon

Method Summary

Modifier and Type	Method and Description
<T> T	deserialise(InputStream is, Class<T> class1) Deserialise an input stream representation of a JSON document to the named class
<T> T	deserialise(String input, Class<T> class1) Deserialise a string representation of a JSON document to the named class
<T> String	serialise(T object) Serialise an object to a JSON string

Method Detail

deserialise

<T> T deserialise(InputStream is,
                  Class<T> class1)
           throws JsonSerialisationException

Deserialise an input stream representation of a JSON document to the named class

Type Parameters:

T - Class to deserialise to

Parameters:

is - The input stream to deserialise

class1 - The class to which is should be deserialised

Returns:

An instance of the class as deserialised from the document

Throws:

JsonSerialisationException - If something goes horribly wrong in deserialisation

deserialise

<T> T deserialise(String input,
                  Class<T> class1)
           throws JsonSerialisationException

Deserialise a string representation of a JSON document to the named class

Type Parameters:

T - Class to deserialise to

Parameters:

input - The input string to deserialise

class1 - The class to which the input should be deserialised

Returns:

An instance of the class as deserialised from the document

Throws:

JsonSerialisationException - If something goes horribly wrong in deserialisation

serialise

<T> String serialise(T object)
              throws JsonSerialisationException

Serialise an object to a JSON string

Type Parameters:

T - Class to serialise

Parameters:

object - The object to be serialised

Returns:

The JSON string representation of the object

Throws:

JsonSerialisationException - If something goes horribly wrong in serialisation