org.json

Class MapBasedJSONObject

java.lang.Object

org.json.MapBasedJSONObject

All Implemented Interfaces:

JSONComponent, JSONObject

Direct Known Subclasses:

ImmutableJSONObject, WritableJSONObject

public abstract class MapBasedJSONObject
extends java.lang.Object
implements JSONObject

Field Summary

Fields inherited from interface org.json.JSONObject

EMPTY

Constructor Summary

Constructors

Constructor and Description
MapBasedJSONObject()

Method Summary

Modifier and Type	Method and Description
<A extends JSONArray,O extends JSONObject> O	clone(JSONBuilder<A,O> builder)
boolean	equals(java.lang.Object obj)
java.lang.Object	get(java.lang.String key) Get the value object associated with a key.
boolean	getBoolean(java.lang.String key) Get the boolean value associated with a key.
double	getDouble(java.lang.String key) Get the double value associated with a key.
java.lang.Double	getDoubleObj(java.lang.String key) Get the compulsory number as a Double Object throwing a JSONException if this is not possible.
int	getInt(java.lang.String key) Get the int value associated with a key.
JSONArray	getJSONArray(java.lang.String key) Get the JSONArray value associated with a key.
JSONObject	getJSONObject(java.lang.String key) Get the JSONObject value associated with a key.
long	getLong(java.lang.String key) Get the long value associated with a key.
protected abstract java.util.Map<java.lang.String,java.lang.Object>	getMap()
java.lang.String	getString(java.lang.String key) Get the string associated with a key.
boolean	has(java.lang.String key) Determine if the JSONObject contains a specific key.
int	hashCode()
boolean	isNull(java.lang.String key) Determine if the value associated with the key is null or if there is no value.
java.util.Iterator<java.lang.String>	keys() Get an enumeration of the keys of the JSONObject.
int	length() Get the number of keys stored in the JSONObject.
java.lang.Object	opt(java.lang.String key) Get an optional value associated with a key.
boolean	optBoolean(java.lang.String key) Get an optional boolean associated with a key.
boolean	optBoolean(java.lang.String key, boolean defaultValue) Get an optional boolean associated with a key.
double	optDouble(java.lang.String key) Get an optional double associated with a key, or NaN if there is no such key or if its value is not a number.
double	optDouble(java.lang.String key, double defaultValue) Get an optional double associated with a key, or the defaultValue if there is no such key or if its value is not a number.
java.lang.Double	optDoubleObj(java.lang.String key, java.lang.Double defaultValue) Get the optional number as a Double Object returning the optional defaultValue if this is not possible.
int	optInt(java.lang.String key) Get an optional int value associated with a key, or zero if there is no such key or if the value is not a number.
int	optInt(java.lang.String key, int defaultValue) Get an optional int value associated with a key, or the default if there is no such key or if the value is not a number.
java.lang.Integer	optInteger(java.lang.String key) Get an optional Integer value associated with the key, or null if there is no such key or if the value is not a number and the string representation cannot be parsed as an Integer.
java.lang.Integer	optInteger(java.lang.String key, java.lang.Integer defaultValue) Get an optional Integer value associated with the key, or the specified defaultValue if there is no such key or if the value is not a number and the string representation cannot be parsed as an Integer.
JSONArray	optJSONArray(java.lang.String key) Get an optional JSONArray associated with a key.
JSONObject	optJSONObject(java.lang.String key) Get an optional JSONObject associated with a key.
long	optLong(java.lang.String key) Get an optional long value associated with a key, or zero if there is no such key or if the value is not a number.
long	optLong(java.lang.String key, long defaultValue) Get an optional long value associated with a key, or the default if there is no such key or if the value is not a number.
java.lang.String	optString(java.lang.String key) Get an optional string associated with a key.
java.lang.String	optString(java.lang.String key, java.lang.String defaultValue) Get an optional string associated with a key.
java.util.Iterator<java.lang.String>	sortedKeys() Get an Iterator of the keys of the JSONObject.
java.lang.String	toString() Make a JSON text of this JSONObject.
java.lang.String	toString(int indentFactor) Make a prettyprinted JSON text of this JSONObject.
java.lang.String	toString(int indentFactor, int indent) Make a prettyprinted JSON text of this JSONObject.
static java.lang.String	toString(MapBasedJSONObject jObj)
java.lang.Appendable	write(java.lang.Appendable buf) Write the contents of the JSONComponent as JSON text to a writer.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.json.JSONObject

