org.json

Interface JSONObject

All Superinterfaces:

JSONComponent

All Known Implementing Classes:

AbstractUnmodifiableJSONObject, ImmutableJSONObject, MapBasedJSONObject, UnmodifiableJSONObject, WritableJSONObject

public interface JSONObject
extends JSONComponent

Field Summary

Fields

Modifier and Type	Field and Description
static JSONObject	EMPTY Deprecated. in preference of ImmutableJSON.emptyJSONObject()

Method Summary

Modifier and Type	Method and Description
<A extends JSONArray,O extends JSONObject> O	clone(JSONBuilder<A,O> builder)
boolean	equalsMap(java.util.Map<java.lang.String,java.lang.Object> map)
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.
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.
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.
JSONObject	put(java.lang.String key, boolean value) Put a key/boolean pair in the JSONObject.
JSONObject	put(java.lang.String key, double value) Put a key/double pair in the JSONObject.
JSONObject	put(java.lang.String key, int value) Put a key/int pair in the JSONObject.
JSONObject	put(java.lang.String key, long value) Put a key/long pair in the JSONObject.
JSONObject	put(java.lang.String key, java.lang.Object value) Put a key/value pair in the JSONObject.
JSONObject	putOnce(java.lang.String key, java.lang.Object value) Put a key/value pair in the JSONObject, but only if the key and the value are both non-null, and only if there is not already a member with that name.
JSONObject	putOpt(java.lang.String key, java.lang.Object value) Put a key/value pair in the JSONObject, but only if the key and the value are both non-null.
java.lang.Object	remove(java.lang.String key) Remove a name and its value, if present.
java.util.Iterator<java.lang.String>	sortedKeys() Get an enumeration of the keys of the JSONObject.

Methods inherited from interface org.json.JSONComponent

toString, toString, toString, write

Field Detail

EMPTY

@Deprecated
static final JSONObject EMPTY

Deprecated. in preference of ImmutableJSON.emptyJSONObject()

Method Detail

equalsMap

boolean equalsMap(java.util.Map<java.lang.String,java.lang.Object> map)

clone

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

Throws:

JSONException

get

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

Get the value object associated with a key.

Parameters:

key - A key string.

Returns:

The object associated with the key.

Throws:

JSONException - if the key is not found.

getBoolean

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

Get the boolean value associated with a key.

Parameters:

key - A key string.

Returns:

The truth.

Throws:

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

getDouble

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

Get the double value associated with a key.

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.

getInt

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

Get the int value associated with a key.

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

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

Get the JSONArray value associated with a key.

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

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

Get the JSONObject value associated with a key.

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

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

Get the long value associated with a key.

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

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

Get the string associated with a key.

Parameters:

key - A key string.

Returns:

A string which is the value.

Throws:

JSONException - if the key is not found.

has

boolean has(java.lang.String key)

Determine if the JSONObject contains a specific key.

Parameters:

key - A key string.

Returns:

true if the key exists in the JSONObject.

isNull

boolean isNull(java.lang.String key)

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

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

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

Get an enumeration of the keys of the JSONObject.

Returns:

An iterator of the keys.

length

int length()

Get the number of keys stored in the JSONObject.

Returns:

The number of keys in the JSONObject.

opt

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

Get an optional value associated with a key.

Parameters:

key - A key string.

Returns:

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

optBoolean

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".

Parameters:

key - A key string.

Returns:

The truth.

optBoolean

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).

Parameters:

key - A key string.

defaultValue - The default.

Returns:

The truth.

optDouble

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.

Parameters:

key - A string which is the key.

Returns:

An object which is the value.

optDouble

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.

Parameters:

key - A key string.

defaultValue - The default.

Returns:

An object which is the value.

getDoubleObj

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

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

Throws:

JSONException

optDoubleObj

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.

optInt

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.

Parameters:

key - A key string.

Returns:

An object which is the value.

optInteger

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.

optInt

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.

Parameters:

key - A key string.

defaultValue - The default.

Returns:

An object which is the value.

optInteger

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.

optJSONArray

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.

Parameters:

key - A key string.

Returns:

A JSONArray which is the value.

optJSONObject

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.

Parameters:

key - A key string.

Returns:

A JSONObject which is the value.

optLong

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.

Parameters:

key - A key string.

Returns:

An object which is the value.

optLong

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.

Parameters:

key - A key string.

defaultValue - The default.

Returns:

An object which is the value.

optString

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.

Parameters:

key - A key string.

Returns:

A string which is the value.

optString

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.

Parameters:

key - A key string.

defaultValue - The default.

Returns:

A string which is the value.

put

JSONObject put(java.lang.String key,
               boolean value)
        throws JSONException

Put a key/boolean pair in the JSONObject.

Parameters:

key - A key string.

value - A boolean which is the value.

Returns:

this.

Throws:

JSONException - If the key is null.

put

JSONObject put(java.lang.String key,
               double value)
        throws JSONException

Put a key/double pair in the JSONObject.

Parameters:

key - A key string.

value - A double which is the value.

Returns:

this.

Throws:

JSONException - If the key is null or if the number is invalid.

put

JSONObject put(java.lang.String key,
               int value)
        throws JSONException

Put a key/int pair in the JSONObject.

Parameters:

key - A key string.

value - An int which is the value.

Returns:

this.

Throws:

JSONException - If the key is null.

put

JSONObject put(java.lang.String key,
               long value)
        throws JSONException

Put a key/long pair in the JSONObject.

Parameters:

key - A key string.

value - A long which is the value.

Returns:

this.

Throws:

JSONException - If the key is null.

put

JSONObject put(java.lang.String key,
               java.lang.Object value)
        throws JSONException

Put a key/value pair in the JSONObject. If the value is null, then the key will be removed from the JSONObject if it is present.

Parameters:

key - A key string.

value - An object which is the value. It should be of one of these types: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONObject.NULL object.

Returns:

this.

Throws:

JSONException - If the value is non-finite number or if the key is null.

putOnce

JSONObject putOnce(java.lang.String key,
                   java.lang.Object value)
            throws JSONException

Put a key/value pair in the JSONObject, but only if the key and the value are both non-null, and only if there is not already a member with that name.

Parameters:

key -

value -

Returns:

his.

Throws:

JSONException - if the key is a duplicate

putOpt

JSONObject putOpt(java.lang.String key,
                  java.lang.Object value)
           throws JSONException

Put a key/value pair in the JSONObject, but only if the key and the value are both non-null.

Parameters:

key - A key string.

value - An object which is the value. It should be of one of these types: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONObject.NULL object.

Returns:

this.

Throws:

JSONException - If the value is a non-finite number.

remove

java.lang.Object remove(java.lang.String key)

Remove a name and its value, if present.

Parameters:

key - The name to be removed.

Returns:

The value that was associated with the name, or null if there was no value.

sortedKeys

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

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

Returns:

An iterator of the keys.