com.scvngr.levelup.core.model.factory.json

Class JsonModelHelper

java.lang.Object

com.scvngr.levelup.core.model.factory.json.JsonModelHelper

public final class JsonModelHelper
extends Object

A class to make it easier to extract LevelUp model information from a JSON object.

Constructor Summary

Constructors

Constructor and Description
JsonModelHelper(JSONObject jsonObject)

Method Summary

Modifier and Type	Method and Description
Object	get(String name)
boolean	getBoolean(String name)
double	getDouble(String name)
int	getInt(String key)
JSONArray	getJSONArray(String name)
JSONObject	getJSONObject(String name)
long	getLong(String name)
MonetaryValue	getMonetaryValue(String name)
String	getString(String name)
boolean	has(String name)
boolean	isNull(String name) Returns true if this object has no mapping for name or if it has a mapping whose value is JSONObject.NULL.
Object	opt(String name)
boolean	optBoolean(String name)
boolean	optBoolean(String name, boolean fallback)
double	optDouble(String name)
double	optDouble(String name, double fallback)
int	optInt(String name)
int	optInt(String name, int fallback)
JSONArray	optJSONArray(String name)
JSONObject	optJSONObject(String name)
long	optLong(String name)
long	optLong(String name, long fallback)
Long	optLongNullable(String name)
MonetaryValue	optMonetaryValue(String name)
String	optString(String name)
String	optString(String name, String fallback)
Set<String>	optStringSet(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonModelHelper

public JsonModelHelper(JSONObject jsonObject)

Parameters:

jsonObject - the JSON object to retrieve values from.

Method Detail

get

public Object get(String name)
           throws JSONException

Parameters:

name - the key name.

Returns:

the value at the given key.

Throws:

JSONException - if no such mapping exists.

See Also:

JSONObject.get(String)

getBoolean

public boolean getBoolean(String name)
                   throws JSONException

Parameters:

name - the key name.

Returns:

the value at the given key.

Throws:

JSONException - if the value cannot be coerced into a boolean.

See Also:

JSONObject.getBoolean(String)

getDouble

public double getDouble(String name)
                 throws JSONException

Parameters:

name - the key name.

Returns:

the value at the given key.

Throws:

JSONException - if the value cannot be coerced into a double.

See Also:

JSONObject.getDouble(String)

getInt

public int getInt(String key)
           throws JSONException

Parameters:

key - the key name.

Returns:

the value at the given key.

Throws:

JSONException - if the value cannot be coerced into an int.

See Also:

JSONObject.getInt(String)

getJSONArray

public JSONArray getJSONArray(String name)
                       throws JSONException

Parameters:

name - the key name.

Returns:

the value at the given key.

Throws:

JSONException - if the value cannot be coerced into a JSONArray.

See Also:

JSONObject.getJSONArray(String)

getJSONObject

public JSONObject getJSONObject(String name)
                         throws JSONException

Parameters:

name - the key name.

Returns:

the value at the given key.

Throws:

JSONException - if the value cannot be coerced into a JSONObject.

See Also:

JSONObject.getJSONObject(String)

getLong

public long getLong(String name)
             throws JSONException

Parameters:

name - the key name.

Returns:

the value at the given key.

Throws:

JSONException - if the value cannot be coerced into an long.

See Also:

JSONObject.getLong(String)

getMonetaryValue

public MonetaryValue getMonetaryValue(String name)
                               throws JSONException

Parameters:

name - the key name.

Returns:

the value at the given key.

Throws:

JSONException - if the value isn't a number or is missing.

getString

public String getString(String name)
                 throws JSONException

Parameters:

name - the key name.

Returns:

the value at the given key.

Throws:

JSONException - if the value cannot be coerced into an String.

See Also:

JSONObject.getString(String)

isNull

public boolean isNull(String name)

Returns true if this object has no mapping for name or if it has a mapping whose value is JSONObject.NULL.

Parameters:

name - the name of the object to check for.

Returns:

true if the mapping is null or missing; false otherwise.

has

public boolean has(String name)

Parameters:

name - the name of the object to check for.

Returns:

if the JSONObject has a value for the name passed.

opt

public Object opt(String name)

Parameters:

name - the key name.

Returns:

the value at the given key name or null if it is missing.

See Also:

JSONObject.opt(String)

optBoolean

public boolean optBoolean(String name)

Parameters:

name - the key name.

Returns:

the value at the given key or false if it cannot be coerced into a boolean

See Also:

JSONObject.optBoolean(String)

optBoolean

public boolean optBoolean(String name,
                          boolean fallback)

Parameters:

name - the key name.

fallback - the value to be returned if the mapping is missing or null.

Returns:

the value at the given key or fallback if it's null.

See Also:

JSONObject.optBoolean(String, boolean)

optDouble

public double optDouble(String name)

Parameters:

name - the key name.

Returns:

the value at the given key or 0.0d if it cannot be coerced into a double.

See Also:

JSONObject.optDouble(String)

optDouble

public double optDouble(String name,
                        double fallback)

Parameters:

name - the key name.

fallback - the value to be returned if the mapping is missing or null.

Returns:

the value at the given key or fallback if it's null.

See Also:

JSONObject.optDouble(String, double)

optInt

public int optInt(String name)

Parameters:

name - the key name.

Returns:

a long value at the given key or 0 if it cannot be coerced into an int.

See Also:

JSONObject.optInt(String)

optInt

public int optInt(String name,
                  int fallback)

Parameters:

name - the key name.

fallback - the value to be returned if the mapping is missing or null.

Returns:

a long value at the given key or fallback if it's null.

See Also:

JSONObject.optLong(String, long)

optJSONArray

public JSONArray optJSONArray(String name)

Parameters:

name - the key name.

Returns:

the mapped value at the given key if it's a JSONArray or null otherwise.

See Also:

JSONObject.optJSONArray(String)

optJSONObject

public JSONObject optJSONObject(String name)

Parameters:

name - the key name.

Returns:

the mapped value at the given key if it's a JSONObject or null otherwise.

See Also:

JSONObject.optJSONObject(String)

optLong

public long optLong(String name)

Parameters:

name - the key name.

Returns:

the value at the given key or 0L if it's null.

optLong

public long optLong(String name,
                    long fallback)

Parameters:

name - the key name.

fallback - the fallback value if the mapping is missing or null.

Returns:

a long value at the given key or fallback if it's null.

See Also:

JSONObject.optLong(String, long)

optLongNullable

public Long optLongNullable(String name)

Parameters:

name - the key name.

Returns:

the value at the given key or null if it's null.

optMonetaryValue

public MonetaryValue optMonetaryValue(String name)
                               throws JSONException

Parameters:

name - the key name.

Returns:

the value at the given key or null if it's null or missing.

Throws:

JSONException - if the value isn't a number.

optString

public String optString(String name)

Parameters:

name - the key name.

Returns:

the value at the given key or null if it's null or missing.

See Also:

JsonUtils.optString(JSONObject, String)

optString

public String optString(String name,
                        String fallback)

Parameters:

name - the key name.

fallback - the fallback value if the mapping is missing or null.

Returns:

the value at the given key or fallback if it's null.

See Also:

JSONObject.optString(String, String)

optStringSet

public Set<String> optStringSet(String name)
                         throws JSONException

Parameters:

name - the key name.

Returns:

the value at the given key or null if it's null or missing.

Throws:

JSONException - if the array contents aren't strings

See Also:

JsonUtils.optStringSet(JSONObject, String)