JSONObject (twitter4j-core 4.0.3 API)

java.lang.Object
- twitter4j.JSONObject

```
public class JSONObject
extends Object
```
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{/code} and opt{/code} methods for accessing the values by name, and put{/code} methods for adding or replacing values by name. The values can be any of these types: Boolean{/code}, JSONArray{/code}, JSONObject{/code}, Number{/code}, String{/code}, or the JSONObject.NULL{/code} 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{/code} and opt{/code} methods, or to convert values into a JSON text using the put{/code} and toString{/code} methods. A get{/code} method returns a value if one can be found, and throws an exception if one cannot be found. An opt{/code} method returns a default value instead of throwing an exception, and so is useful for obtaining optional values.
The generic get(){/code} and opt(){/code} methods return an object, which you can cast or query for type. There are also typed get{/code} and opt{/code} 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{/code} methods add or replace values in an object. For example,
```
myString = new JSONObject().put("JSON", "Hello, World!").toString();
```
produces the string {"JSON": "Hello, World"}{/code}.
The texts produced by the toString{/code} methods strictly conform to the JSON syntax rules. The constructors are more forgiving in the texts they will accept:
- An extra ,{/code} (comma) may appear just before the closing brace.
- Strings may be quoted with '{/code} (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: { } [ ] / \ : , = ; #{/code} and if they do not look like numbers and if they are not the reserved words true{/code}, false{/code}, or null{/code}.
- Keys can be followed by ={/code} or =>{/code} as well as by :{/code}.
- Values can be followed by ;{/code} (semicolon) as well as by ,{/code} (comma).
- Numbers may have the 0x-{/code} (hex) prefix.
Version:

2010-12-28

Author:

JSON.org

Field Summary

Fields
Modifier and Type Field and Description

static Object NULL
It is sometimes more convenient and less ambiguous to have a NULL{/code} object than to use Java's null{/code} value.

Fields
Modifier and Type	Field and Description
`static Object`	`NULL` It is sometimes more convenient and less ambiguous to have a NULL{/code} object than to use Java's null{/code} value.

Constructor Summary

Constructors
Constructor and Description
`JSONObject()` Construct an empty JSONObject.
`JSONObject(JSONObject jo, String[] names)` Construct a JSONObject from a subset of another JSONObject.
`JSONObject(JSONTokener x)` Construct a JSONObject from a JSONTokener.
`JSONObject(Map map)` Construct a JSONObject from a Map.
`JSONObject(Object bean)` Construct a JSONObject from an Object using bean getters.
`JSONObject(Object object, String[] names)` Construct a JSONObject from an Object, using reflection to find the public members.
`JSONObject(String source)` Construct a JSONObject from a source JSON text string.
`JSONObject(String baseName, Locale locale)` Construct a JSONObject from a ResourceBundle.

Method Summary

