com.scvngr.levelup.core.model.util

Class JsonUtils

java.lang.Object

com.scvngr.levelup.core.model.util.JsonUtils

@ThreadSafe
public final class JsonUtils
extends Object

Helper class to work with JSONObject and avoid its bugs.

See Also:

Issue 13830

Method Summary

Modifier and Type	Method and Description
static MonetaryValue	getMonetaryValue(JSONObject json, String key) Gets a required MonetaryValue object from the JSON at the key passed or throws a JSONException if it's missing.
static Set<Integer>	optIntegerSet(JSONObject json, String key) Loads a Set of Integer from a JSONArray of integers.
static Long	optLongNullable(JSONObject json, String key) Helper method that gets an optional nullable Long value from the JSONObject.
static MonetaryValue	optMonetaryValue(JSONObject json, String key) Gets an optional MonetaryValue object from the JSON at the key passed.
static String	optString(JSONObject json, String key) Helper method that doesn't return some fake version of null if the string is null, it returns null.
static Set<String>	optStringSet(JSONObject json, String key) Loads a Set of Strings from a JSONArray of strings.

Methods inherited from class java.lang.Object

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

Method Detail

optLongNullable

public static Long optLongNullable(JSONObject json,
                                   String key)

Helper method that gets an optional nullable Long value from the JSONObject.

Parameters:

json - the JSONObject.

key - the key in json.

Returns:

Long mapping for key in json or null if no mapping exists.

optString

public static String optString(JSONObject json,
                               String key)

Helper method that doesn't return some fake version of null if the string is null, it returns null.

Parameters:

json - the JSONObject.

key - the key in json.

Returns:

String mapping for key in json or null if no mapping exists.

optIntegerSet

public static Set<Integer> optIntegerSet(JSONObject json,
                                         String key)
                                  throws JSONException

Loads a Set of Integer from a JSONArray of integers.

Parameters:

json - the object to read from.

key - the key in json.

Returns:

a set of integers loaded from the array of integers at the given key or null if either the key is not present or is set to null.

Throws:

JSONException - if the array contents aren't integers.

optStringSet

public static Set<String> optStringSet(JSONObject json,
                                       String key)
                                throws JSONException

Loads a Set of Strings from a JSONArray of strings.

Parameters:

json - the object to read from.

key - the key in json.

Returns:

a set of strings loaded from the array of strings at the given key or null if either the key is not present or is set to null.

Throws:

JSONException - if the array contents aren't strings.

optMonetaryValue

public static MonetaryValue optMonetaryValue(JSONObject json,
                                             String key)
                                      throws JSONException

Gets an optional MonetaryValue object from the JSON at the key passed.

Parameters:

json - the JSONObject to get the MonetaryValue from.

key - the key in the JSONObject to get the MonetaryValue from.

Returns:

a MonetaryValue from the parsed long or null.

Throws:

JSONException - if the parsing fails.

getMonetaryValue

public static MonetaryValue getMonetaryValue(JSONObject json,
                                             String key)
                                      throws JSONException

Gets a required MonetaryValue object from the JSON at the key passed or throws a JSONException if it's missing.

Parameters:

json - the JSONObject to get the MonetaryValue from.

key - the key in the JSONObject to get the MonetaryValue from.

Returns:

a MonetaryValue from the parsed long.

Throws:

JSONException - if the parsing fails.