com.salesforce.androidsdk.util

Class JSONObjectHelper

java.lang.Object

com.salesforce.androidsdk.util.JSONObjectHelper

public class JSONObjectHelper
extends java.lang.Object

This allows other classes (primarily test classes) to register & receive events generated by the sdk.

Constructor Summary

Constructors

Constructor and Description
JSONObjectHelper()

Method Summary

Modifier and Type	Method and Description
static void	addAll(JSONArray destinationArray, JSONArray array) Add all elements from array to destinationArray
static JSONObject	makeJSONObject(java.lang.String key, java.lang.Object value)
static java.lang.Object	opt(JSONArray arr, int index) Return null if arr doesn't have value at index or the value is null JSONArray.opt(index) return the JSONObject.NULL if array has null at index and null if array doesn't have value at index
static java.lang.Object	opt(JSONObject obj, java.lang.String key) Return null if object doesn't have key or if obj has null for key JSONObject.opt(key) return the JSONObject.NULL if object has null for key and null if object doesn't have key
static java.lang.String	optString(JSONObject obj, java.lang.String key) Return null if obj doesn't have key or if obj has null for key JSONObject.optString(key, fallback) returns the string "null" if object has null for key and null if object doesn't have key
static java.lang.String	optString(JSONObject obj, java.lang.String key, java.lang.String fallback) Return the fallback if obj doesn't have key or if obj has null for key JSONObject.optString(key, fallback) returns the string "null" if object has null for key and null is object doesn't have key
static java.lang.String[]	optStringArray(JSONObject obj, java.lang.String key) Return null if obj doesn't have key or if obj has null for key - and return value as a String[] otherwise
static <T> java.util.List<T>	pluck(JSONArray jsonArray, java.lang.String key) Given a JSONArray of JSONObject, return list made of values for key
static <T> java.util.List<T>	pluck(JSONObject[] jsonObjects, java.lang.String key) Given an array of JSONObject, return list made of values for key
static <T> java.util.List<T>	toList(JSONArray jsonArray) Convert JSONArray of T into list of T
static <T> java.util.Map<java.lang.String,T>	toMap(JSONObject jsonObject) Convert JSONObject into Map of String to T

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONObjectHelper

public JSONObjectHelper()

Method Detail

opt

public static java.lang.Object opt(JSONObject obj,
                                   java.lang.String key)

Return null if object doesn't have key or if obj has null for key JSONObject.opt(key) return the JSONObject.NULL if object has null for key and null if object doesn't have key

opt

public static java.lang.Object opt(JSONArray arr,
                                   int index)

Return null if arr doesn't have value at index or the value is null JSONArray.opt(index) return the JSONObject.NULL if array has null at index and null if array doesn't have value at index

optStringArray

public static java.lang.String[] optStringArray(JSONObject obj,
                                                java.lang.String key)
                                         throws JSONException

Return null if obj doesn't have key or if obj has null for key - and return value as a String[] otherwise

Parameters:

obj -

key -

Returns:

Throws:

JSONException

optString

public static java.lang.String optString(JSONObject obj,
                                         java.lang.String key)
                                  throws JSONException

Return null if obj doesn't have key or if obj has null for key JSONObject.optString(key, fallback) returns the string "null" if object has null for key and null if object doesn't have key

Parameters:

obj -

key -

Returns:

Throws:

JSONException

optString

public static java.lang.String optString(JSONObject obj,
                                         java.lang.String key,
                                         java.lang.String fallback)
                                  throws JSONException

Return the fallback if obj doesn't have key or if obj has null for key JSONObject.optString(key, fallback) returns the string "null" if object has null for key and null is object doesn't have key

Parameters:

obj -

key -

fallback -

Returns:

Throws:

JSONException

toList

public static <T> java.util.List<T> toList(JSONArray jsonArray)
                                    throws JSONException

Convert JSONArray of T into list of T

Type Parameters:

T -

Parameters:

jsonArray -

Returns:

Throws:

JSONException

toMap

public static <T> java.util.Map<java.lang.String,T> toMap(JSONObject jsonObject)
                                                   throws JSONException

Convert JSONObject into Map of String to T

Type Parameters:

T -

Parameters:

jsonObject -

Returns:

Throws:

JSONException

pluck

public static <T> java.util.List<T> pluck(JSONArray jsonArray,
                                          java.lang.String key)
                                   throws JSONException

Given a JSONArray of JSONObject, return list made of values for key

Type Parameters:

T -

Parameters:

jsonArray -

key -

Returns:

Throws:

JSONException

pluck

public static <T> java.util.List<T> pluck(JSONObject[] jsonObjects,
                                          java.lang.String key)
                                   throws JSONException

Given an array of JSONObject, return list made of values for key

Type Parameters:

T -

Parameters:

jsonObjects -

key -

Returns:

Throws:

JSONException

makeJSONObject

public static JSONObject makeJSONObject(java.lang.String key,
                                        java.lang.Object value)
                                 throws JSONException

Parameters:

key -

value -

Returns:

JSONObject with value for key

Throws:

JSONException

addAll

public static void addAll(JSONArray destinationArray,
                          JSONArray array)
                   throws JSONException

Add all elements from array to destinationArray

Parameters:

destinationArray -

array -

Throws:

JSONException