org.json
public class JSONArray extends Object
get
and opt
methods for accessing the values by index, and put
methods for
adding or replacing values. The values can be any of these types:
Boolean
, JSONArray
, JSONObject
,
Number
, String
, or the
JSONObject.NULL object
.
The constructor can convert a JSON text into a Java object. The
toString
method converts to JSON text.
A get
method returns a value if one can be found, and throws an
exception if one cannot be found. An opt
method returns a
default value instead of throwing an exception, and so is useful for
obtaining optional values.
The generic get()
and opt()
methods return an
object which you can cast or query for type. There are also typed
get
and opt
methods that do type checking and type
coersion for you.
The texts produced by the toString
methods strictly conform to
JSON syntax rules. The constructors are more forgiving in the texts they will
accept:
,
(comma) may appear just
before the closing bracket.null
value will be inserted when there
is ,
(comma) elision.'
(single
quote).{ } [ ] / \ : , = ; #
and if they do not look like numbers
and if they are not the reserved words true
,
false
, or null
.;
(semicolon) as
well as by ,
(comma).0-
(octal) or
0x-
(hex) prefix.Constructor Summary | |
---|---|
JSONArray()
Construct an empty JSONArray. | |
JSONArray(JSONTokener x)
Construct a JSONArray from a JSONTokener. | |
JSONArray(String string)
Construct a JSONArray from a source sJSON text. | |
JSONArray(Collection collection)
Construct a JSONArray from a Collection. |
Method Summary | |
---|---|
Object | get(int index)
Get the object value associated with an index. |
boolean | getBoolean(int index)
Get the boolean value associated with an index.
|
double | getDouble(int index)
Get the double value associated with an index.
|
int | getInt(int index)
Get the int value associated with an index.
|
JSONArray | getJSONArray(int index)
Get the JSONArray associated with an index. |
JSONObject | getJSONObject(int index)
Get the JSONObject associated with an index. |
long | getLong(int index)
Get the long value associated with an index.
|
String | getString(int index)
Get the string associated with an index. |
boolean | isNull(int index)
Determine if the value is null. |
String | join(String separator)
Make a string from the contents of this JSONArray. |
int | length()
Get the number of elements in the JSONArray, included nulls.
|
Object | opt(int index)
Get the optional object value associated with an index. |
boolean | optBoolean(int index)
Get the optional boolean value associated with an index.
|
boolean | optBoolean(int index, boolean defaultValue)
Get the optional boolean value associated with an index.
|
double | optDouble(int index)
Get the optional double value associated with an index.
|
double | optDouble(int index, double defaultValue)
Get the optional double value associated with an index.
|
int | optInt(int index)
Get the optional int value associated with an index.
|
int | optInt(int index, int defaultValue)
Get the optional int value associated with an index.
|
JSONArray | optJSONArray(int index)
Get the optional JSONArray associated with an index. |
JSONObject | optJSONObject(int index)
Get the optional JSONObject associated with an index.
|
long | optLong(int index)
Get the optional long value associated with an index.
|
long | optLong(int index, long defaultValue)
Get the optional long value associated with an index.
|
String | optString(int index)
Get the optional string value associated with an index. |
String | optString(int index, String defaultValue)
Get the optional string associated with an index.
|
JSONArray | put(boolean value)
Append a boolean value. |
JSONArray | put(Collection value)
Put a value in the JSONArray, where the value will be a
JSONArray which is produced from a Collection. |
JSONArray | put(double value)
Append a double value. |
JSONArray | put(int value)
Append an int value. |
JSONArray | put(long value)
Append an long value. |
JSONArray | put(Map value)
Put a value in the JSONArray, where the value will be a
JSONObject which is produced from a Map. |
JSONArray | put(Object value)
Append an object value. |
JSONArray | put(int index, boolean value)
Put or replace a boolean value in the JSONArray. |
JSONArray | put(int index, Collection value)
Put a value in the JSONArray, where the value will be a
JSONArray which is produced from a Collection. |
JSONArray | put(int index, double value)
Put or replace a double value. |
JSONArray | put(int index, int value)
Put or replace an int value. |
JSONArray | put(int index, long value)
Put or replace a long value. |
JSONArray | put(int index, Map value)
Put a value in the JSONArray, where the value will be a
JSONObject which is produced from a Map. |
JSONArray | put(int index, Object value)
Put or replace an object value in the JSONArray. |
JSONObject | toJSONObject(JSONArray names)
Produce a JSONObject by combining a JSONArray of names with the values
of this JSONArray. |
String | toString()
Make a JSON text of this JSONArray. |
String | toString(int indentFactor)
Make a prettyprinted JSON text of this JSONArray.
|
Writer | write(Writer writer)
Write the contents of the JSONArray as JSON text to a writer.
|
Parameters: x A JSONTokener
Throws: JSONException If there is a syntax error.
Parameters: string A string that begins with
[
(left bracket)
and ends with ]
(right bracket).
Throws: JSONException If there is a syntax error.
Parameters: collection A Collection.
Parameters: index The index must be between 0 and length() - 1.
Returns: An object value.
Throws: JSONException If there is no value for the index.
Parameters: index The index must be between 0 and length() - 1.
Returns: The truth.
Throws: JSONException If there is no value for the index or if the value is not convertable to boolean.
Parameters: index The index must be between 0 and length() - 1.
Returns: The value.
Throws: JSONException If the key is not found or if the value cannot be converted to a number.
Parameters: index The index must be between 0 and length() - 1.
Returns: The value.
Throws: JSONException If the key is not found or if the value cannot be converted to a number. if the value cannot be converted to a number.
Parameters: index The index must be between 0 and length() - 1.
Returns: A JSONArray value.
Throws: JSONException If there is no value for the index. or if the value is not a JSONArray
Parameters: index subscript
Returns: A JSONObject value.
Throws: JSONException If there is no value for the index or if the value is not a JSONObject
Parameters: index The index must be between 0 and length() - 1.
Returns: The value.
Throws: JSONException If the key is not found or if the value cannot be converted to a number.
Parameters: index The index must be between 0 and length() - 1.
Returns: A string value.
Throws: JSONException If there is no value for the index.
Parameters: index The index must be between 0 and length() - 1.
Returns: true if the value at the index is null, or if there is no value.
separator
string is inserted between each element.
Warning: This method assumes that the data structure is acyclical.Parameters: separator A string that will be inserted between the elements.
Returns: a string.
Throws: JSONException If the array contains an invalid number.
Returns: The length (or size).
Parameters: index The index must be between 0 and length() - 1.
Returns: An object value, or null if there is no object at that index.
Parameters: index The index must be between 0 and length() - 1.
Returns: The truth.
Parameters: index The index must be between 0 and length() - 1. defaultValue A boolean default.
Returns: The truth.
Parameters: index The index must be between 0 and length() - 1.
Returns: The value.
Parameters: index subscript defaultValue The default value.
Returns: The value.
Parameters: index The index must be between 0 and length() - 1.
Returns: The value.
Parameters: index The index must be between 0 and length() - 1. defaultValue The default value.
Returns: The value.
Parameters: index subscript
Returns: A JSONArray value, or null if the index has no value, or if the value is not a JSONArray.
Parameters: index The index must be between 0 and length() - 1.
Returns: A JSONObject value.
Parameters: index The index must be between 0 and length() - 1.
Returns: The value.
Parameters: index The index must be between 0 and length() - 1. defaultValue The default value.
Returns: The value.
Parameters: index The index must be between 0 and length() - 1.
Returns: A String value.
Parameters: index The index must be between 0 and length() - 1. defaultValue The default value.
Returns: A String value.
Parameters: value A boolean value.
Returns: this.
Parameters: value A Collection value.
Returns: this.
Parameters: value A double value.
Returns: this.
Throws: JSONException if the value is not finite.
Parameters: value An int value.
Returns: this.
Parameters: value A long value.
Returns: this.
Parameters: value A Map value.
Returns: this.
Parameters: value An object value. The value should be a Boolean, Double, Integer, JSONArray, JSONObject, Long, or String, or the JSONObject.NULL object.
Returns: this.
Parameters: index The subscript. value A boolean value.
Returns: this.
Throws: JSONException If the index is negative.
Parameters: index The subscript. value A Collection value.
Returns: this.
Throws: JSONException If the index is negative or if the value is not finite.
Parameters: index The subscript. value A double value.
Returns: this.
Throws: JSONException If the index is negative or if the value is not finite.
Parameters: index The subscript. value An int value.
Returns: this.
Throws: JSONException If the index is negative.
Parameters: index The subscript. value A long value.
Returns: this.
Throws: JSONException If the index is negative.
Parameters: index The subscript. value The Map value.
Returns: this.
Throws: JSONException If the index is negative or if the the value is an invalid number.
Parameters: index The subscript. value The value to put into the array. The value should be a Boolean, Double, Integer, JSONArray, JSONObject, Long, or String, or the JSONObject.NULL object.
Returns: this.
Throws: JSONException If the index is negative or if the the value is an invalid number.
Parameters: names A JSONArray containing a list of key strings. These will be paired with the values.
Returns: A JSONObject, or null if there are no names or if this JSONArray has no values.
Throws: JSONException If any of the names are null.
Warning: This method assumes that the data structure is acyclical.
Returns: a printable, displayable, transmittable representation of the array.
Parameters: indentFactor The number of spaces to add to each level of indentation.
Returns: a printable, displayable, transmittable
representation of the object, beginning
with [
(left bracket) and ending
with ]
(right bracket).
Throws: JSONException
Warning: This method assumes that the data structure is acyclical.
Returns: The writer.
Throws: JSONException