com.braze.support

Class JsonUtils

java.lang.Object

org.json.JSONObject

com.braze.support.JsonUtils

Direct Known Subclasses:

JsonUtils

public class JsonUtils
extends org.json.JSONObject

Helper class for JSON objects. Whenever possible, these methods throw exceptions on bad inputs and do not try to work with malformed JSON.

Field Summary

Fields inherited from class org.json.JSONObject

NULL

Constructor Summary

Constructors

Constructor and Description
JsonUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	areJsonObjectsEqual(org.json.JSONObject target, org.json.JSONObject source) If both null, returns true.
static <T> org.json.JSONArray	constructJsonArray(java.util.Collection<? extends IPutIntoJson<T>> inputList)
static <T> org.json.JSONArray	constructJsonArray(T[] inputArray) Creates a new JSONArray containing the contents of the input array.
static java.util.Map<java.lang.String,java.lang.String>	convertJSONObjectToMap(org.json.JSONObject object) Converts a JSONObject to a Map.
static java.util.List<java.lang.String>	convertStringJsonArrayToList(org.json.JSONArray jsonArray) Converts the contents of the JSONArray to an List of Strings.
static java.lang.Integer	getColorIntegerOrNull(org.json.JSONObject object, java.lang.String key)
static <TargetEnum extends java.lang.Enum<TargetEnum>> TargetEnum	getEnum(org.json.JSONObject object, java.lang.String key, java.lang.Class<TargetEnum> targetEnumClass)
static java.lang.String	getOptionalString(org.json.JSONObject object, java.lang.String key) Returns the string value for key, or null if the key is not mapped in the object.
static java.lang.String	getPrettyPrintedString(org.json.JSONArray jsonArray) Returns the JSONArray.toString(int) result if possible.
static java.lang.String	getPrettyPrintedString(org.json.JSONObject jsonObject) Returns the JSONObject.toString(int) result if possible.
static org.json.JSONObject	mergeJsonObjects(org.json.JSONObject oldJson, org.json.JSONObject newJson) Merges key-values from oldJson and newJson into a new JSONObject.
static <TargetEnum extends java.lang.Enum<TargetEnum>> TargetEnum	optEnum(org.json.JSONObject object, java.lang.String key, java.lang.Class<TargetEnum> targetEnumClass, TargetEnum defaultEnum)
static android.os.Bundle	parseJsonObjectIntoBundle(java.lang.String jsonStringDictionary) Parses the JSON into a bundle.

Methods inherited from class org.json.JSONObject

accumulate, get, getBoolean, getDouble, getInt, getJSONArray, getJSONObject, getLong, getString, has, isNull, keys, length, names, numberToString, opt, optBoolean, optBoolean, optDouble, optDouble, optInt, optInt, optJSONArray, optJSONObject, optLong, optLong, optString, optString, put, put, put, put, put, putOpt, quote, remove, toJSONArray, toString, toString, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonUtils

public JsonUtils()

Method Detail

getEnum

public static <TargetEnum extends java.lang.Enum<TargetEnum>> TargetEnum getEnum(org.json.JSONObject object,
                                                                                 java.lang.String key,
                                                                                 java.lang.Class<TargetEnum> targetEnumClass)
                                                                          throws org.json.JSONException

Throws:

org.json.JSONException

optEnum

public static <TargetEnum extends java.lang.Enum<TargetEnum>> TargetEnum optEnum(org.json.JSONObject object,
                                                                                 java.lang.String key,
                                                                                 java.lang.Class<TargetEnum> targetEnumClass,
                                                                                 TargetEnum defaultEnum)

constructJsonArray

public static <T> org.json.JSONArray constructJsonArray(java.util.Collection<? extends IPutIntoJson<T>> inputList)

constructJsonArray

public static <T> org.json.JSONArray constructJsonArray(T[] inputArray)

Creates a new JSONArray containing the contents of the input array.

Parameters:

inputArray - the input array. When null, returns an empty JSONArray

getOptionalString

public static java.lang.String getOptionalString(org.json.JSONObject object,
                                                 java.lang.String key)

Returns the string value for key, or null if the key is not mapped in the object.

convertJSONObjectToMap

public static java.util.Map<java.lang.String,java.lang.String> convertJSONObjectToMap(org.json.JSONObject object)
                                                                               throws org.json.JSONException

Converts a JSONObject to a Map.

Parameters:

object - The JSONObject to convert.

Returns:

The resulting Map.

Throws:

org.json.JSONException

convertStringJsonArrayToList

public static java.util.List<java.lang.String> convertStringJsonArrayToList(org.json.JSONArray jsonArray)

Converts the contents of the JSONArray to an List of Strings.

mergeJsonObjects

public static org.json.JSONObject mergeJsonObjects(org.json.JSONObject oldJson,
                                                   org.json.JSONObject newJson)

Merges key-values from oldJson and newJson into a new JSONObject. Keys which exist in both oldJson and newJson will be overridden by the values in newJson. Key-values present in oldJson but not newJson will be preserved. Objects are not copied from their original objects, i.e. mutations of the original json will affect the merged output.

Returns:

merger of the json objects. Returns null if any exception is encountered.

getPrettyPrintedString

public static java.lang.String getPrettyPrintedString(org.json.JSONObject jsonObject)

Returns the JSONObject.toString(int) result if possible. Returns an empty string if the input JSONObject is null or on any thrown Throwable.

getPrettyPrintedString

public static java.lang.String getPrettyPrintedString(org.json.JSONArray jsonArray)

Returns the JSONArray.toString(int) result if possible. Returns an empty string if the input JSONArray is null or on any thrown Throwable.

getColorIntegerOrNull

public static java.lang.Integer getColorIntegerOrNull(org.json.JSONObject object,
                                                      java.lang.String key)

areJsonObjectsEqual

public static boolean areJsonObjectsEqual(org.json.JSONObject target,
                                          org.json.JSONObject source)

If both null, returns true.

If exactly one is null, returns false.

If the number of keys differs, returns false.

If a key in target is missing from source, returns false.

If a key/value in target is a JSONObject, then that corresponding key/value JSONObject in source must equal according to this method, else returns false.

If a key/value in target does not return true for Object.equals(Object) for that corresponding key/value in source, then returns false.

Otherwise return true.

Note that JSONArray will also use Object.equals(Object). If this functionality is not desired, add a corresponding case for JSONArray. Currently, the return value is undefined here.

parseJsonObjectIntoBundle

public static android.os.Bundle parseJsonObjectIntoBundle(java.lang.String jsonStringDictionary)

Parses the JSON into a bundle. The JSONObject parsed from the input string must be a flat dictionary with all string values.