| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.json.JSONObject
public class JSONObject
A modifiable set of name/value mappings. Names are unique, non-null strings.
 Values may be any mix of JSONObjects, JSONArrays, Strings, Booleans, Integers, Longs, Doubles or NULL.
 Values may not be null, NaNs, infinities, or of any type not listed here.
 
This class can coerce values to another type when requested.
Number types will
       be coerced using doubleValue. Strings
       that can be coerced using Double.valueOf(String) will be.
   Number types will
       be coerced using intValue. Strings
       that can be coerced using Double.valueOf(String) will be,
       and then cast to int.
   Number types will
       be coerced using longValue. Strings
       that can be coerced using Double.valueOf(String) will be,
       and then cast to long. This two-step conversion is lossy for very
       large values. For example, the string "9223372036854775806" yields the
       long 9223372036854775807.
   String.valueOf(Object). Although null cannot be
       coerced, the sentinel value NULL is coerced to the
       string "null".
 This class can look up both mandatory and optional values:
getType() to retrieve a mandatory value. This
       fails with a JSONException if the requested name has no value
       or if the value cannot be coerced to the requested type.
   optType() to retrieve an optional value. This
       returns a system- or user-supplied default if the requested name has no
       value or if the value cannot be coerced to the requested type.
 Warning: this class represents null in two incompatible
 ways: the standard Java null reference, and the sentinel value NULL. In particular, calling put(name, null) removes the
 named entry from the object but put(name, JSONObject.NULL) stores an
 entry whose value is JSONObject.NULL.
 
Instances of this class are not thread safe. Although this class is nonfinal, it was not designed for inheritance and should not be subclassed. In particular, self-use by overrideable methods is not specified. See Effective Java Item 17, "Design and Document or inheritance or else prohibit it" for further information.
| Field Summary | |
|---|---|
| static java.lang.Object | NULLA sentinel value used to explicitly define a name with no value. | 
| Constructor Summary | |
|---|---|
| JSONObject()Creates a JSONObjectwith no name/value mappings. | |
| JSONObject(JSONObject copyFrom,
           java.lang.String[] names)Creates a new JSONObjectby copying mappings for the listed names
 from the given object. | |
| JSONObject(JSONTokener readFrom)Creates a new JSONObjectwith name/value mappings from the next
 object in the tokener. | |
| JSONObject(java.util.Map copyFrom)Creates a new JSONObjectby copying all name/value mappings from
 the given map. | |
| JSONObject(java.lang.String json)Creates a new JSONObjectwith name/value mappings from the JSON
 string. | |
| Method Summary | |
|---|---|
|  JSONObject | accumulate(java.lang.String name,
           java.lang.Object value)Appends valueto the array already mapped toname. | 
|  java.lang.Object | get(java.lang.String name)Returns the value mapped by name. | 
|  boolean | getBoolean(java.lang.String name)Returns the value mapped by nameif it exists and is a boolean or
 can be coerced to a boolean. | 
|  double | getDouble(java.lang.String name)Returns the value mapped by nameif it exists and is a double or
 can be coerced to a double. | 
|  int | getInt(java.lang.String name)Returns the value mapped by nameif it exists and is an int or
 can be coerced to an int. | 
|  JSONArray | getJSONArray(java.lang.String name)Returns the value mapped by nameif it exists and is aJSONArray. | 
|  JSONObject | getJSONObject(java.lang.String name)Returns the value mapped by nameif it exists and is aJSONObject. | 
|  long | getLong(java.lang.String name)Returns the value mapped by nameif it exists and is a long or
 can be coerced to a long. | 
|  java.lang.String | getString(java.lang.String name)Returns the value mapped by nameif it exists, coercing it if
 necessary. | 
|  boolean | has(java.lang.String name)Returns true if this object has a mapping for name. | 
|  boolean | isNull(java.lang.String name)Returns true if this object has no mapping for nameor if it has
 a mapping whose value isNULL. | 
