org.json

Class WritableJSONObject

java.lang.Object

org.json.MapBasedJSONObject

org.json.WritableJSONObject

All Implemented Interfaces:

java.lang.Cloneable, JSONComponent, JSONObject

public class WritableJSONObject
extends MapBasedJSONObject
implements java.lang.Cloneable

A JSONObject is an unordered collection of name/value pairs. Its external form is a string wrapped in curly braces with colons between the names and values, and commas between the values and names. The internal form is an object having get and opt methods for accessing the values by name, and put methods for adding or replacing values by name. The values can be any of these types: Boolean, JSONArray, JSONObject, Number, String, or the JSONObject.NULL object. A JSONObject constructor can be used to convert an external form JSON text into an internal form whose values can be retrieved with the get and opt methods, or to convert values into a JSON text using the put and toString methods. A get method returns a value if one can be found, and throws an exception if one cannot be found. An opt method returns a default value instead of throwing an exception, and so is useful for obtaining optional values.

The generic get() and opt() methods return an object, which you can cast or query for type. There are also typed get and opt methods that do type checking and type coercion for you. The opt methods differ from the get methods in that they do not throw. Instead, they return a specified value, such as null.

The put methods add or replace values in an object. For example,

 myString = new JSONObject().put("JSON", "Hello, World!").toString();
 

produces the string {"JSON": "Hello, World"}.

The texts produced by the toString methods strictly conform to the JSON syntax rules. The constructors are more forgiving in the texts they will accept:

• An extra , (comma) may appear just before the closing brace.
• Strings may be quoted with ' (single quote).
• Strings do not need to be quoted at all if they do not begin with a quote or single quote, and if they do not contain leading or trailing spaces, and if they do not contain any of these characters: { } [ ] / \ : , = ; # and if they do not look like numbers and if they are not the reserved words true, false, or null.
• Keys can be followed by = or => as well as by :.
• Values can be followed by ; (semicolon) as well as by , (comma).
• Numbers may have the 0x- (hex) prefix.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WritableJSONObject.Builder

Field Summary

Fields inherited from interface org.json.JSONObject

EMPTY

Constructor Summary

Constructors

Constructor and Description
WritableJSONObject() Construct an empty JSONObject.
WritableJSONObject(java.lang.String baseName, java.util.Locale locale) Construct a JSONObject from a ResourceBundle.

Method Summary

Modifier and Type	Method and Description
WritableJSONObject	clone()
static WritableJSONObject	create(java.lang.String source)
boolean	equalsMap(java.util.Map<java.lang.String,java.lang.Object> map)
WritableJSONArray	getJSONArray(java.lang.String key) Get the JSONArray value associated with a key.
WritableJSONObject	getJSONObject(java.lang.String key) Get the JSONObject value associated with a key.
static com.google.common.base.Supplier<WritableJSONObject.Builder>	getJSONObjectBuilderSupplier()
protected java.util.Map<java.lang.String,java.lang.Object>	getMap()
WritableJSONArray	optJSONArray(java.lang.String key) Get an optional JSONArray associated with a key.
WritableJSONObject	optJSONObject(java.lang.String key) Get an optional JSONObject associated with a key.
WritableJSONObject	put(java.lang.String key, boolean value) Put a key/boolean pair in the JSONObject.
WritableJSONObject	put(java.lang.String key, double value) Put a key/double pair in the JSONObject.
WritableJSONObject	put(java.lang.String key, int value) Put a key/int pair in the JSONObject.
WritableJSONObject	put(java.lang.String key, long value) Put a key/long pair in the JSONObject.
WritableJSONObject	put(java.lang.String key, java.lang.Object value) Put a key/value pair in the JSONObject.
WritableJSONObject	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.
WritableJSONObject	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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

WritableJSONObject

public WritableJSONObject()

Construct an empty JSONObject.

WritableJSONObject

public WritableJSONObject(java.lang.String baseName,
                          java.util.Locale locale)
                   throws JSONException

Construct a JSONObject from a ResourceBundle.

Parameters:

baseName - The ResourceBundle base name.

locale - The Locale to load the ResourceBundle for.

Throws:

JSONException - If any JSONExceptions are detected.

Method Detail

create

public static WritableJSONObject create(java.lang.String source)
                                 throws JSONException

Throws:

JSONException

See Also:

JSONBuilder.toJSONObject(String)

getJSONObjectBuilderSupplier

public static com.google.common.base.Supplier<WritableJSONObject.Builder> getJSONObjectBuilderSupplier()

getMap

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

Specified by:

getMap in class MapBasedJSONObject

clone

public WritableJSONObject clone()

Overrides:

clone in class java.lang.Object

equalsMap

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

Specified by:

equalsMap in interface JSONObject

getJSONArray

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

Description copied from class: MapBasedJSONObject

Get the JSONArray value associated with a key.

Specified by:

getJSONArray in interface JSONObject

Overrides:

getJSONArray in class MapBasedJSONObject

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 WritableJSONObject getJSONObject(java.lang.String key)
                                 throws JSONException

Get the JSONObject value associated with a key.

Specified by:

getJSONObject in interface JSONObject

Overrides:

getJSONObject in class MapBasedJSONObject

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.

optJSONArray

public WritableJSONArray 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

Overrides:

optJSONArray in class MapBasedJSONObject

Parameters:

key - A key string.

Returns:

A JSONArray which is the value.

optJSONObject

public WritableJSONObject 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

Overrides:

optJSONObject in class MapBasedJSONObject

Parameters:

key - A key string.

Returns:

A JSONObject which is the value.

put

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

Put a key/boolean pair in the JSONObject.

Specified by:

put in interface JSONObject

Parameters:

key - A key string.

value - A boolean which is the value.

Returns:

this.

Throws:

JSONException - If the key is null.

put

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

Put a key/double pair in the JSONObject.

Specified by:

put in interface 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 WritableJSONObject put(java.lang.String key,
                              int value)
                       throws JSONException

Put a key/int pair in the JSONObject.

Specified by:

put in interface JSONObject

Parameters:

key - A key string.

value - An int which is the value.

Returns:

this.

Throws:

JSONException - If the key is null.

put

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

Put a key/long pair in the JSONObject.

Specified by:

put in interface JSONObject

Parameters:

key - A key string.

value - A long which is the value.

Returns:

this.

Throws:

JSONException - If the key is null.

put

public WritableJSONObject 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.

Specified by:

put in interface JSONObject

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

Specified by:

putOnce in interface JSONObject

Parameters:

key -

value -

Returns:

his.

Throws:

JSONException - if the key is a duplicate

putOpt

public WritableJSONObject 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.

Specified by:

putOpt in interface JSONObject

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)

Remove a name and its value, if present.

Specified by:

remove in interface JSONObject

Parameters:

key - The name to be removed.

Returns:

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