org.json

Class ImmutableJSONObject

java.lang.Object

org.json.MapBasedJSONObject

org.json.ImmutableJSONObject

All Implemented Interfaces:

JSONComponent, JSONObject

public class ImmutableJSONObject
extends MapBasedJSONObject

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableJSONObject.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected static ImmutableJSONObject	EMPTY

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)
protected com.google.common.collect.ImmutableMap<java.lang.String,java.lang.Object>	getMap()
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.

Methods inherited from class org.json.MapBasedJSONObject

equals, get, getBoolean, getDouble, getDoubleObj, getInt, getJSONArray, getJSONObject, getLong, getString, has, hashCode, isNull, keys, length, opt, optBoolean, optBoolean, optDouble, optDouble, optDoubleObj, optInt, optInt, optInteger, optInteger, optJSONArray, optJSONObject, optLong, optLong, optString, optString, sortedKeys, toString, toString, toString, toString, write

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

protected static final ImmutableJSONObject EMPTY

Method Detail

equalsMap

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

clone

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

Specified by:

clone in interface JSONObject

Overrides:

clone in class MapBasedJSONObject

Throws:

JSONException

put

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

Description copied from interface: JSONObject

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

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

Description copied from interface: JSONObject

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

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

Description copied from interface: JSONObject

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

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

Description copied from interface: JSONObject

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

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

Description copied from interface: JSONObject

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

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

Description copied from interface: JSONObject

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.

Returns:

his.

Throws:

JSONException - if the key is a duplicate

putOpt

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

Description copied from interface: JSONObject

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

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

Description copied from interface: JSONObject

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.

getMap

protected com.google.common.collect.ImmutableMap<java.lang.String,java.lang.Object> getMap()

Specified by:

getMap in class MapBasedJSONObject