name.pehl.piriti.json.client

Class AbstractJsonReader<T>

java.lang.Object

name.pehl.piriti.commons.client.ReaderWriterBase<T>

name.pehl.piriti.commons.client.AbstractReader<T,com.google.gwt.json.client.JSONObject>

name.pehl.piriti.json.client.AbstractJsonReader<T>

Type Parameters:

T - The type

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers, HasModelReadHandler<T,com.google.gwt.json.client.JSONObject>, Reader<T>, JsonReader<T>

public abstract class AbstractJsonReader<T>
extends AbstractReader<T,com.google.gwt.json.client.JSONObject>
implements JsonReader<T>

Base class for generated JsonReaders. Contains common code and methods.

Version:

$LastChangedRevision:$

Author:

$LastChangedBy:$

Field Summary

Fields

Modifier and Type	Field and Description
protected JsonRegistry	jsonRegistry

Fields inherited from class name.pehl.piriti.commons.client.ReaderWriterBase

handlerManager, idMap, logger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractJsonReader()

Method Summary

Methods

Modifier and Type	Method and Description
protected T	internalRead(com.google.gwt.json.client.JSONObject jsonObject)
T	read(com.google.gwt.json.client.JSONObject jsonObject) Convert the specified JSON object to an instance of T according to the annotated properties in T.
T	read(String jsonString) Convert the specified JSON string to an instance of T according to the annotated properties in T.
List<T>	readList(com.google.gwt.json.client.JSONArray jsonArray) Convert the specified JSON array to a list of Ts according to the annotated properties in T.
List<T>	readList(com.google.gwt.json.client.JSONObject jsonObject) Convert the specified JSON object to a list of Ts according to the annotated properties in T.
List<T>	readList(com.google.gwt.json.client.JSONObject jsonObject, String arrayKey) Convert the specified JSON object to a list of Ts according to the annotated properties in T.
List<T>	readList(String jsonString) Convert the specified JSON string to a list of Ts according to the annotated properties in T.
List<T>	readList(String jsonString, String arrayKey) Convert the specified JSON string to a list of Ts according to the annotated properties in T.
protected <O> O	readObject(com.google.gwt.json.client.JSONValue jsonValue, JsonReader<O> jsonReader)
protected <V> V	readValue(com.google.gwt.json.client.JSONValue jsonValue, Converter<V> converter)

Methods inherited from class name.pehl.piriti.commons.client.AbstractReader

addModelReadHandler, fireEvent, idRef, newModel, readId, readIdRefs, readProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface name.pehl.piriti.commons.client.Reader

idRef

Methods inherited from interface name.pehl.piriti.commons.client.HasModelReadHandler

addModelReadHandler

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Field Detail

jsonRegistry

protected final JsonRegistry jsonRegistry

Constructor Detail

AbstractJsonReader

protected AbstractJsonReader()

Method Detail

readList

public List<T> readList(String jsonString)

Description copied from interface: JsonReader

Convert the specified JSON string to a list of Ts according to the annotated properties in T. The JSON string must be a valid JSON object with one key / value pair. The value must be a JSON array which is converted to the list of Ts.

Depending on jsonString the following value is returned by this method:

jsonString	Result
null	null
empty / blank string	null
empty JSON {}	null
JSON with one key / value, which is null or no array {"foo": null} {"foo": 123}	null
JSON with one key / value, which is an empty array {"foo": []}	empty list
JSON with one key and a non-empty array {"foo": [...]}	a list of Ts according to the annotated properties in T

Specified by:

readList in interface JsonReader<T>

Parameters:

jsonString - The JSON string used as input. May be null.

Returns:

A list of Ts with the mapped JSON data, an empty list or null (see above).

readList

public List<T> readList(String jsonString,
               String arrayKey)

Description copied from interface: JsonReader

Convert the specified JSON string to a list of Ts according to the annotated properties in T. The JSON string must be a valid JSON object with key / value pairs. The array is taken from the specified key and is converted to the list of Ts.

Depending on jsonString and arrayKey the following value is returned by this method:

jsonString	arrayKey	Result
null	any value	null
empty / blank string	any value	null
empty JSON {}	any value	null
JSON with a non-existing key {"foo": null} {"foo": 123} {"foo": [...]}	"bar"	null
JSON with the specified key and a value which is null or no array {"foo": null} {"foo": 123}	"foo"	null
JSON with the specified key and a avlue which is an empty array {"foo": []}	"foo"	empty list
JSON with the specified key and a non-empty array {"foo": [...]}	"foo"	a list of Ts according to the annotated properties in T

