name.pehl.piriti.json.client

Interface JsonReader<T>

Type Parameters:

T - The type

All Superinterfaces:

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

All Known Implementing Classes:

AbstractJsonReader

public interface JsonReader<T>
extends Reader<T>, HasModelReadHandler<T,com.google.gwt.json.client.JSONObject>

Interface for converting JSON data to an instance of T or a list of Ts. All properties of T and superclasses of T are handled by the generated JsonReader implementation. If there's data for the property it is assigned with the converted value, otherwise the property remains unchanged.

The setup of the JsonReader is inspired by the UiBinder and is typically specified as an inner class:

 pubilc ModalGirlfriendMediator
 {
     interface Reader extends JsonReader<ModalGirlfriendMediator> {}
     public static final Reader JSON_READER = GWT.create(Reader.class);
     
     // The properties of this POJO 
 }
 

JSON data can then be converted to an instance of ModalGirlfriendMediator by calling

 String json = "...";
 ModalGirlfriendMediator mgm = ModalGirlfriendMediator.JSON_READER.read(jsonString);
 

Version:

$LastChangedRevision: 46 $

Author:

$LastChangedBy: harald.pehl $

Method Summary

Methods

Modifier and Type	Method and Description
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.

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

Method Detail

readList

List<T> readList(String jsonString)
                 throws com.google.gwt.json.client.JSONException

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

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).

Throws:

com.google.gwt.json.client.JSONException - if the specified string represents no valid JSON data

readList

List<T> readList(String jsonString,
               String arrayKey)
                 throws com.google.gwt.json.client.JSONException

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

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).

Throws:

com.google.gwt.json.client.JSONException - if the specified string represents no valid JSON data

readList

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. 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

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

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. 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

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

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.

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

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

T read(String jsonString)
       throws com.google.gwt.json.client.JSONException

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

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).

Throws:

com.google.gwt.json.client.JSONException - if the specified string represents no valid JSON data

read

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

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

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).

Throws:

com.google.gwt.json.client.JSONException - if the specified string represents no valid JSON data