|  java.util.Iterator | keys()Returns an iterator of the Stringnames in this object. | 
|  int | length()Returns the number of name/value mappings in this object. | 
|  JSONArray | names()Returns an array containing the string names in this object. | 
| static java.lang.String | numberToString(java.lang.Number number)Encodes the number as a JSON string. | 
|  java.lang.Object | opt(java.lang.String name)Returns the value mapped by name, or null if no such mapping
 exists. | 
|  boolean | optBoolean(java.lang.String name)Returns the value mapped by nameif it exists and is a boolean or
 can be coerced to a boolean. | 
|  boolean | optBoolean(java.lang.String name,
           boolean fallback)Returns the value mapped by nameif it exists and is a boolean or
 can be coerced to a boolean. | 
|  double | optDouble(java.lang.String name)Returns the value mapped by nameif it exists and is a double or
 can be coerced to a double. | 
|  double | optDouble(java.lang.String name,
          double fallback)Returns the value mapped by nameif it exists and is a double or
 can be coerced to a double. | 
|  int | optInt(java.lang.String name)Returns the value mapped by nameif it exists and is an int or
 can be coerced to an int. | 
|  int | optInt(java.lang.String name,
       int fallback)Returns the value mapped by nameif it exists and is an int or
 can be coerced to an int. | 
|  JSONArray | optJSONArray(java.lang.String name)Returns the value mapped by nameif it exists and is aJSONArray. | 
|  JSONObject | optJSONObject(java.lang.String name)Returns the value mapped by nameif it exists and is aJSONObject. | 
|  long | optLong(java.lang.String name)Returns the value mapped by nameif it exists and is a long or
 can be coerced to a long. | 
|  long | optLong(java.lang.String name,
        long fallback)Returns the value mapped by nameif it exists and is a long or
 can be coerced to a long. | 
|  java.lang.String | optString(java.lang.String name)Returns the value mapped by nameif it exists, coercing it if
 necessary. | 
|  java.lang.String | optString(java.lang.String name,
          java.lang.String fallback)Returns the value mapped by nameif it exists, coercing it if
 necessary. | 
|  JSONObject | put(java.lang.String name,
    boolean value)Maps nametovalue, clobbering any existing name/value
 mapping with the same name. | 
|  JSONObject | put(java.lang.String name,
    double value)Maps nametovalue, clobbering any existing name/value
 mapping with the same name. | 
|  JSONObject | put(java.lang.String name,
    int value)Maps nametovalue, clobbering any existing name/value
 mapping with the same name. | 
|  JSONObject | put(java.lang.String name,
    long value)Maps nametovalue, clobbering any existing name/value
 mapping with the same name. | 
|  JSONObject | put(java.lang.String name,
    java.lang.Object value)Maps nametovalue, clobbering any existing name/value
 mapping with the same name. | 
|  JSONObject | putOpt(java.lang.String name,
       java.lang.Object value)Equivalent to put(name, value)when both parameters are non-null;
 does nothing otherwise. | 
| static java.lang.String | quote(java.lang.String data)Encodes dataas a JSON string. | 
|  java.lang.Object | remove(java.lang.String name)Removes the named mapping if it exists; does nothing otherwise. | 
|  JSONArray | toJSONArray(JSONArray names)Returns an array with the values corresponding to names. | 
|  java.lang.String | toString()Encodes this object as a compact JSON string, such as: | 
|  java.lang.String | toString(int indentSpaces)Encodes this object as a human readable JSON string for debugging, such as: | 
| static java.lang.Object | wrap(java.lang.Object o)Wraps the given object if necessary. | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait | 
| Field Detail | 
|---|
public static final java.lang.Object NULL
null, names with this value:
 names() array
   keys() iterator
   true for has(String)
   get(String)
   This value violates the general contract of Object.equals(java.lang.Object) by
 returning true when compared to null. Its toString()
 method returns "null".
| Constructor Detail | 
|---|
public JSONObject()
JSONObject with no name/value mappings.
public JSONObject(java.util.Map copyFrom)
JSONObject by copying all name/value mappings from
 the given map.