Methods
Modifier and Type	Method and Description
`JSONObject`	`append(String key, Object value)` Append values to the array under a key.
`Object`	`get(String key)` Get the value object associated with a key.
`boolean`	`getBoolean(String key)` Get the boolean value associated with a key.
`int`	`getInt(String key)` Get the int value associated with a key.
`JSONArray`	`getJSONArray(String key)` Get the JSONArray value associated with a key.
`JSONObject`	`getJSONObject(String key)` Get the JSONObject value associated with a key.
`long`	`getLong(String key)` Get the long value associated with a key.
`String`	`getString(String key)` Get the string associated with a key.
`boolean`	`has(String key)` Determine if the JSONObject contains a specific key.
`boolean`	`isNull(String key)` Determine if the value associated with the key is null or if there is no value.
`Iterator`	`keys()` Get an enumeration of the keys of the JSONObject.
`int`	`length()` Get the number of keys stored in the JSONObject.
`JSONArray`	`names()` Produce a JSONArray containing the names of the elements of this JSONObject.
`static String`	`numberToString(Number number)` Produce a string from a Number.
`Object`	`opt(String key)` Get an optional value associated with a key.
`JSONObject`	`put(String key, boolean value)` Put a key/boolean pair in the JSONObject.
`JSONObject`	`put(String key, Collection value)` Put a key/value pair in the JSONObject, where the value will be a JSONArray which is produced from a Collection.
`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)` Put a key/value pair in the JSONObject.
`JSONObject`	`putOnce(String key, 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(String key, Object value)` Put a key/value pair in the JSONObject, but only if the key and the value are both non-null.
`static String`	`quote(String string)` Produce a string in double quotes with backslash sequences in all the right places.
`Object`	`remove(String key)` Remove a name and its value, if present.
`Iterator`	`sortedKeys()` Get an enumeration of the keys of the JSONObject.
`static Object`	`stringToValue(String string)` Try to convert a string into a number, boolean, or null.
`static void`	`testValidity(Object o)` Throw an exception if the object is a NaN or infinite number.
`String`	`toString()` Make a JSON text of this JSONObject.
`String`	`toString(int indentFactor)` Make a prettyprinted JSON text of this JSONObject.
`static String`	`valueToString(Object value)` Make a JSON text of an Object value.
`static Object`	`wrap(Object object)` Wrap an object, if necessary.
`Writer`	`write(Writer writer)` Write the contents of the JSONObject as JSON text to a writer.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NULL
```
public static final Object NULL
```
    It is sometimes more convenient and less ambiguous to have a NULL{/code} object than to use Java's null{/code} value. JSONObject.NULL.equals(null){/code} returns true{/code}. JSONObject.NULL.toString(){/code} returns "null"{/code}.
- Constructor Detail
  - JSONObject
```
public JSONObject()
```
    Construct an empty JSONObject.
  - JSONObject
```
public JSONObject(JSONObject jo,
          String[] names)
```
    Construct a JSONObject from a subset of another JSONObject. An array of strings is used to identify the keys that should be copied. Missing keys are ignored.
    
    Parameters:
    jo - A JSONObject.
    names - An array of strings.
  - JSONObject
```
public JSONObject(JSONTokener x)
           throws JSONException
```
    Construct a JSONObject from a JSONTokener.
    
    Parameters:
    x - A JSONTokener object containing the source string.
    
    Throws:
    
    JSONException - If there is a syntax error in the source string or a duplicated key.
  - JSONObject
```
public JSONObject(Map map)
```
    Construct a JSONObject from a Map.
    
    Parameters:
    map - A map object that can be used to initialize the contents of the JSONObject.
  - JSONObject
```
public JSONObject(Object bean)
```
    Construct a JSONObject from an Object using bean getters. It reflects on all of the public methods of the object. For each of the methods with no parameters and a name starting with "get"{/code} or "is"{/code} followed by an uppercase letter, the method is invoked, and a key and the value returned from the getter method are put into the new JSONObject.
    The key is formed by removing the "get"{/code} or "is"{/code} prefix. If the second remaining character is not upper case, then the first character is converted to lower case.
    For example, if an object has a method named "getName"{/code}, and if the result of calling object.getName(){/code} is "Larry Fine"{/code}, then the JSONObject will contain "name": "Larry Fine"{/code}.
    
    Parameters:
    bean - An object that has getter methods that should be used to make a JSONObject.
  - JSONObject
```
public JSONObject(Object object,
          String[] names)
```
    Construct a JSONObject from an Object, using reflection to find the public members. The resulting JSONObject's keys will be the strings from the names array, and the values will be the field values associated with those keys in the object. If a key is not found or not visible, then it will not be copied into the new JSONObject.
    
    Parameters:
    object - An object that has fields that should be used to make a JSONObject.
    names - An array of strings, the names of the fields to be obtained from the object.
  - JSONObject
