connector.common

Class JsonUtil

java.lang.Object

connector.common.JsonUtil

public class JsonUtil
extends java.lang.Object

Utility class for rendering and parsing JSON.

Developers can makes use of methods from JsonParserBuilder for creating an instance of the utility class depending upon the necessary customizations.

For default JSON parsing:

• JsonUtil.JsonParserBuilder.defaultJsonParser() - Returns an instance of default Json utility which ignores null values and disables HTML escaping

For customized JSON parsing:

• JsonUtil.JsonParserBuilder.custom() - Returns a builder instance for creating customized JsonUtil object
• JsonUtil.JsonParserBuilder.serializeNulls() - Enables including null values in json representation
• JsonUtil.JsonParserBuilder.disableHtmlEscaping() - Disables HTML escaping in the resulting json representation
• JsonUtil.JsonParserBuilder.create() - Prepares the JsonUtil instance with the customizations

Dates are rendered as strings, but they do not parse back as dates.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonUtil.JsonParser
static class	JsonUtil.JsonParserBuilder Builder for creating a JsonParser instance.

Constructor Summary

Constructors

Constructor and Description
JsonUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	containsKey(java.lang.String source, java.lang.String key) Returns boolean value if the provided key is present in the supplied JSON source
static java.util.Map<java.lang.String,java.lang.Object>	get(java.lang.String source, java.util.Collection<java.lang.String> keys) Returns a Map containing JSON paths indicated by keys as the key and its value, if present, from the JSON source string.
static java.lang.Object	get(java.lang.String source, java.lang.String key) Returns the value of the JSON attribute indicated by key from the JSON source string.
static java.lang.Boolean	getAsBoolean(java.lang.String source, java.lang.String key) Returns boolean value from the supplied JSON source associated with the provided key
static java.util.List<java.lang.Object>	getAsList(java.lang.String source, java.lang.String key) Returns List from the supplied JSON source associated with the provided key
static java.lang.Number	getAsNumber(java.lang.String source, java.lang.String key) Returns Number from the supplied JSON source associated with the provided key
static java.lang.String	getAsString(java.lang.String source, java.lang.String key) Returns the value of the JSON attribute indicated by key in the JSON source string as String.
static boolean	isEmpty(java.lang.String source, java.lang.String key) Returns boolean value for determining the value of the associated object with the provided key in the supplied JSON string is empty or not.
static int	length(java.lang.String source) Returns the count of element in the supplied JSON string
static java.lang.Object	parse(java.lang.String json) Deprecated.
static java.lang.Object	parseJson(java.lang.String source) Returns Java-equivalent object for the supplied JSON source.
static java.lang.Object	parseJson(java.lang.String source, java.lang.Class<?> targetClass) Returns object of type targetClass for the supplied JSON source.
static java.lang.String	put(java.lang.String target, java.lang.String key, java.lang.Object value) Associating the specified value with the specified key in the provided JSON target.If the the provided target previously contained a mapping for the key, the oldvalue is replaced.
static java.lang.String	remove(java.lang.String target, java.lang.String key) Removes the mapping for the specified key from the provided JSON string target, if present.
static java.lang.String	render(java.lang.Object o) Deprecated.
static java.lang.String	toJson(java.lang.Object source) Converts the JSON source to JSON string.
static java.util.List<java.lang.Object>	toList(java.lang.String jsonArraySource) Creates a List from the supplied JSON jsonArraySource.
static java.util.Map<java.lang.String,java.lang.Object>	toMap(java.lang.String source) Creates a Map from the supplied JSON source.
static java.lang.String	toStringOrJson(java.lang.Object object) Parses the object and returns a string value or an equivalent JSON representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonUtil

public JsonUtil()

Method Detail

toJson

public static java.lang.String toJson(java.lang.Object source)

Converts the JSON source to JSON string. This method will exclude null values, if any.

Parameters:

source - Object to convert to JSON form

Returns:

JSON String representation of supplied source object

parseJson

public static java.lang.Object parseJson(java.lang.String source)

Returns Java-equivalent object for the supplied JSON source.

Below is the JSON source to Java-equivalent mapping:

JSON Source	Returns
Json Array: [...]	List<Object>
JSON Map: {...}	Map<String, Object>
String, Number, Boolean, primitives	Corresponding Java equivalent class

Parameters:

source - JSON string for conversion

Returns:

Java equivalent Object post JSON conversion

parseJson

public static java.lang.Object parseJson(java.lang.String source,
                                         java.lang.Class<?> targetClass)

Returns object of type targetClass for the supplied JSON source.

If targetClass is null, JsonUtil.parseJson(String) will be the default invocation.

Parameters:

source - JSON string for conversion

targetClass - name of the class to which the JSON source should be converted to

Returns:

object to type targetClass, if not null, Java equivalent Object otherwise

