Package name.martingeisse.grumpyjson

Class GsonBasedJsonEngine

java.lang.Object

name.martingeisse.grumpyjson.StructuralJsonEngine

name.martingeisse.grumpyjson.JsonEngine

name.martingeisse.grumpyjson.GsonBasedJsonEngine

public final class GsonBasedJsonEngine
extends JsonEngine

GSON-based implementation of JsonEngine.

Constructor Summary

Constructors

Constructor	Description
GsonBasedJsonEngine()	Creates a new JSON engine with standard converters registered.

Method Summary

Modifier and Type	Method	Description
<T> T	deserialize(InputStream source, Class<T> clazz)	deserializes JSON from an InputStream.
Object	deserialize(InputStream source, Type type)	deserializes JSON from an InputStream.
<T> T	deserialize(InputStream source, TypeToken<T> typeToken)	deserializes JSON from an InputStream.
<T> T	deserialize(Reader source, Class<T> clazz)	deserializes JSON from an Reader.
Object	deserialize(Reader source, Type type)	deserializes JSON from an Reader.
<T> T	deserialize(Reader source, TypeToken<T> typeToken)	deserializes JSON from an Reader.
<T> T	deserialize(String source, Class<T> clazz)	deserializes JSON from a String.
Object	deserialize(String source, Type type)	deserializes JSON from a String.
<T> T	deserialize(String source, TypeToken<T> typeToken)	deserializes JSON from a String.
String	serializeToString(Object value)	Turns a value into a JSON string.
void	writeTo(Object value, OutputStream destination)	Turns a value into JSON that is written to an output stream.
void	writeTo(Object value, Writer destination)	Turns a value into JSON that is written to a writer.

Methods inherited from class name.martingeisse.grumpyjson.StructuralJsonEngine

deserialize, deserialize, deserialize, getDeserializerRegistry, getRegistries, getSerializerRegistry, registerDeserializer, registerDualConverter, registerSerializer, seal, supportsClassForSerialization, supportsTypeForDeserialization, toJsonElement

Methods inherited from class java.lang.Object

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

Constructor Details

GsonBasedJsonEngine

public GsonBasedJsonEngine()

Creates a new JSON engine with standard converters registered.

Method Details

deserialize

public <T> T deserialize(String source,
 Class<T> clazz)
                  throws JsonDeserializationException

Description copied from class: JsonEngine

deserializes JSON from a String.

Specified by:

deserialize in class JsonEngine

Type Parameters:

T - the static target type

Parameters:

source - the source string

clazz - the target type to deserialize to

Returns:

the deserialized value

Throws:

JsonDeserializationException - if the JSON is malformed or does not match the target type

deserialize

public <T> T deserialize(String source,
 TypeToken<T> typeToken)
                  throws JsonDeserializationException

Description copied from class: JsonEngine

deserializes JSON from a String.

Specified by:

deserialize in class JsonEngine

Type Parameters:

T - the static target type

Parameters:

source - the source string

typeToken - a type token for the target type to deserialize to

Returns:

the deserialized value

Throws:

JsonDeserializationException - if the JSON is malformed or does not match the target type

deserialize

public Object deserialize(String source,
 Type type)
                   throws JsonDeserializationException

Description copied from class: JsonEngine

deserializes JSON from a String.

Specified by:

deserialize in class JsonEngine

Parameters:

source - the source string

type - the target type to deserialize to

Returns:

the deserialized value

Throws:

JsonDeserializationException - if the JSON is malformed or does not match the target type

deserialize

public <T> T deserialize(InputStream source,
 Class<T> clazz)
                  throws JsonDeserializationException

Description copied from class: JsonEngine

deserializes JSON from an InputStream. As demanded by the MIME type application/json, the input must be UTF-8 encoded.

Specified by:

deserialize in class JsonEngine

Type Parameters:

T - the static target type

Parameters:

source - the source stream

clazz - the target type to deserialize to

Returns:

the deserialized value

Throws:

JsonDeserializationException - if the JSON is malformed or does not match the target type

deserialize

public <T> T deserialize(InputStream source,
 TypeToken<T> typeToken)
                  throws JsonDeserializationException

Description copied from class: JsonEngine

deserializes JSON from an InputStream. As demanded by the MIME type application/json, the input must be UTF-8 encoded.

Specified by:

deserialize in class JsonEngine

Type Parameters:

T - the static target type

Parameters:

source - the source stream

typeToken - a type token for the target type to deserialize to

Returns:

the deserialized value

Throws:

JsonDeserializationException - if the JSON is malformed or does not match the target type

deserialize

public Object deserialize(InputStream source,
 Type type)
                   throws JsonDeserializationException

Description copied from class: JsonEngine

deserializes JSON from an InputStream. As demanded by the MIME type application/json, the input must be UTF-8 encoded.

Specified by:

deserialize in class JsonEngine

Parameters:

source - the source stream

type - the target type to deserialize to

Returns:

the deserialized value

Throws:

JsonDeserializationException - if the JSON is malformed or does not match the target type

deserialize

public <T> T deserialize(Reader source,
 Class<T> clazz)
                  throws JsonDeserializationException

Description copied from class: JsonEngine

deserializes JSON from an Reader.

Specified by:

deserialize in class JsonEngine

Type Parameters:

T - the static target type

Parameters:

source - the source reader

clazz - the target type to deserialize to

Returns:

the deserialized value

Throws:

JsonDeserializationException - if the JSON is malformed or does not match the target type

deserialize

public <T> T deserialize(Reader source,
 TypeToken<T> typeToken)
                  throws JsonDeserializationException

Description copied from class: JsonEngine

deserializes JSON from an Reader.

Specified by:

deserialize in class JsonEngine

Type Parameters:

T - the static target type

Parameters:

source - the source reader

typeToken - a type token for the target type to deserialize to

Returns:

the deserialized value

Throws:

JsonDeserializationException - if the JSON is malformed or does not match the target type

deserialize

public Object deserialize(Reader source,
 Type type)
                   throws JsonDeserializationException

Description copied from class: JsonEngine

deserializes JSON from an Reader.

Specified by:

deserialize in class JsonEngine

Parameters:

source - the source reader

type - the target type to deserialize to

Returns:

the deserialized value

Throws:

JsonDeserializationException - if the JSON is malformed or does not match the target type

serializeToString

public String serializeToString(Object value)
                         throws JsonSerializationException

Description copied from class: JsonEngine

Turns a value into a JSON string.

Specified by:

serializeToString in class JsonEngine

Parameters:

value - the value to serialize

Returns:

the JSON string

Throws:

JsonSerializationException - if the value is in an inconsistent state or a state that cannot be turned into JSON

writeTo

public void writeTo(Object value,
 OutputStream destination)
             throws JsonSerializationException

Description copied from class: JsonEngine

Turns a value into JSON that is written to an output stream. As demanded by the MIME type application/json, the output will be UTF-8 encoded.

Specified by:

writeTo in class JsonEngine

Parameters:

value - the value to convert

destination - the stream to write to

Throws:

JsonSerializationException - if the value is in an inconsistent state or a state that cannot be turned into JSON

writeTo

public void writeTo(Object value,
 Writer destination)
             throws JsonSerializationException

Description copied from class: JsonEngine

Turns a value into JSON that is written to a writer.

Specified by:

writeTo in class JsonEngine

Parameters:

value - the value to convert

destination - the writer to write to

Throws:

JsonSerializationException - if the value is in an inconsistent state or a state that cannot be turned into JSON