```
public JSONObject(String source)
           throws JSONException
```
    Construct a JSONObject from a source JSON text string. This is the most commonly used JSONObject constructor.
    
    Parameters:
    source - A string beginning with {{/code} (left brace) and ending with }{/code} (right brace).
    
    Throws:
    
    JSONException - If there is a syntax error in the source string or a duplicated key.
  - JSONObject
```
public JSONObject(String baseName,
          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
  - 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.
  - get
```
public Object get(String key)
           throws JSONException
```
    Get the value object associated with a key.
    
    Parameters:
    key - A key string.
    
    Returns:
    The object associated with the key.
    
    Throws:
    
    JSONException - if the key is not found.
  - getBoolean
```
public boolean getBoolean(String key)
                   throws JSONException
```
    Get the boolean value associated with a key.
    
    Parameters:
    key - A key string.
    
    Returns:
    The truth.
    
    Throws:
    
    JSONException - if the value is not a Boolean or the String "true" or "false".
  - getInt
```
public int getInt(String key)
           throws JSONException
```
    Get the int value associated with a key.
    
    Parameters:
    key - A key string.
    
    Returns:
    The integer value.
    
    Throws:
    
    JSONException - if the key is not found or if the value cannot be converted to an integer.
  - getJSONArray
```
public JSONArray getJSONArray(String key)
                       throws JSONException
```
    Get the JSONArray value associated with a key.
    
    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 JSONObject getJSONObject(String key)
                         throws JSONException
```
    Get the JSONObject value associated with a key.
    
    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.
  - getLong
```
public long getLong(String key)
             throws JSONException
```
    Get the long value associated with a key.
    
    Parameters:
    key - A key string.
    
    Returns:
    The long value.
    
    Throws:
    
    JSONException - if the key is not found or if the value cannot be converted to a long.
  - getString
```
public String getString(String key)
                 throws JSONException
```
    Get the string associated with a key.
    
    Parameters:
    key - A key string.
    
    Returns:
    A string which is the value.
    
    Throws:
    
    JSONException - if the key is not found.
  - has
```
public boolean has(String key)
```
    Determine if the JSONObject contains a specific key.
    
    Parameters:
    key - A key string.
    
    Returns:
    true if the key exists in the JSONObject.
  - isNull
```
public boolean isNull(String key)
```
    Determine if the value associated with the key is null or if there is no value.
    
    Parameters:
    key - A key string.
    
    Returns:
    true if there is no value associated with the key or if the value is the JSONObject.NULL object.
  - keys
```
public Iterator keys()
```
    Get an enumeration of the keys of the JSONObject.
    
    Returns:
    An iterator of the keys.
  - length
```
public int length()
```
    Get the number of keys stored in the JSONObject.
    
    Returns:
    The number of keys in the JSONObject.
  - names
```
public JSONArray names()
```
    Produce a JSONArray containing the names of the elements of this JSONObject.
    
    Returns:
    A JSONArray containing the key strings, or null if the JSONObject is empty.
  - numberToString
```
public static String numberToString(Number number)
                             throws JSONException
```
    Produce a string from a Number.
    
    Parameters:
    number - A Number
    
    Returns:
    A String.
    
    Throws:
    
    JSONException - If n is a non-finite number.
  - opt
```
public Object opt(String key)
```
    Get an optional value associated with a key.
    
    Parameters:
    key - A key string.
    
    Returns:
    An object which is the value, or null if there is no value.
  - 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,
             Collection value)
               throws JSONException