toMap

public static java.util.Map<java.lang.String,java.lang.Object> toMap(java.lang.String source)

Creates a Map from the supplied JSON source.

Parameters:

source - JSON string for conversion

Returns:

a Map containing JSON key-value pairs

toList

public static java.util.List<java.lang.Object> toList(java.lang.String jsonArraySource)

Creates a List from the supplied JSON jsonArraySource.

Parameters:

jsonArraySource - JSON string for conversion

Returns:

a List contains the array elements

get

public static java.lang.Object get(java.lang.String source,
                                   java.lang.String key)

Returns the value of the JSON attribute indicated by key from the JSON source string.

Parameters:

source - JSON source string

key - key to extract the associated value

Returns:

Object associated with the key in the supplied JSON string

get

public static java.util.Map<java.lang.String,java.lang.Object> get(java.lang.String source,
                                                                   java.util.Collection<java.lang.String> keys)

Returns a Map containing JSON paths indicated by keys as the key and its value, if present, from the JSON source string.

Parameters:

source - JSON source string

keys - keys to extract the associated value

Returns:

Object associated with the key in the supplied JSON string

getAsString

public static java.lang.String getAsString(java.lang.String source,
                                           java.lang.String key)

Returns the value of the JSON attribute indicated by key in the JSON source string as String.

Parameters:

source - JSON source string

key - key to extract the associated value string

Returns:

associated value with the key

getAsNumber

public static java.lang.Number getAsNumber(java.lang.String source,
                                           java.lang.String key)

Returns Number from the supplied JSON source associated with the provided key

Parameters:

source - JSON source string

key - key to extract the associated Number

Returns:

associated Number with the provided key

getAsList

public static java.util.List<java.lang.Object> getAsList(java.lang.String source,
                                                         java.lang.String key)

Returns List from the supplied JSON source associated with the provided key

Parameters:

source - JSON source string

key - key to extract the associated value

Returns:

associated JSONArray with the provided key as List

getAsBoolean

public static java.lang.Boolean getAsBoolean(java.lang.String source,
                                             java.lang.String key)

Returns boolean value from the supplied JSON source associated with the provided key

Parameters:

source - JSON source string

key - key to extract the associated value

Returns:

associated boolean value with the providedkey

containsKey

public static boolean containsKey(java.lang.String source,
                                  java.lang.String key)

Returns boolean value if the provided key is present in the supplied JSON source

Parameters:

source - JSON source string

key - key to identify the presence

Returns:

true if the key is present in the supplied JSON string , else false

isEmpty

public static boolean isEmpty(java.lang.String source,
                              java.lang.String key)

Returns boolean value for determining the value of the associated object with the provided key in the supplied JSON string is empty or not.

Parameters:

source - JSON source string

key - key to identify associating value

Returns:

true if the value of the associated object with the key in the supplied JSON string is empty or not present , else false.

length

public static int length(java.lang.String source)

Returns the count of element in the supplied JSON string

Parameters:

source - JSON source string

Returns:

count of the elements in the supplied JSON string

remove

public static java.lang.String remove(java.lang.String target,
                                      java.lang.String key)

Removes the mapping for the specified key from the provided JSON string target, if present.

Parameters:

target - JSON target string

key - key to be remove from targeted JSON

Returns:

JSON String of updated target JSON string

put

public static java.lang.String put(java.lang.String target,
                                   java.lang.String key,
                                   java.lang.Object value)

Associating the specified value with the specified key in the provided JSON target.If the the provided target previously contained a mapping for the key, the oldvalue is replaced.

Parameters:

target - JSON target string

key - key to be added in target JSON string

value - value to be added in targeted JSON target

Returns:

JSON String with newly added/updated key value pairs

toStringOrJson

public static java.lang.String toStringOrJson(java.lang.Object object)
                                       throws java.lang.Exception

Parses the object and returns a string value or an equivalent JSON representation.

NOTE: This method is primarily used by the HTTP clients for converting the request body to appropriate json format.

TODO: Move this method out of here to HttpClientWrapper once other HTTP clients are deprecated.

Parameters:

object - object to convert into string or json

Returns:

String value, if object is of type string, otherwise json representation

Throws:

java.lang.Exception

render

@Deprecated
public static java.lang.String render(java.lang.Object o)
                                           throws java.lang.Exception

Deprecated.

Public interface to rendering something as a JSON string. A null value returns a null String, not the JSON string "null".

Note: Please use JsonUtil.toJson(Object)

Throws:

java.lang.Exception

parse

@Deprecated
public static java.lang.Object parse(java.lang.String json)
                                          throws java.lang.Exception

Deprecated.

Public interface for parsing JSON that conforms to our restrictions. Note: Please use JsonUtil.parseJson(String)

Throws:

java.lang.Exception