copyFrom - a map whose keys are of type String and whose
     values are of supported types.
java.lang.NullPointerException - if any of the map's keys are null.
public JSONObject(JSONTokener readFrom)
           throws JSONException
JSONObject with name/value mappings from the next
 object in the tokener.
readFrom - a tokener whose nextValue() method will yield a
     JSONObject.
JSONException - if the parse fails or doesn't yield a
     JSONObject.
public JSONObject(java.lang.String json)
           throws JSONException
JSONObject with name/value mappings from the JSON
 string.
json - a JSON-encoded string containing an object.
JSONException - if the parse fails or doesn't yield a JSONObject.
public JSONObject(JSONObject copyFrom,
                  java.lang.String[] names)
           throws JSONException
JSONObject by copying mappings for the listed names
 from the given object. Names that aren't present in copyFrom will
 be skipped.
JSONException| Method Detail | 
|---|
public int length()
public JSONObject put(java.lang.String name,
                      boolean value)
               throws JSONException
name to value, clobbering any existing name/value
 mapping with the same name.
JSONException
public JSONObject put(java.lang.String name,
                      double value)
               throws JSONException
name to value, clobbering any existing name/value
 mapping with the same name.
value - a finite value. May not be NaNs or
     infinities.
JSONException
public JSONObject put(java.lang.String name,
                      int value)
               throws JSONException
name to value, clobbering any existing name/value
 mapping with the same name.
JSONException
public JSONObject put(java.lang.String name,
                      long value)
               throws JSONException
name to value, clobbering any existing name/value
 mapping with the same name.
JSONException
public JSONObject put(java.lang.String name,
                      java.lang.Object value)
               throws JSONException
name to value, clobbering any existing name/value
 mapping with the same name. If the value is null, any existing
 mapping for name is removed.
value - a JSONObject, JSONArray, String, Boolean,
     Integer, Long, Double, NULL, or null. May not be
     NaNs or infinities.
JSONException
public JSONObject putOpt(java.lang.String name,
                         java.lang.Object value)
                  throws JSONException
put(name, value) when both parameters are non-null;
 does nothing otherwise.
JSONException
public JSONObject accumulate(java.lang.String name,
                             java.lang.Object value)
                      throws JSONException
value to the array already mapped to name. If
 this object has no mapping for name, this inserts a new mapping.
 If the mapping exists but its value is not an array, the existing
 and new values are inserted in order into a new array which is itself
 mapped to name. In aggregate, this allows values to be added to a
 mapping one at a time.
value - a JSONObject, JSONArray, String, Boolean,
     Integer, Long, Double, NULL or null. May not be NaNs or infinities.
JSONExceptionpublic java.lang.Object remove(java.lang.String name)
name, or null if there was
     no such mapping.public boolean isNull(java.lang.String name)
name or if it has
 a mapping whose value is NULL.
public boolean has(java.lang.String name)
name. The mapping
 may be NULL.
public java.lang.Object get(java.lang.String name)
                     throws JSONException
name.
JSONException - if no such mapping exists.public java.lang.Object opt(java.lang.String name)
name, or null if no such mapping
 exists.
public boolean getBoolean(java.lang.String name)
                   throws JSONException
name if it exists and is a boolean or
 can be coerced to a boolean.
JSONException - if the mapping doesn't exist or cannot be coerced
     to a boolean.public boolean optBoolean(java.lang.String name)
name if it exists and is a boolean or
 can be coerced to a boolean. Returns false otherwise.
public boolean optBoolean(java.lang.String name,
                          boolean fallback)
name if it exists and is a boolean or
 can be coerced to a boolean. Returns fallback otherwise.
public double getDouble(java.lang.String name)
                 throws JSONException
name if it exists and is a double or
 can be coerced to a double.
JSONException - if the mapping doesn't exist or cannot be coerced
     to a double.public double optDouble(java.lang.String name)
name if it exists and is a double or
 can be coerced to a double. Returns NaN otherwise.
public double optDouble(java.lang.String name,
                        double fallback)
