com.inedo.http

Class JsonReader

java.lang.Object

com.inedo.http.JsonReader

public class JsonReader
extends java.lang.Object

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

Methods

Modifier and Type	Method and Description
com.google.gson.JsonElement	asJson() Deserialize the returned Json string.
<T> T	asJson(java.lang.Class<T> type) Deserialize the Json into an object of the specified class.
<T> T	asJson(java.lang.reflect.Type type) Deserialize the Json into an object of the specified class.
java.lang.String	asPrettyString()
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

Throws:

JsonParseException - JsonParseException

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

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

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());
 

Parameters:

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

Parameters:

json - Json element

path - search path

Returns:

JsonElement or null if not found

asJson

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

Deserialize the Json into an object of the specified class.

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

asJson

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

Deserialize the Json into an object of the specified class.

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

com.google.gson.JsonSyntaxException