equalsMap, put, put, put, put, put, putOnce, putOpt, remove

Constructor Detail

MapBasedJSONObject

public MapBasedJSONObject()

Method Detail

getMap

protected abstract java.util.Map<java.lang.String,java.lang.Object> getMap()

opt

public final java.lang.Object opt(java.lang.String key)

Get an optional value associated with a key.

Specified by:

opt in interface JSONObject

Parameters:

key - A key string.

Returns:

An object which is the value, or null if there is no value.

getBoolean

public final boolean getBoolean(java.lang.String key)
                         throws JSONException

Get the boolean value associated with a key.

Specified by:

getBoolean in interface JSONObject

Parameters:

key - A key string.

Returns:

The truth.

Throws:

JSONException - if the value is not a Boolean or the String "true" or "false".

toString

public static java.lang.String toString(MapBasedJSONObject jObj)

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

get

public final java.lang.Object get(java.lang.String key)
                           throws JSONException

Get the value object associated with a key.

Specified by:

get in interface JSONObject

Parameters:

key - A key string.

Returns:

The object associated with the key.

Throws:

JSONException - if the key is not found.

getDouble

public final double getDouble(java.lang.String key)
                       throws JSONException

Get the double value associated with a key.

Specified by:

getDouble in interface JSONObject

Parameters:

key - A key string.

Returns:

The numeric value.

Throws:

JSONException - if the key is not found or if the value is not a Number object and cannot be converted to a number.

optDoubleObj

public final java.lang.Double optDoubleObj(java.lang.String key,
                                           java.lang.Double defaultValue)

Description copied from interface: JSONObject

Get the optional number as a Double Object returning the optional defaultValue if this is not possible.

Specified by:

optDoubleObj in interface JSONObject

getDoubleObj

public final java.lang.Double getDoubleObj(java.lang.String key)
                                    throws JSONException

Description copied from interface: JSONObject

Get the compulsory number as a Double Object throwing a JSONException if this is not possible.

Specified by:

getDoubleObj in interface JSONObject

Throws:

JSONException

getInt

public final int getInt(java.lang.String key)
                 throws JSONException

Get the int value associated with a key.

Specified by:

getInt in interface JSONObject

Parameters:

key - A key string.

Returns:

The integer value.

Throws:

JSONException - if the key is not found or if the value cannot be converted to an integer.

getJSONArray

public JSONArray getJSONArray(java.lang.String key)
                       throws JSONException

Get the JSONArray value associated with a key.

Specified by:

getJSONArray in interface JSONObject

Parameters:

key - A key string.

Returns:

A JSONArray which is the value.

Throws:

JSONException - if the key is not found or if the value is not a JSONArray.

getJSONObject

public JSONObject getJSONObject(java.lang.String key)
                         throws JSONException

Get the JSONObject value associated with a key.

Specified by:

getJSONObject in interface JSONObject

Parameters:

key - A key string.

Returns:

A JSONObject which is the value.

Throws:

JSONException - if the key is not found or if the value is not a JSONObject.

getLong

public final long getLong(java.lang.String key)
                   throws JSONException

Get the long value associated with a key.

Specified by:

getLong in interface JSONObject

Parameters:

key - A key string.

Returns:

The long value.

Throws:

JSONException - if the key is not found or if the value cannot be converted to a long.

getString

