net.obvj.jep.util

Class JsonUtils

java.lang.Object

net.obvj.jep.util.JsonUtils

public class JsonUtils
extends Object

Utility methods for working with JSON and JSONPath.

Author:

oswaldo.bapvic.jr

Method Summary

Modifier and Type	Method and Description
static com.jayway.jsonpath.JsonPath	compileJsonPath(String jsonPath) Compiles the given JSONPath.
static boolean	isEmpty(Object object) Null-safe method that evaluates the specified object for emptiness.
static Object	readJsonPath(org.json.JSONObject json, String jsonPath) Gets a value that matches the given JSONPath.
static Object	readJsonPath(org.json.JSONObject json, String jsonPath, boolean extractSingleElement) Gets a value that matches the given JSONPath.
static org.json.JSONArray	toJSONArray(Object object) Converts an object to a JSONArray.
static org.json.JSONObject	toJSONObject(Object object) Converts an object to a JSONObject.
static List<Object>	toList(org.json.JSONArray jsonArray) Converts a JSONArray into a Java-standard List.

Methods inherited from class java.lang.Object

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

Method Detail

isEmpty

public static boolean isEmpty(Object object)

Null-safe method that evaluates the specified object for emptiness.

For example, an empty JSONObject ("{ }") or JSONArray ("[ ]") evaluates to true.

Null references also evaluate to true.

Parameters:

object - the Object to be validated

Returns:

true if the Object is null or empty

compileJsonPath

public static com.jayway.jsonpath.JsonPath compileJsonPath(String jsonPath)

Compiles the given JSONPath.

Parameters:

jsonPath - the JSONPath to be validated

Returns:

a JsonPath object

readJsonPath

public static Object readJsonPath(org.json.JSONObject json,
                                  String jsonPath)

Gets a value that matches the given JSONPath.

Parameters:

json - a JSON object input data

jsonPath - the JSONPath to be evaluated

Returns:

The value that matches the given JSONPath string or null if no match was found. If the JSON is empty or null, the same object will be returned.

readJsonPath

public static Object readJsonPath(org.json.JSONObject json,
                                  String jsonPath,
                                  boolean extractSingleElement)

Gets a value that matches the given JSONPath.

Parameters:

jsonPath - the JSONPath to be validated

json - a JSON object input data

extractSingleElement - a flag indicating whether the method should return the single value of a JSONArray instead of the array itself, provided that the length of the returnable array is equal to one.

Returns:

The evaluation results the given jsonPath over the json object;

toJSONObject

public static org.json.JSONObject toJSONObject(Object object)
                                        throws org.json.JSONException

Converts an object to a JSONObject.

If the specified input is a String, then it will be parsed as a JSONObject.

If the specified input is null, then an empty JSONObject ("{ }") will be returned.

If the specified input is already a JSONObject, then the same object will be returned.

Parameters:

object - the object to be converted

Returns:

the converted JSONObject

Throws:

org.json.JSONException - in case of errors converting into JSONObject (for example, if there is a syntax error in the source string).

toJSONArray

public static org.json.JSONArray toJSONArray(Object object)
                                      throws org.json.JSONException

Converts an object to a JSONArray.

If the specified input is a String, then it will be parsed as a JSONArray.

If the specified input is null, then an empty JSONArray ("[ ]") will be returned.

If the specified input is already a JSONArray, then the same object will be returned.

Parameters:

object - the object to be converted

Returns:

the converted JSONArray

Throws:

org.json.JSONException - in case of errors converting into JSONArray (for example, if there is a syntax error in the source string).

toList

public static List<Object> toList(org.json.JSONArray jsonArray)

Converts a JSONArray into a Java-standard List.

Parameters:

jsonArray - the JSONArray object to be converted

Returns:

the list converted from a JSONArray object