org.miniclient.util

Class JsonUtil

java.lang.Object

org.miniclient.util.JsonUtil

public final class JsonUtil
extends Object

Utility functions for serializing/deserializing json object/string.

Method Summary

Methods

Modifier and Type	Method and Description
static String	buildJson(Object jsonObj) Returns a JSON string for the given object.
static void	buildJson(Writer writer, Object jsonObj) Returns a JSON string for the given object.
static Object	parseJson(Reader reader) Parse the json string into a structure comprising only three types: a map, a list, and a scalar value.
static Object	parseJson(String jsonStr) Parse the json string into a structure comprising only three types: a map, a list, and a scalar value.

Methods inherited from class java.lang.Object

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

Method Detail

parseJson

public static Object parseJson(String jsonStr)
                        throws RestApiException

Parse the json string into a structure comprising only three types: a map, a list, and a scalar value. 1) Map of {String -> Object}. The value type can be a map, a list, or a scalar value. 2) List of {Object}. Ditto. 3) Any other objects, primitive type, Object, a collection other than list and map, are treated as scalar, and they are treated as leaf nodes. (Even if an object has an internal structure, we do not have the type information.) Note that a leaf node object cannot be instantiated as an object (it's only a string).

Parameters:

jsonStr - Input JSON string representing a map, a list, or an object/primitive type.

Returns:

The object deserialized from the jsonStr.

Throws:

RestApiException - if JSON parsing fails.

parseJson

public static Object parseJson(Reader reader)
                        throws RestApiException,
                               IOException

Parse the json string into a structure comprising only three types: a map, a list, and a scalar value. 1) Map of {String -> Object}. The value type can be a map, a list, or a scalar value. 2) List of {Object}. Ditto. 3) Any other objects, primitive type, Object, a collection other than list and map, are treated as scalar, and they are treated as leaf nodes. (Even if an object has an internal structure, we do not have the type information.) Note that a leaf node object cannot be instantiated as an object (it's only a string).

Parameters:

reader - Reader from which the input JSON string is to be read representing a map, a list, or an object/primitive type.

Returns:

The object deserialized from the jsonStr.

Throws:

RestApiException - if JSON parsing fails.

IOException - if error occurs while reading from the reader.

buildJson

public static String buildJson(Object jsonObj)
                        throws RestApiException

Returns a JSON string for the given object. The input can be a map of {String -> Object}, a list of {Object}, or an Object/primitive type. It recursively traverses each element as long as they are a list or a map. All other elements (primitive, object, a collection type other than list and map) are treated as leaf nodes. Objects are converted to a string using toString(). (Note: Even if an object has an internal structure, we do not have the type information.)

Parameters:

jsonObj - An object that is to be converted to JSON string.

Returns:

The json string representation of jsonObj.

Throws:

RestApiException - if JSON build fails.

buildJson

public static void buildJson(Writer writer,
             Object jsonObj)
                      throws RestApiException,
                             IOException

Returns a JSON string for the given object. The input can be a map of {String -> Object}, a list of {Object}, or an Object/primitive type. It recursively traverses each element as long as they are a list or a map. All other elements (primitive, object, a collection type other than list and map) are treated as leaf nodes. Objects are converted to a string using toString(). (Note: Even if an object has an internal structure, we do not have the type information.)

Parameters:

writer - Writer to which the generated JSON string is to be written. Cannot be null.

jsonObj - An object that is to be converted to JSON string.

Throws:

RestApiException - if JSON build fails.

IOException - if error occurs while writing to writer.