name if it exists and is a double or
 can be coerced to a double. Returns fallback otherwise.
public int getInt(java.lang.String name)
           throws JSONException
name if it exists and is an int or
 can be coerced to an int.
JSONException - if the mapping doesn't exist or cannot be coerced
     to an int.public int optInt(java.lang.String name)
name if it exists and is an int or
 can be coerced to an int. Returns 0 otherwise.
public int optInt(java.lang.String name,
                  int fallback)
name if it exists and is an int or
 can be coerced to an int. Returns fallback otherwise.
public long getLong(java.lang.String name)
             throws JSONException
name if it exists and is a long or
 can be coerced to a long. Note that JSON represents numbers as doubles,
 so this is lossy; use strings to transfer numbers via JSON.
JSONException - if the mapping doesn't exist or cannot be coerced
     to a long.public long optLong(java.lang.String name)
name if it exists and is a long or
 can be coerced to a long. Returns 0 otherwise. Note that JSON represents numbers as doubles,
 so this is lossy; use strings to transfer numbers via JSON.
public long optLong(java.lang.String name,
                    long fallback)
name if it exists and is a long or
 can be coerced to a long. Returns fallback otherwise. Note that JSON represents
 numbers as doubles, so this is lossy; use strings to transfer
 numbers via JSON.
public java.lang.String getString(java.lang.String name)
                           throws JSONException
name if it exists, coercing it if
 necessary.
JSONException - if no such mapping exists.public java.lang.String optString(java.lang.String name)
name if it exists, coercing it if
 necessary. Returns the empty string if no such mapping exists.
public java.lang.String optString(java.lang.String name,
                                  java.lang.String fallback)
name if it exists, coercing it if
 necessary. Returns fallback if no such mapping exists.
public JSONArray getJSONArray(java.lang.String name)
                       throws JSONException
name if it exists and is a JSONArray.
JSONException - if the mapping doesn't exist or is not a JSONArray.public JSONArray optJSONArray(java.lang.String name)
name if it exists and is a JSONArray. Returns null otherwise.
public JSONObject getJSONObject(java.lang.String name)
                         throws JSONException
name if it exists and is a JSONObject.
JSONException - if the mapping doesn't exist or is not a JSONObject.public JSONObject optJSONObject(java.lang.String name)
name if it exists and is a JSONObject. Returns null otherwise.
public JSONArray toJSONArray(JSONArray names)
                      throws JSONException
names. The
 array contains null for names that aren't mapped. This method returns
 null if names is either null or empty.
JSONExceptionpublic java.util.Iterator keys()
String names in this object. The
 returned iterator supports remove, which will
 remove the corresponding mapping from this object. If this object is
 modified after the iterator is returned, the iterator's behavior is
 undefined. The order of the keys is undefined.
public JSONArray names()
public java.lang.String toString()
{"query":"Pizza","locations":[94043,90210]}
toString in class java.lang.Object
public java.lang.String toString(int indentSpaces)
                          throws JSONException
 {
     "query": "Pizza",
     "locations": [
         94043,
         90210
     ]
 }
indentSpaces - the number of spaces to indent for each level of
     nesting.
JSONException
public static java.lang.String numberToString(java.lang.Number number)
                                       throws JSONException
number - a finite value. May not be NaNs or
     infinities.
JSONExceptionpublic static java.lang.String quote(java.lang.String data)
data as a JSON string. This applies quotes and any
 necessary character escaping.
data - the string to encode. Null will be interpreted as an empty
     string.public static java.lang.Object wrap(java.lang.Object o)
If the object is null or , returns NULL.
 If the object is a JSONArray or JSONObject, no wrapping is necessary.
 If the object is NULL, no wrapping is necessary.
 If the object is an array or Collection, returns an equivalent JSONArray.
 If the object is a Map, returns an equivalent JSONObject.
 If the object is a primitive wrapper type or String, returns the object.
 Otherwise if the object is from a java package, returns the result of toString.
 If wrapping fails, returns null.
| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||