public final java.lang.String getString(java.lang.String key)
                                 throws JSONException

Get the string associated with a key.

Specified by:

getString in interface JSONObject

Parameters:

key - A key string.

Returns:

A string which is the value.

Throws:

JSONException - if the key is not found.

has

public final boolean has(java.lang.String key)

Determine if the JSONObject contains a specific key.

Specified by:

has in interface JSONObject

Parameters:

key - A key string.

Returns:

true if the key exists in the JSONObject.

isNull

public final boolean isNull(java.lang.String key)

Determine if the value associated with the key is null or if there is no value.

Specified by:

isNull in interface JSONObject

Parameters:

key - A key string.

Returns:

true if there is no value associated with the key or if the value is the JSONObject.NULL object.

keys

public final java.util.Iterator<java.lang.String> keys()

Get an enumeration of the keys of the JSONObject.

Specified by:

keys in interface JSONObject

Returns:

An iterator of the keys.

length

public final int length()

Get the number of keys stored in the JSONObject.

Specified by:

length in interface JSONObject

Returns:

The number of keys in the JSONObject.

optBoolean

public final boolean optBoolean(java.lang.String key)

Get an optional boolean associated with a key. It returns false if there is no such key, or if the value is not Boolean.TRUE or the String "true".

Specified by:

optBoolean in interface JSONObject

Parameters:

key - A key string.

Returns:

The truth.

optBoolean

public final boolean optBoolean(java.lang.String key,
                                boolean defaultValue)

Get an optional boolean associated with a key. It returns the defaultValue if there is no such key, or if it is not a Boolean or the String "true" or "false" (case insensitive).

Specified by:

optBoolean in interface JSONObject

Parameters:

key - A key string.

defaultValue - The default.

Returns:

The truth.

optDouble

public final double optDouble(java.lang.String key)

Get an optional double associated with a key, or NaN if there is no such key or if its value is not a number. If the value is a string, an attempt will be made to evaluate it as a number.

Specified by:

optDouble in interface JSONObject

Parameters:

key - A string which is the key.

Returns:

An object which is the value.

optDouble

public final double optDouble(java.lang.String key,
                              double defaultValue)

Get an optional double associated with a key, or the defaultValue if there is no such key or if its value is not a number. If the value is a string, an attempt will be made to evaluate it as a number.

Specified by:

optDouble in interface JSONObject

Parameters:

key - A key string.

defaultValue - The default.

Returns:

An object which is the value.

optInt

public final int optInt(java.lang.String key)

Get an optional int value associated with a key, or zero if there is no such key or if the value is not a number. If the value is a string, an attempt will be made to evaluate it as a number.

Specified by:

optInt in interface JSONObject

Parameters:

key - A key string.

Returns:

An object which is the value.

optInt

public final int optInt(java.lang.String key,
                        int defaultValue)

Get an optional int value associated with a key, or the default if there is no such key or if the value is not a number. If the value is a string, an attempt will be made to evaluate it as a number.

Specified by:

optInt in interface JSONObject

Parameters:

key - A key string.

defaultValue - The default.

Returns:

An object which is the value.

optInteger

public final java.lang.Integer optInteger(java.lang.String key,
                                          java.lang.Integer defaultValue)

Description copied from interface: JSONObject

Get an optional Integer value associated with the key, or the specified defaultValue if there is no such key or if the value is not a number and the string representation cannot be parsed as an Integer.

Specified by:

optInteger in interface JSONObject

optInteger

public final java.lang.Integer optInteger(java.lang.String key)

Description copied from interface: JSONObject

Get an optional Integer value associated with the key, or null if there is no such key or if the value is not a number and the string representation cannot be parsed as an Integer.

Specified by:

optInteger in interface JSONObject

optLong

public final long optLong(java.lang.String key)

Get an optional long value associated with a key, or zero if there is no such key or if the value is not a number. If the value is a string, an attempt will be made to evaluate it as a number.

