Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Fields](https://developer.android.com/reference/org/json/JSONObject#lfields) \| [Ctors](https://developer.android.com/reference/org/json/JSONObject#pubctors) \| [Methods](https://developer.android.com/reference/org/json/JSONObject#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/org/json/JSONObject#inhmethods)

# JSONObject

` public class JSONObject `   
` extends https://developer.android.com/reference/java/lang/Object ` ` `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | org.json.JSONObject |

<br />

*** ** * ** ***

A modifiable set of name/value mappings. Names are unique, non-null strings. Values may be any mix of `https://developer.android.com/reference/org/json/JSONObject`, `https://developer.android.com/reference/org/json/JSONArray`, Strings, Booleans, Integers, Longs, Doubles or `https://developer.android.com/reference/org/json/JSONObject#NULL`. Values may not be `null`, `https://developer.android.com/reference/java/lang/Double#isNaN()`, `https://developer.android.com/reference/java/lang/Double#isInfinite()`, or of any type not listed here.

This class can coerce values to another type when requested.

- When the requested type is a boolean, strings will be coerced using a case-insensitive comparison to "true" and "false".
- When the requested type is a double, other `https://developer.android.com/reference/java/lang/Number` types will be coerced using `https://developer.android.com/reference/java/lang/Number#doubleValue()`. Strings that can be coerced using `https://developer.android.com/reference/java/lang/Double#valueOf(java.lang.String)` will be.
- When the requested type is an int, other `https://developer.android.com/reference/java/lang/Number` types will be coerced using `https://developer.android.com/reference/java/lang/Number#intValue()`. Strings that can be coerced using `https://developer.android.com/reference/java/lang/Double#valueOf(java.lang.String)` will be, and then cast to int.
- When the requested type is a long, other `https://developer.android.com/reference/java/lang/Number` types will be coerced using `https://developer.android.com/reference/java/lang/Number#longValue()`. Strings that can be coerced using `https://developer.android.com/reference/java/lang/Double#valueOf(java.lang.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.
- When the requested type is a String, other non-null values will be coerced using `https://developer.android.com/reference/java/lang/String#valueOf(java.lang.Object)`. Although null cannot be coerced, the sentinel value `https://developer.android.com/reference/org/json/JSONObject#NULL` is coerced to the string "null".

This class can look up both mandatory and optional values:

- Use `get*Type*()` 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.
- Use `opt*Type*()` 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 `https://developer.android.com/reference/org/json/JSONObject#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, 3rd edition* Item 19, "Design and Document for inheritance or else prohibit it" for further information.

## Summary

| ### Fields ||
|---|---|
| ` public static final https://developer.android.com/reference/java/lang/Object` | `https://developer.android.com/reference/org/json/JSONObject#NULL` A sentinel value used to explicitly define a name with no value. |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/org/json/JSONObject#JSONObject()() ` Creates a `JSONObject` with no name/value mappings. |
| ` https://developer.android.com/reference/org/json/JSONObject#JSONObject(java.lang.String)(https://developer.android.com/reference/java/lang/String json) ` Creates a new `JSONObject` with name/value mappings from the JSON string. |
| ` https://developer.android.com/reference/org/json/JSONObject#JSONObject(java.util.Map)(https://developer.android.com/reference/java/util/Map<K, V> copyFrom) ` Creates a new `JSONObject` by copying all name/value mappings from the given map. |
| ` https://developer.android.com/reference/org/json/JSONObject#JSONObject(org.json.JSONObject,%20java.lang.String[])(https://developer.android.com/reference/org/json/JSONObject copyFrom, https://developer.android.com/reference/java/lang/String names) ` Creates a new `JSONObject` by copying mappings for the listed names from the given object. |
| ` https://developer.android.com/reference/org/json/JSONObject#JSONObject(org.json.JSONTokener)(https://developer.android.com/reference/org/json/JSONTokener readFrom) ` Creates a new `JSONObject` with name/value mappings from the next object in the tokener. |

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/org/json/JSONObject` | ` https://developer.android.com/reference/org/json/JSONObject#accumulate(java.lang.String,%20java.lang.Object)(https://developer.android.com/reference/java/lang/String name, https://developer.android.com/reference/java/lang/Object value) ` Appends `value` to the array already mapped to `name`. |
| ` https://developer.android.com/reference/org/json/JSONObject` | ` https://developer.android.com/reference/org/json/JSONObject#append(java.lang.String,%20java.lang.Object)(https://developer.android.com/reference/java/lang/String name, https://developer.android.com/reference/java/lang/Object value) ` Appends values to the array mapped to `name`. |
| ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/org/json/JSONObject#get(java.lang.String)(https://developer.android.com/reference/java/lang/String name) ` Returns the value mapped by `name`, or throws if no such mapping exists. |
| ` boolean` | ` https://developer.android.com/reference/org/json/JSONObject#getBoolean(java.lang.String)(https://developer.android.com/reference/java/lang/String name) ` Returns the value mapped by `name` if it exists and is a boolean or can be coerced to a boolean, or throws otherwise. |
| ` double` | ` https://developer.android.com/reference/org/json/JSONObject#getDouble(java.lang.String)(https://developer.android.com/reference/java/lang/String name) ` Returns the value mapped by `name` if it exists and is a double or can be coerced to a double, or throws otherwise. |
| ` int` | ` https://developer.android.com/reference/org/json/JSONObject#getInt(java.lang.String)(https://developer.android.com/reference/java/lang/String name) ` Returns the value mapped by `name` if it exists and is an int or can be coerced to an int, or throws otherwise. |
| ` https://developer.android.com/reference/org/json/JSONArray` | ` https://developer.android.com/reference/org/json/JSONObject#getJSONArray(java.lang.String)(https://developer.android.com/reference/java/lang/String name) ` Returns the value mapped by `name` if it exists and is a `JSONArray`, or throws otherwise. |
| ` https://developer.android.com/reference/org/json/JSONObject` | ` https://developer.android.com/reference/org/json/JSONObject#getJSONObject(java.lang.String)(https://developer.android.com/reference/java/lang/String name) ` Returns the value mapped by `name` if it exists and is a `JSONObject`, or throws otherwise. |
| ` long` | ` https://developer.android.com/reference/org/json/JSONObject#getLong(java.lang.String)(https://developer.android.com/reference/java/lang/String name) ` Returns the value mapped by `name` if it exists and is a long or can be coerced to a long, or throws otherwise. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/org/json/JSONObject#getString(java.lang.String)(https://developer.android.com/reference/java/lang/String name) ` Returns the value mapped by `name` if it exists, coercing it if necessary, or throws if no such mapping exists. |
| ` boolean` | ` https://developer.android.com/reference/org/json/JSONObject#has(java.lang.String)(https://developer.android.com/reference/java/lang/String name) ` Returns true if this object has a mapping for `name`. |
| ` boolean` | ` https://developer.android.com/reference/org/json/JSONObject#isNull(java.lang.String)(https://developer.android.com/reference/java/lang/String name) ` Returns true if this object has no mapping for `name` or if it has a mapping whose value is `https://developer.android.com/reference/org/json/JSONObject#NULL`. |
| ` https://developer.android.com/reference/java/util/Iterator<https://developer.android.com/reference/java/lang/String>` | ` https://developer.android.com/reference/org/json/JSONObject#keys()() ` Returns an iterator of the `String` names in this object. |
| ` int` | ` https://developer.android.com/reference/org/json/JSONObject#length()() ` Returns the number of name/value mappings in this object. |
| ` https://developer.android.com/reference/org/json/JSONArray` | ` https://developer.android.com/reference/org/json/JSONObject#names()() ` Returns an array containing the string names in this object. |
| ` static https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/org/json/JSONObject#numberToString(java.lang.Number)(https://developer.android.com/reference/java/lang/Number number) ` Encodes the number as a JSON string. |
| ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/org/json/JSONObject#opt(java.lang.String)(https://developer.android.com/reference/java/lang/String name) ` Returns the value mapped by `name`, or null if no such mapping exists. |
| ` boolean` | ` https://developer.android.com/reference/org/json/JSONObject#optBoolean(java.lang.String,%20boolean)(https://developer.android.com/reference/java/lang/String name, boolean fallback) ` Returns the value mapped by `name` if it exists and is a boolean or can be coerced to a boolean, or `fallback` otherwise. |
| ` boolean` | ` https://developer.android.com/reference/org/json/JSONObject#optBoolean(java.lang.String)(https://developer.android.com/reference/java/lang/String name) ` Returns the value mapped by `name` if it exists and is a boolean or can be coerced to a boolean, or false otherwise. |
| ` double` | ` https://developer.android.com/reference/org/json/JSONObject#optDouble(java.lang.String,%20double)(https://developer.android.com/reference/java/lang/String name, double fallback) ` Returns the value mapped by `name` if it exists and is a double or can be coerced to a double, or `fallback` otherwise. |
| ` double` | ` https://developer.android.com/reference/org/json/JSONObject#optDouble(java.lang.String)(https://developer.android.com/reference/java/lang/String name) ` Returns the value mapped by `name` if it exists and is a double or can be coerced to a double, or `NaN` otherwise. |
| ` int` | ` https://developer.android.com/reference/org/json/JSONObject#optInt(java.lang.String,%20int)(https://developer.android.com/reference/java/lang/String name, int fallback) ` Returns the value mapped by `name` if it exists and is an int or can be coerced to an int, or `fallback` otherwise. |
| ` int` | ` https://developer.android.com/reference/org/json/JSONObject#optInt(java.lang.String)(https://developer.android.com/reference/java/lang/String name) ` Returns the value mapped by `name` if it exists and is an int or can be coerced to an int, or 0 otherwise. |
| ` https://developer.android.com/reference/org/json/JSONArray` | ` https://developer.android.com/reference/org/json/JSONObject#optJSONArray(java.lang.String)(https://developer.android.com/reference/java/lang/String name) ` Returns the value mapped by `name` if it exists and is a `JSONArray`, or null otherwise. |
| ` https://developer.android.com/reference/org/json/JSONObject` | ` https://developer.android.com/reference/org/json/JSONObject#optJSONObject(java.lang.String)(https://developer.android.com/reference/java/lang/String name) ` Returns the value mapped by `name` if it exists and is a `JSONObject`, or null otherwise. |
| ` long` | ` https://developer.android.com/reference/org/json/JSONObject#optLong(java.lang.String)(https://developer.android.com/reference/java/lang/String name) ` Returns the value mapped by `name` if it exists and is a long or can be coerced to a long, or 0 otherwise. |
| ` long` | ` https://developer.android.com/reference/org/json/JSONObject#optLong(java.lang.String,%20long)(https://developer.android.com/reference/java/lang/String name, long fallback) ` Returns the value mapped by `name` if it exists and is a long or can be coerced to a long, or `fallback` otherwise. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/org/json/JSONObject#optString(java.lang.String,%20java.lang.String)(https://developer.android.com/reference/java/lang/String name, https://developer.android.com/reference/java/lang/String fallback) ` Returns the value mapped by `name` if it exists, coercing it if necessary, or `fallback` if no such mapping exists. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/org/json/JSONObject#optString(java.lang.String)(https://developer.android.com/reference/java/lang/String name) ` Returns the value mapped by `name` if it exists, coercing it if necessary, or the empty string if no such mapping exists. |
| ` https://developer.android.com/reference/org/json/JSONObject` | ` https://developer.android.com/reference/org/json/JSONObject#put(java.lang.String,%20double)(https://developer.android.com/reference/java/lang/String name, double value) ` Maps `name` to `value`, clobbering any existing name/value mapping with the same name. |
| ` https://developer.android.com/reference/org/json/JSONObject` | ` https://developer.android.com/reference/org/json/JSONObject#put(java.lang.String,%20boolean)(https://developer.android.com/reference/java/lang/String name, boolean value) ` Maps `name` to `value`, clobbering any existing name/value mapping with the same name. |
| ` https://developer.android.com/reference/org/json/JSONObject` | ` https://developer.android.com/reference/org/json/JSONObject#put(java.lang.String,%20int)(https://developer.android.com/reference/java/lang/String name, int value) ` Maps `name` to `value`, clobbering any existing name/value mapping with the same name. |
| ` https://developer.android.com/reference/org/json/JSONObject` | ` https://developer.android.com/reference/org/json/JSONObject#put(java.lang.String,%20long)(https://developer.android.com/reference/java/lang/String name, long value) ` Maps `name` to `value`, clobbering any existing name/value mapping with the same name. |
| ` https://developer.android.com/reference/org/json/JSONObject` | ` https://developer.android.com/reference/org/json/JSONObject#put(java.lang.String,%20java.lang.Object)(https://developer.android.com/reference/java/lang/String name, https://developer.android.com/reference/java/lang/Object value) ` Maps `name` to `value`, clobbering any existing name/value mapping with the same name. |
| ` https://developer.android.com/reference/org/json/JSONObject` | ` https://developer.android.com/reference/org/json/JSONObject#putOpt(java.lang.String,%20java.lang.Object)(https://developer.android.com/reference/java/lang/String name, https://developer.android.com/reference/java/lang/Object value) ` Equivalent to `put(name, value)` when both parameters are non-null; does nothing otherwise. |
| ` static https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/org/json/JSONObject#quote(java.lang.String)(https://developer.android.com/reference/java/lang/String data) ` Encodes `data` as a JSON string. |
| ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/org/json/JSONObject#remove(java.lang.String)(https://developer.android.com/reference/java/lang/String name) ` Removes the named mapping if it exists; does nothing otherwise. |
| ` https://developer.android.com/reference/org/json/JSONArray` | ` https://developer.android.com/reference/org/json/JSONObject#toJSONArray(org.json.JSONArray)(https://developer.android.com/reference/org/json/JSONArray names) ` Returns an array with the values corresponding to `names`. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/org/json/JSONObject#toString()() ` Encodes this object as a compact JSON string, such as: ``` {"query":"Pizza","locations":[94043,90210]} ``` <br /> |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/org/json/JSONObject#toString(int)(int indentSpaces) ` Encodes this object as a human readable JSON string for debugging, such as: ``` { "query": "Pizza", "locations": [ 94043, 90210 ] } ``` <br /> |
| ` static https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/org/json/JSONObject#wrap(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Wraps the given object if necessary. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.

## Fields

### NULL

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Object NULL
```

A sentinel value used to explicitly define a name with no value. Unlike `null`, names with this value:

- show up in the `https://developer.android.com/reference/org/json/JSONObject#names()` array
- show up in the `https://developer.android.com/reference/org/json/JSONObject#keys()` iterator
- return `true` for `https://developer.android.com/reference/org/json/JSONObject#has(java.lang.String)`
- do not throw on `https://developer.android.com/reference/org/json/JSONObject#get(java.lang.String)`
- are included in the encoded JSON string.

This value violates the general contract of `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` by returning true when compared to `null`. Its `https://developer.android.com/reference/org/json/JSONObject#toString()` method returns "null".

<br />

## Public constructors

### JSONObject

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public JSONObject ()
```

Creates a `JSONObject` with no name/value mappings.

<br />

### JSONObject

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public JSONObject (String json)
```

Creates a new `JSONObject` with name/value mappings from the JSON string.

<br />

| Parameters ||
|---|---|
| `json` | `String`: a JSON-encoded string containing an object. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONException` | if the parse fails or doesn't yield a `JSONObject`. |

### JSONObject

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public JSONObject (Map<K, V> copyFrom)
```

Creates a new `JSONObject` by copying all name/value mappings from the given map.

<br />

| Parameters ||
|---|---|
| `copyFrom` | `Map`: a map whose keys are of type `https://developer.android.com/reference/java/lang/String` and whose values are of supported types. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/NullPointerException` | if any of the map's keys are null. |

### JSONObject

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public JSONObject (JSONObject copyFrom, 
                String[] names)
```

Creates a new `JSONObject` by copying mappings for the listed names from the given object. Names that aren't present in `copyFrom` will be skipped.

<br />

| Parameters ||
|---|---|
| `copyFrom` | `JSONObject` <br /> |
| `names` | `String` <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONException` |   |

### JSONObject

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public JSONObject (JSONTokener readFrom)
```

Creates a new `JSONObject` with name/value mappings from the next object in the tokener.

<br />

| Parameters ||
|---|---|
| `readFrom` | `JSONTokener`: a tokener whose nextValue() method will yield a `JSONObject`. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONException` | if the parse fails or doesn't yield a `JSONObject`. |

## Public methods

### accumulate

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public JSONObject accumulate (String name, 
                Object value)
```

Appends `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.

Note that `https://developer.android.com/reference/org/json/JSONObject#append(java.lang.String,%20java.lang.Object)` provides better semantics. In particular, the mapping for `name` will **always** be a `https://developer.android.com/reference/org/json/JSONArray`. Using `accumulate` will result in either a `https://developer.android.com/reference/org/json/JSONArray` or a mapping whose type is the type of `value` depending on the number of calls to it.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |
| `value` | `Object`: a `https://developer.android.com/reference/org/json/JSONObject`, `https://developer.android.com/reference/org/json/JSONArray`, String, Boolean, Integer, Long, Double, `https://developer.android.com/reference/org/json/JSONObject#NULL` or null. May not be `https://developer.android.com/reference/java/lang/Double#isNaN()` or `https://developer.android.com/reference/java/lang/Double#isInfinite()`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONObject` | <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONException` |   |

### append

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public JSONObject append (String name, 
                Object value)
```

Appends values to the array mapped to `name`. A new `https://developer.android.com/reference/org/json/JSONArray` mapping for `name` will be inserted if no mapping exists. If the existing mapping for `name` is not a `https://developer.android.com/reference/org/json/JSONArray`, a `https://developer.android.com/reference/org/json/JSONException` will be thrown.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |
| `value` | `Object` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONObject` | <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONException` | if `name` is `null` or if the mapping for `name` is non-null and is not a `https://developer.android.com/reference/org/json/JSONArray`. |

### get

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Object get (String name)
```

Returns the value mapped by `name`, or throws if no such mapping exists.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/Object` | <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONException` | if no such mapping exists. |

### getBoolean

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean getBoolean (String name)
```

Returns the value mapped by `name` if it exists and is a boolean or can be coerced to a boolean, or throws otherwise.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |

| Returns ||
|---|---|
| `boolean` | <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONException` | if the mapping doesn't exist or cannot be coerced to a boolean. |

### getDouble

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public double getDouble (String name)
```

Returns the value mapped by `name` if it exists and is a double or can be coerced to a double, or throws otherwise.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |

| Returns ||
|---|---|
| `double` | <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONException` | if the mapping doesn't exist or cannot be coerced to a double. |

### getInt

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getInt (String name)
```

Returns the value mapped by `name` if it exists and is an int or can be coerced to an int, or throws otherwise.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |

| Returns ||
|---|---|
| `int` | <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONException` | if the mapping doesn't exist or cannot be coerced to an int. |

### getJSONArray

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public JSONArray getJSONArray (String name)
```

Returns the value mapped by `name` if it exists and is a `JSONArray`, or throws otherwise.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONArray` | <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONException` | if the mapping doesn't exist or is not a `JSONArray`. |

### getJSONObject

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public JSONObject getJSONObject (String name)
```

Returns the value mapped by `name` if it exists and is a `JSONObject`, or throws otherwise.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONObject` | <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONException` | if the mapping doesn't exist or is not a `JSONObject`. |

### getLong

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public long getLong (String name)
```

Returns the value mapped by `name` if it exists and is a long or can be coerced to a long, or throws otherwise. Note that JSON represents numbers as doubles, so this is [lossy](https://developer.android.com/reference/org/json/JSONObject#lossy); use strings to transfer numbers via JSON.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |

| Returns ||
|---|---|
| `long` | <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONException` | if the mapping doesn't exist or cannot be coerced to a long. |

### getString

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String getString (String name)
```

Returns the value mapped by `name` if it exists, coercing it if necessary, or throws if no such mapping exists.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONException` | if no such mapping exists. |

### has

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean has (String name)
```

Returns true if this object has a mapping for `name`. The mapping may be `https://developer.android.com/reference/org/json/JSONObject#NULL`.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |

| Returns ||
|---|---|
| `boolean` | <br /> |

### isNull

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isNull (String name)
```

Returns true if this object has no mapping for `name` or if it has a mapping whose value is `https://developer.android.com/reference/org/json/JSONObject#NULL`.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |

| Returns ||
|---|---|
| `boolean` | <br /> |

### keys

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Iterator<String> keys ()
```

Returns an iterator of the `String` names in this object. The returned iterator supports `https://developer.android.com/reference/java/util/Iterator#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.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Iterator<https://developer.android.com/reference/java/lang/String>` | <br /> |

### length

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int length ()
```

Returns the number of name/value mappings in this object.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### names

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public JSONArray names ()
```

Returns an array containing the string names in this object. This method returns null if this object contains no mappings.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONArray` | <br /> |

### numberToString

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static String numberToString (Number number)
```

Encodes the number as a JSON string.

<br />

| Parameters ||
|---|---|
| `number` | `Number`: a finite value. May not be `https://developer.android.com/reference/java/lang/Double#isNaN()` or `https://developer.android.com/reference/java/lang/Double#isInfinite()`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONException` |   |

### opt

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Object opt (String name)
```

Returns the value mapped by `name`, or null if no such mapping exists.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/Object` | <br /> |

### optBoolean

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean optBoolean (String name, 
                boolean fallback)
```

Returns the value mapped by `name` if it exists and is a boolean or can be coerced to a boolean, or `fallback` otherwise.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |
| `fallback` | `boolean` <br /> |

| Returns ||
|---|---|
| `boolean` | <br /> |

### optBoolean

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean optBoolean (String name)
```

Returns the value mapped by `name` if it exists and is a boolean or can be coerced to a boolean, or false otherwise.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |

| Returns ||
|---|---|
| `boolean` | <br /> |

### optDouble

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public double optDouble (String name, 
                double fallback)
```

Returns the value mapped by `name` if it exists and is a double or can be coerced to a double, or `fallback` otherwise.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |
| `fallback` | `double` <br /> |

| Returns ||
|---|---|
| `double` | <br /> |

### optDouble

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public double optDouble (String name)
```

Returns the value mapped by `name` if it exists and is a double or can be coerced to a double, or `NaN` otherwise.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |

| Returns ||
|---|---|
| `double` | <br /> |

### optInt

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int optInt (String name, 
                int fallback)
```

Returns the value mapped by `name` if it exists and is an int or can be coerced to an int, or `fallback` otherwise.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |
| `fallback` | `int` <br /> |

| Returns ||
|---|---|
| `int` | <br /> |

### optInt

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int optInt (String name)
```

Returns the value mapped by `name` if it exists and is an int or can be coerced to an int, or 0 otherwise.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |

| Returns ||
|---|---|
| `int` | <br /> |

### optJSONArray

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public JSONArray optJSONArray (String name)
```

Returns the value mapped by `name` if it exists and is a `JSONArray`, or null otherwise.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONArray` | <br /> |

### optJSONObject

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public JSONObject optJSONObject (String name)
```

Returns the value mapped by `name` if it exists and is a `JSONObject`, or null otherwise.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONObject` | <br /> |

### optLong

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public long optLong (String name)
```

Returns the value mapped by `name` if it exists and is a long or can be coerced to a long, or 0 otherwise. Note that JSON represents numbers as doubles, so this is [lossy](https://developer.android.com/reference/org/json/JSONObject#lossy); use strings to transfer numbers via JSON.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |

| Returns ||
|---|---|
| `long` | <br /> |

### optLong

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public long optLong (String name, 
                long fallback)
```

Returns the value mapped by `name` if it exists and is a long or can be coerced to a long, or `fallback` otherwise. Note that JSON represents numbers as doubles, so this is [lossy](https://developer.android.com/reference/org/json/JSONObject#lossy); use strings to transfer numbers via JSON.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |
| `fallback` | `long` <br /> |

| Returns ||
|---|---|
| `long` | <br /> |

### optString

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String optString (String name, 
                String fallback)
```

Returns the value mapped by `name` if it exists, coercing it if necessary, or `fallback` if no such mapping exists.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |
| `fallback` | `String` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | <br /> |

### optString

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String optString (String name)
```

Returns the value mapped by `name` if it exists, coercing it if necessary, or the empty string if no such mapping exists.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | <br /> |

### put

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public JSONObject put (String name, 
                double value)
```

Maps `name` to `value`, clobbering any existing name/value mapping with the same name.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |
| `value` | `double`: a finite value. May not be `https://developer.android.com/reference/java/lang/Double#isNaN()` or `https://developer.android.com/reference/java/lang/Double#isInfinite()`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONObject` | this object. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONException` |   |

### put

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public JSONObject put (String name, 
                boolean value)
```

Maps `name` to `value`, clobbering any existing name/value mapping with the same name.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |
| `value` | `boolean` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONObject` | this object. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONException` |   |

### put

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public JSONObject put (String name, 
                int value)
```

Maps `name` to `value`, clobbering any existing name/value mapping with the same name.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |
| `value` | `int` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONObject` | this object. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONException` |   |

### put

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public JSONObject put (String name, 
                long value)
```

Maps `name` to `value`, clobbering any existing name/value mapping with the same name.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |
| `value` | `long` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONObject` | this object. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONException` |   |

### put

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public JSONObject put (String name, 
                Object value)
```

Maps `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.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |
| `value` | `Object`: a `https://developer.android.com/reference/org/json/JSONObject`, `https://developer.android.com/reference/org/json/JSONArray`, String, Boolean, Integer, Long, Double, `https://developer.android.com/reference/org/json/JSONObject#NULL`, or `null`. May not be `https://developer.android.com/reference/java/lang/Double#isNaN()` or `https://developer.android.com/reference/java/lang/Double#isInfinite()`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONObject` | this object. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONException` |   |

### putOpt

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public JSONObject putOpt (String name, 
                Object value)
```

Equivalent to `put(name, value)` when both parameters are non-null; does nothing otherwise.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |
| `value` | `Object` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONObject` | <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONException` |   |

### quote

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static String quote (String data)
```

Encodes `data` as a JSON string. This applies quotes and any necessary character escaping.

<br />

| Parameters ||
|---|---|
| `data` | `String`: the string to encode. Null will be interpreted as an empty string. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | <br /> |

### remove

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Object remove (String name)
```

Removes the named mapping if it exists; does nothing otherwise.

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/Object` | the value previously mapped by `name`, or null if there was no such mapping. <br /> |

### toJSONArray

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public JSONArray toJSONArray (JSONArray names)
```

Returns an array with the values corresponding to `names`. The array contains null for names that aren't mapped. This method returns null if `names` is either null or empty.

<br />

| Parameters ||
|---|---|
| `names` | `JSONArray` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONArray` | <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONException` |   |

### toString

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Encodes this object as a compact JSON string, such as:

```
{"query":"Pizza","locations":[94043,90210]}
```

<br />

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |

### toString

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString (int indentSpaces)
```

Encodes this object as a human readable JSON string for debugging, such as:

```
{
    "query": "Pizza",
    "locations": [
        94043,
        90210
    ]
}
```

<br />

<br />

| Parameters ||
|---|---|
| `indentSpaces` | `int`: the number of spaces to indent for each level of nesting. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/json/JSONException` |   |

### wrap

Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static Object wrap (Object o)
```

Wraps the given object if necessary.

If the object is null or , returns `https://developer.android.com/reference/org/json/JSONObject#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.

<br />

| Parameters ||
|---|---|
| `o` | `Object` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/Object` | <br /> |