org.json

Class JSONObject

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

org.json.JSONObject

All Implemented Interfaces:

Serializable, Cloneable, Map

public class JSONObject
extends HashMap

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
JSONObject()
JSONObject(Map m)
JSONObject(String jsonStr)

Method Summary

Modifier and Type	Method and Description
JSONObject	append(String key, Object value) Append values to the array under a key.
static String[]	getNames(JSONObject json)
int	length()
static String	numberToString(Number n) Produce a string from a Number.
Object	opt(String e)
JSONObject	put(String key, boolean value) Put a key/boolean pair in the JSONObject.
JSONObject	put(String key, double value) Put a key/double pair in the JSONObject.
JSONObject	put(String key, int value) Put a key/int pair in the JSONObject.
JSONObject	put(String key, long value) Put a key/long pair in the JSONObject.
JSONObject	put(String key, Map value) Put a key/value pair in the JSONObject, where the value will be a JSONObject which is produced from a Map.
JSONObject	put(String key, Object value)
static String	quote(String string) Produce a string in double quotes with backslash sequences in all the right places.
String	toString()

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

JSONObject

public JSONObject()

JSONObject

public JSONObject(String jsonStr)
           throws JSONException

Throws:

JSONException

JSONObject

public JSONObject(Map m)

Method Detail

length

public int length()

getNames

public static String[] getNames(JSONObject json)

opt

public Object opt(String e)

toString

public String toString()

Overrides:

toString in class AbstractMap

put

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

Throws:

JSONException

put

public JSONObject put(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

public JSONObject put(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

public JSONObject put(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

public JSONObject put(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

public JSONObject put(String key,
                      Map value)
               throws JSONException

Put a key/value pair in the JSONObject, where the value will be a JSONObject which is produced from a Map.

Parameters:

key - A key string.

value - A Map value.

Returns:

this.

Throws:

JSONException - If o is a non-finite number.

append

public JSONObject append(String key,
                         Object value)
                  throws JSONException

Append values to the array under a key. If the key does not exist in the JSONObject, then the key is put in the JSONObject with its value being a JSONArray containing the value parameter. If the key was already associated with a JSONArray, then the value parameter is appended to it.

Parameters:

key - A key string.

value - An object to be accumulated under the key.

Returns:

this.

Throws:

JSONException - If the key is null or if the current value associated with the key is not a JSONArray.

numberToString

public static String numberToString(Number n)
                             throws JSONException

Produce a string from a Number.

Parameters:

n - A Number

Returns:

A String.

Throws:

JSONException - If n is a non-finite number.

quote

public static String quote(String string)

Produce a string in double quotes with backslash sequences in all the right places. A backslash will be inserted within >/, allowing JSON text to be delivered in HTML. In JSON text, a string cannot contain a control character or an unescaped quote or backslash.

Parameters:

string - A String

Returns:

A String correctly formatted for insertion in a JSON text.