Specified by:

optLong in interface JSONObject

Parameters:

key - A key string.

Returns:

An object which is the value.

optLong

public final long optLong(java.lang.String key,
                          long defaultValue)

Get an optional long value associated with a key, or the default if there is no such key or if the value is not a number. If the value is a string, an attempt will be made to evaluate it as a number.

Specified by:

optLong in interface JSONObject

Parameters:

key - A key string.

defaultValue - The default.

Returns:

An object which is the value.

optString

public final java.lang.String optString(java.lang.String key)

Get an optional string associated with a key. It returns an empty string if there is no such key. If the value is not a string and is not null, then it is converted to a string.

Specified by:

optString in interface JSONObject

Parameters:

key - A key string.

Returns:

A string which is the value.

optString

public final java.lang.String optString(java.lang.String key,
                                        java.lang.String defaultValue)

Get an optional string associated with a key. It returns the defaultValue if there is no such key.

Specified by:

optString in interface JSONObject

Parameters:

key - A key string.

defaultValue - The default.

Returns:

A string which is the value.

toString

public final java.lang.String toString()

Make a JSON text of this JSONObject. For compactness, no whitespace is added. If this would not result in a syntactically correct JSON text, then null will be returned instead.

Warning: This method assumes that the data structure is acyclical.

Specified by:

toString in interface JSONComponent

Overrides:

toString in class java.lang.Object

Returns:

a printable, displayable, portable, transmittable representation of the object, beginning with { (left brace) and ending with } (right brace).

toString

public final java.lang.String toString(int indentFactor)

Make a prettyprinted JSON text of this JSONObject.

Warning: This method assumes that the data structure is acyclical.

Specified by:

toString in interface JSONComponent

Parameters:

indentFactor - The number of spaces to add to each level of indentation.

Returns:

a printable, displayable, portable, transmittable representation of the object, beginning with { (left brace) and ending with } (right brace).

toString

public final java.lang.String toString(int indentFactor,
                                       int indent)

Make a prettyprinted JSON text of this JSONObject.

Warning: This method assumes that the data structure is acyclical.

Specified by:

toString in interface JSONComponent

Parameters:

indentFactor - The number of spaces to add to each level of indentation.

indent - The indentation of the top level.

Returns:

a printable, displayable, transmittable representation of the object, beginning with { (left brace) and ending with } (right brace).

Throws:

java.lang.RuntimeException - If the object contains an invalid number.

write

public final java.lang.Appendable write(java.lang.Appendable buf)
                                 throws java.io.IOException

Description copied from interface: JSONComponent

Write the contents of the JSONComponent as JSON text to a writer. For compactness, no whitespace is added.

Warning: This method assumes that the data structure is acyclical.

Specified by:

write in interface JSONComponent

Returns:

The writer.

Throws:

java.io.IOException

optJSONArray

public JSONArray optJSONArray(java.lang.String key)

Get an optional JSONArray associated with a key. It returns null if there is no such key, or if its value is not a JSONArray.

Specified by:

optJSONArray in interface JSONObject

Parameters:

key - A key string.

Returns:

A JSONArray which is the value.

optJSONObject

public JSONObject optJSONObject(java.lang.String key)

Get an optional JSONObject associated with a key. It returns null if there is no such key, or if its value is not a JSONObject.

Specified by:

optJSONObject in interface JSONObject

Parameters:

key - A key string.

Returns:

A JSONObject which is the value.

sortedKeys

public final java.util.Iterator<java.lang.String> sortedKeys()

Get an Iterator of the keys of the JSONObject. The keys will be sorted alphabetically.

Specified by:

sortedKeys in interface JSONObject

Returns:

An iterator of the keys.

clone

public <A extends JSONArray,O extends JSONObject> O clone(JSONBuilder<A,O> builder)
                                                   throws JSONException

Specified by:

clone in interface JSONObject

Throws:

JSONException