com.inedo.http

Class JsonReader

java.lang.Object

com.inedo.http.JsonReader

All Implemented Interfaces:

ResponseReader

public class JsonReader
extends java.lang.Object
implements ResponseReader

A wrapper around "com.google.gson.Gson" for simplifying the parsing JSON strings.

Constructor Summary

Constructors

Constructor and Description
JsonReader(com.google.gson.JsonElement element) A json reader.
JsonReader(java.lang.String json) A json reader.

Method Summary

Modifier and Type	Method and Description
com.google.gson.JsonElement	asJson() Deserialize the returned Json string.
java.lang.String	asPrettyString()
<T> T	fromJson(java.lang.Class<T> type) Deserialize the Json into an object of the specified class.
<T> T	fromJson(com.google.gson.Gson builder, java.lang.reflect.Type returnType) Deserialize the Json into an object of the specified class using the supplied builder.
<T> T	fromJson(java.lang.reflect.Type returnType) Deserialize the Json into an object of the specified class using a default builder.
com.google.gson.JsonArray	getAsJsonArray(com.google.gson.JsonElement node, java.lang.String path) Search the JSON response for the requested element.
com.google.gson.JsonArray	getAsJsonArray(java.lang.String path) Search the JSON response for the requested element.
java.lang.String	getAsString(com.google.gson.JsonElement node, java.lang.String path) Search the JSON response for the requested element.
java.lang.String	getAsString(java.lang.String path) Search the JSON response for the requested element.
com.google.gson.JsonElement	jsonPath(com.google.gson.JsonElement json, java.lang.String path) Search a JSON element's children for the requested element.
com.google.gson.JsonElement	jsonPath(java.lang.String path) Search the JSON response for the requested element.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonReader

public JsonReader(java.lang.String json)

A json reader.

Parameters:

json - Json string

JsonReader

public JsonReader(com.google.gson.JsonElement element)

A json reader.

Parameters:

element - Json Element

Method Detail

asPrettyString

public java.lang.String asPrettyString()
                                throws java.io.IOException

Specified by:

asPrettyString in interface ResponseReader

Returns:

A nicely formatted JSON string

Throws:

java.io.IOException - If unable to read the response

asJson

public com.google.gson.JsonElement asJson()
                                   throws java.io.IOException

Deserialize the returned Json string.

Returns:

A JsonElement

Throws:

java.io.IOException - if the response string is not valid JSON

getAsString

public java.lang.String getAsString(java.lang.String path)

Search the JSON response for the requested element. Is a helper method for jsonPath(String).

Parameters:

path - A dot separated Json search path

Returns:

String if element found otherwise null

getAsString

public java.lang.String getAsString(com.google.gson.JsonElement node,
                                    java.lang.String path)

Search the JSON response for the requested element. Is a helper method for jsonPath(JsonElement, String).

Parameters:

node - Json element

path - A dot separated Json search path

Returns:

String if element found otherwise null

getAsJsonArray

public com.google.gson.JsonArray getAsJsonArray(java.lang.String path)

Search the JSON response for the requested element. Is a helper method for jsonPath(String).

Parameters:

path - A dot separated Json search path

Returns:

JsonArray if element found otherwise empty JsonArray

getAsJsonArray

public com.google.gson.JsonArray getAsJsonArray(com.google.gson.JsonElement node,
                                                java.lang.String path)

Search the JSON response for the requested element. Is a helper method for jsonPath(JsonElement, String).

Parameters:

node - Json element

path - A dot separated Json search path

Returns:

JsonArray if element found otherwise empty JsonArray

jsonPath

public com.google.gson.JsonElement jsonPath(java.lang.String path)

Search the JSON response for the requested element.

 JsonElement value = reader.jsonPath("anArray[0].aValue").
 String details = (value == null ? "" : value.getAsString());
 

If an element name contains a dot then the dot can be escaped with a double backslash, eg:

 ele1.ele2part1\\.ele2part2
 

Parameters:

path - A dot separated Json search path

Returns:

JsonElement or null if not found

jsonPath

public com.google.gson.JsonElement jsonPath(com.google.gson.JsonElement json,
                                            java.lang.String path)

Search a JSON element's children for the requested element.

If an element name contains a dot then the dot can be escaped with a double backslash, eg:

 ele1.ele2part1\\.ele2part2
 

Parameters:

json - Json element

path - A dot separated Json search path

Returns:

JsonElement or null if not found

fromJson

public <T> T fromJson(java.lang.Class<T> type)
               throws java.io.IOException

Deserialize the Json into an object of the specified class.

Note: use @SerializedName("custom-name") to convert from key name to variable name

Type Parameters:

T - The type of the desired object

Parameters:

type - Class to populate

Returns:

A new class of the supplied type

Throws:

java.io.IOException - if json is not a valid representation for an object of type classOfT

fromJson

public <T> T fromJson(java.lang.reflect.Type returnType)
               throws com.google.gson.JsonSyntaxException

Deserialize the Json into an object of the specified class using a default builder.

Type Parameters:

T - The type of the desired object

Parameters:

returnType - Class to populate

Returns:

A new class of the supplied type

Throws:

com.google.gson.JsonSyntaxException - if json is not a valid representation for an object of type classOfT

fromJson

public <T> T fromJson(com.google.gson.Gson builder,
                      java.lang.reflect.Type returnType)

Deserialize the Json into an object of the specified class using the supplied builder.

Type Parameters:

T - The type of the desired object

Parameters:

builder - Gson builder to use

returnType - Class to populate

Returns:

A new class of the supplied type

Throws:

com.google.gson.JsonSyntaxException - if json is not a valid representation for an object of type classOfT