```
    Put a key/value pair in the JSONObject, where the value will be a JSONArray which is produced from a Collection.
    
    Parameters:
    key - A key string.
    value - A Collection value.
    
    Returns:
    this.
    
    Throws:
    
    JSONException
  - 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
  - put
```
public JSONObject put(String key,
             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.
    
    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(String key,
                 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.
    
    Parameters:
    key - key to be put
    value - value to be put
    
    Returns:
    his.
    
    Throws:
    
    JSONException - if the key is a duplicate
  - putOpt
```
public JSONObject putOpt(String key,
                Object value)
                  throws JSONException
```
    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.
  - 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
    Parameters:
    string - A String
    
    Returns:
    A String correctly formatted for insertion in a JSON text.
  - remove
```
public Object remove(String key)
```
    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.
  - sortedKeys
```
public Iterator sortedKeys()
```
    Get an enumeration of the keys of the JSONObject. The keys will be sorted alphabetically.
    
    Returns:
    An iterator of the keys.
  - stringToValue
```
public static Object stringToValue(String string)
```
    Try to convert a string into a number, boolean, or null. If the string can't be converted, return the string.
    
    Parameters:
    string - A String.
    
    Returns:
    A simple JSON value.
  - testValidity
```
public static void testValidity(Object o)
                         throws JSONException
```
    Throw an exception if the object is a NaN or infinite number.
    
    Parameters:
    o - The object to test.
    
    Throws:
    
    JSONException - If o is a non-finite number.
  - toString
```
public String toString()
```
    Make a JSON text of this JSONObject. For compactness, no whitespace is added. If this would not result in a syntactically correct JSON text, then null will be returned instead.
    Warning: This method assumes that the data structure is acyclical.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    a printable, displayable, portable, transmittable representation of the object, beginning with {{/code} (left brace) and ending with }{/code} (right brace).
  - toString
```
public String toString(int indentFactor)
                throws JSONException
```
    Make a prettyprinted JSON text of this JSONObject.
    Warning: This method assumes that the data structure is acyclical.
    
    Parameters:
    indentFactor - The number of spaces to add to each level of indentation.
    
    Returns:
    a printable, displayable, portable, transmittable representation of the object, beginning with {{/code} (left brace) and ending with }{/code} (right brace).
    
    Throws:
    
    JSONException - If the object contains an invalid number.
  - valueToString
```
public static String valueToString(Object value)
                            throws JSONException
```
    Make a JSON text of an Object value. If the object has an value.toJSONString() method, then that method will be used to produce the JSON text. The method is required to produce a strictly conforming text. If the object does not contain a toJSONString method (which is the most common case), then a text will be produced by other means. If the value is an array or Collection, then a JSONArray will be made from it and its toJSONString method will be called. If the value is a MAP, then a JSONObject will be made from it and its toJSONString method will be called. Otherwise, the value's toString method will be called, and the result will be quoted.
    
    Warning: This method assumes that the data structure is acyclical.
    
    Parameters:
    value - The value to be serialized.
    
    Returns:
    a printable, displayable, transmittable representation of the object, beginning with {{/code} (left brace) and ending with }{/code} (right brace).
    
    Throws:
    
    JSONException - If the value is or contains an invalid number.
  - wrap
```
public static Object wrap(Object object)
```
    Wrap an object, if necessary. If the object is null, return the NULL object. If it is an array or collection, wrap it in a JSONArray. If it is a map, wrap it in a JSONObject. If it is a standard property (Double, String, et al) then it is already wrapped. Otherwise, if it comes from one of the java packages, turn it into a string. And if it doesn't, try to wrap it in a JSONObject. If the wrapping fails, then null is returned.
    
    Parameters:
    object - The object to wrap
    
    Returns:
    The wrapped value
  - write
```
public Writer write(Writer writer)
             throws JSONException
```
    Write the contents of the JSONObject as JSON text to a writer. For compactness, no whitespace is added.
    Warning: This method assumes that the data structure is acyclical.
    
    Returns:
    The writer.
    
    Throws:
    
    JSONException

Class JSONObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NULL

Constructor Detail

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

Method Detail

append

get

getBoolean

getInt

getJSONArray

getJSONObject

getLong

getString

has

isNull

keys

length

names

numberToString

opt

put

put

put

put

put

put

put

putOnce

putOpt

quote

remove

sortedKeys

stringToValue

testValidity

toString

toString

valueToString

wrap

write