Specified by:

readList in interface JsonReader<T>

Parameters:

jsonString - The JSON string used as input. May be null.

arrayKey - The key containing the JSON array.

Returns:

A list of T instances with the mapped JSON data, an empty list or null (see above).

readList

public List<T> readList(com.google.gwt.json.client.JSONObject jsonObject)

Description copied from interface: JsonReader

Convert the specified JSON object to a list of Ts according to the annotated properties in T. The JSON object must contain one key / value pair. The value must be JSON array which converted to the list of Ts.

Depending on jsonObject the following value is returned by this method:

jsonObject	Result
null	null
empty JSON {}	null
JSON with one key / value, which is null or no array {"foo": null} {"foo": 123}	null
JSON with one key / value, which is an empty array {"foo": []}	empty list
JSON with one key and a non-empty array {"foo": [...]}	a list of Ts according to the annotated properties in T

Specified by:

readList in interface JsonReader<T>

Parameters:

jsonObject - The JSON object used as input. May be null.

Returns:

A list of T instances with the mapped JSON data, an empty list or null (see above).

readList

public List<T> readList(com.google.gwt.json.client.JSONObject jsonObject,
               String arrayKey)

Description copied from interface: JsonReader

Convert the specified JSON object to a list of Ts according to the annotated properties in T. The JSON object must contains the specified array. This array is converted to the list of Ts.

Depending on jsonObject and arrayKey the following value is returned by this method:

jsonObject	arrayKey	Result
null	any value	null
empty JSON {}	any value	null
JSON with a non-existing key {"foo": null} {"foo": 123} {"foo": [...]}	"bar"	null
JSON with the specified key and a value which is null or no array {"foo": null} {"foo": 123}	"foo"	null
JSON with the specified key and a avlue which is an empty array {"foo": []}	"foo"	empty list
JSON with the specified key and a non-empty array {"foo": [...]}	"foo"	a list of Ts according to the annotated properties in T

Specified by:

readList in interface JsonReader<T>

Parameters:

jsonObject - The JSON object used as input. May be null.

arrayKey - The key containing the JSON array.

Returns:

A list of T instances with the mapped JSON data, an empty list or null (see above).

readList

public List<T> readList(com.google.gwt.json.client.JSONArray jsonArray)

Description copied from interface: JsonReader

Convert the specified JSON array to a list of Ts according to the annotated properties in T.

Depending on jsonArray the following value is returned by this method:

jsonArray	Result
null	null
empty array []	empty list
Non-empty array {[...]}	a list of Ts according to the annotated properties in T

Specified by:

readList in interface JsonReader<T>

Parameters:

jsonArray - The JSON array used as input. May be null.

Returns:

A list of T instances with the mapped JSON data, an empty list or null (see above).

read

public T read(String jsonString)

Description copied from interface: JsonReader

Convert the specified JSON string to an instance of T according to the annotated properties in T. The JSON string must be a valid JSON object with key / value pairs.

Depending on jsonString the following value is returned by this method:

jsonString	Result
null	null
empty / blank string	null
empty JSON {}	new instance of T
JSON with keys / values {"key": "value", ...}	an instance of T with the mapped JSON data

Specified by:

read in interface JsonReader<T>

Parameters:

jsonString - The JSON string used as input. May be null.

Returns:

An instance of T with the mapped JSON data or null (see above).

read

public T read(com.google.gwt.json.client.JSONObject jsonObject)

Description copied from interface: JsonReader

Convert the specified JSON object to an instance of T according to the annotated properties in T.

Depending on jsonObject the following value is returned by this method:

jsonObject	Result
null	null
empty JSON {}	new instance of T
JSON with keys / values {"key": "value", ...}	an instance of T with the mapped JSON data

Specified by:

read in interface JsonReader<T>

Parameters:

jsonObject - The JSON object used as input. May be null.

Returns:

An instance of T with the mapped JSON data or null (see above).

internalRead

protected T internalRead(com.google.gwt.json.client.JSONObject jsonObject)

readValue

protected <V> V readValue(com.google.gwt.json.client.JSONValue jsonValue,
              Converter<V> converter)

readObject

protected <O> O readObject(com.google.gwt.json.client.JSONValue jsonValue,
               JsonReader<O> jsonReader)