java.lang.Object | |
↳ | org.json.JSONArray |
A JSONArray is an ordered sequence of values. Its external text form is a
string wrapped in square brackets with commas separating the values. The
internal form is an object having 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.Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Construct an empty JSONArray.
| |||||||||||
Construct a JSONArray from a JSONTokener.
| |||||||||||
Construct a JSONArray from a source sJSON text.
| |||||||||||
Construct a JSONArray from a Collection.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Compares this instance with the specified object and indicates if they
are equal.
| |||||||||||
Get the object value associated with an index.
| |||||||||||
Get the boolean value associated with an index.
| |||||||||||
Get the double value associated with an index.
| |||||||||||
Get the int value associated with an index.
| |||||||||||
Get the JSONArray associated with an index.
| |||||||||||
Get the JSONObject associated with an index.
| |||||||||||
Get the long value associated with an index.
| |||||||||||
Get the string associated with an index.
| |||||||||||
Determine if the value is null.
| |||||||||||
Make a string from the contents of this JSONArray.
| |||||||||||
Get the number of elements in the JSONArray, included nulls.
| |||||||||||
Get the optional object value associated with an index.
| |||||||||||
Get the optional boolean value associated with an index.
| |||||||||||
Get the optional boolean value associated with an index.
| |||||||||||
Get the optional double value associated with an index.
| |||||||||||
Get the optional double value associated with an index.
| |||||||||||
Get the optional int value associated with an index.
| |||||||||||
Get the optional int value associated with an index.
| |||||||||||
Get the optional JSONArray associated with an index.
| |||||||||||
Get the optional JSONObject associated with an index.
| |||||||||||
Get the optional long value associated with an index.
| |||||||||||
Get the optional long value associated with an index.
| |||||||||||
Get the optional string value associated with an index.
| |||||||||||
Get the optional string associated with an index.
| |||||||||||
Put or replace a boolean value in the JSONArray.
| |||||||||||
Put or replace a long value.
| |||||||||||
Append a boolean value.
| |||||||||||
Append an long value.
| |||||||||||
Append an int value.
| |||||||||||
Put or replace an object value in the JSONArray.
| |||||||||||
Append an object value.
| |||||||||||
Put or replace a double value.
| |||||||||||
Append a double value.
| |||||||||||
Put or replace an int value.
| |||||||||||
Produce a JSONObject by combining a JSONArray of names with the values
of this JSONArray.
| |||||||||||
Make an JSON text of this JSONArray.
| |||||||||||
Make a prettyprinted JSON text of this JSONArray.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class java.lang.Object
|
Construct a JSONArray from a JSONTokener.
x | A JSONTokener |
---|
JSONException | If there is a syntax error. |
---|
Construct a JSONArray from a source sJSON text.
string | A string that begins with
[ (left bracket)
and ends with ] (right bracket). |
---|
JSONException | If there is a syntax error. |
---|
Construct a JSONArray from a Collection.
collection | A Collection. |
---|
Compares this instance with the specified object and indicates if they
are equal. In order to be equal, o
must represent the same object
as this instance using a class-specific comparison. The general contract
is that this comparison should be both transitive and reflexive.
The implementation in Object
returns true
only if o
is the exact same object as the receiver (using the == operator for
comparison). Subclasses often implement equals(Object)
so that
it takes into account the two object's types and states.
The general contract for the equals(Object)
and hashCode()
methods is that if equals
returns true
for
any two objects, then hashCode()
must return the same value for
these objects. This means that subclasses of Object
usually
override either both methods or none of them.
object | the object to compare this instance with. |
---|
true
if the specified object is equal to this Object
; false
otherwise.Get the object value associated with an index.
index | The index must be between 0 and length() - 1. |
---|
JSONException | If there is no value for the index. |
---|
Get the boolean value associated with an index. The string values "true" and "false" are converted to boolean.
index | The index must be between 0 and length() - 1. |
---|
JSONException | If there is no value for the index or if the value is not convertable to boolean. |
---|
Get the double value associated with an index.
index | The index must be between 0 and length() - 1. |
---|
JSONException | If the key is not found or if the value cannot be converted to a number. |
---|
Get the int value associated with an index.
index | The index must be between 0 and length() - 1. |
---|
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. |
---|
Get the JSONArray associated with an index.
index | The index must be between 0 and length() - 1. |
---|
JSONException | If there is no value for the index. or if the value is not a JSONArray |
---|
Get the JSONObject associated with an index.
index | subscript |
---|
JSONException | If there is no value for the index or if the value is not a JSONObject |
---|
Get the long value associated with an index.
index | The index must be between 0 and length() - 1. |
---|
JSONException | If the key is not found or if the value cannot be converted to a number. |
---|
Get the string associated with an index.
index | The index must be between 0 and length() - 1. |
---|
JSONException | If there is no value for the index. |
---|
Determine if the value is null.
index | The index must be between 0 and length() - 1. |
---|
Make a string from the contents of this JSONArray. The
separator
string is inserted between each element.
Warning: This method assumes that the data structure is acyclical.
separator | A string that will be inserted between the elements. |
---|
JSONException | If the array contains an invalid number. |
---|
Get the number of elements in the JSONArray, included nulls.
Get the optional object value associated with an index.
index | The index must be between 0 and length() - 1. |
---|
Get the optional boolean value associated with an index. It returns the defaultValue if there is no value at that index or if it is not a Boolean or the String "true" or "false" (case insensitive).
index | The index must be between 0 and length() - 1. |
---|---|
defaultValue | A boolean default. |
Get the optional boolean value associated with an index. It returns false if there is no value at that index, or if the value is not Boolean.TRUE or the String "true".
index | The index must be between 0 and length() - 1. |
---|
Get the optional double value associated with an index. The defaultValue is returned if there is no value for the index, or if the value is not a number and cannot be converted to a number.
index | subscript |
---|---|
defaultValue | The default value. |
Get the optional double value associated with an index. NaN is returned if there is no value for the index, or if the value is not a number and cannot be converted to a number.
index | The index must be between 0 and length() - 1. |
---|
Get the optional int value associated with an index. The defaultValue is returned if there is no value for the index, or if the value is not a number and cannot be converted to a number.
index | The index must be between 0 and length() - 1. |
---|---|
defaultValue | The default value. |
Get the optional int value associated with an index. Zero is returned if there is no value for the index, or if the value is not a number and cannot be converted to a number.
index | The index must be between 0 and length() - 1. |
---|
Get the optional JSONArray associated with an index.
index | subscript |
---|
Get the optional JSONObject associated with an index. Null is returned if the key is not found, or null if the index has no value, or if the value is not a JSONObject.
index | The index must be between 0 and length() - 1. |
---|
Get the optional long value associated with an index. The defaultValue is returned if there is no value for the index, or if the value is not a number and cannot be converted to a number.
index | The index must be between 0 and length() - 1. |
---|---|
defaultValue | The default value. |
Get the optional long value associated with an index. Zero is returned if there is no value for the index, or if the value is not a number and cannot be converted to a number.
index | The index must be between 0 and length() - 1. |
---|
Get the optional string value associated with an index. It returns an empty string if there is no value at that index. If the value is not a string and is not null, then it is coverted to a string.
index | The index must be between 0 and length() - 1. |
---|
Get the optional string associated with an index. The defaultValue is returned if the key is not found.
index | The index must be between 0 and length() - 1. |
---|---|
defaultValue | The default value. |
Put or replace a boolean value in the JSONArray. If the index is greater than the length of the JSONArray, then null elements will be added as necessary to pad it out.
index | The subscript. |
---|---|
value | A boolean value. |
JSONException | If the index is negative. |
---|
Put or replace a long value. If the index is greater than the length of the JSONArray, then null elements will be added as necessary to pad it out.
index | The subscript. |
---|---|
value | A long value. |
JSONException | If the index is negative. |
---|
Append a boolean value. This increases the array's length by one.
value | A boolean value. |
---|
Append an long value. This increases the array's length by one.
value | A long value. |
---|
Append an int value. This increases the array's length by one.
value | An int value. |
---|
Put or replace an object value in the JSONArray. If the index is greater than the length of the JSONArray, then null elements will be added as necessary to pad it out.
index | The subscript. |
---|---|
value | The value to put into the array. |
JSONException | If the index is negative or if the the value is an invalid number. |
---|
Append an object value. This increases the array's length by one.
value | An object value. The value should be a Boolean, Double, Integer, JSONArray, JSObject, Long, or String, or the JSONObject.NULL object. |
---|
Put or replace a double value. If the index is greater than the length of the JSONArray, then null elements will be added as necessary to pad it out.
index | The subscript. |
---|---|
value | A double value. |
JSONException | If the index is negative or if the value is not finite. |
---|
Append a double value. This increases the array's length by one.
value | A double value. |
---|
JSONException | if the value is not finite. |
---|
Put or replace an int value. If the index is greater than the length of the JSONArray, then null elements will be added as necessary to pad it out.
index | The subscript. |
---|---|
value | An int value. |
JSONException | If the index is negative. |
---|
Produce a JSONObject by combining a JSONArray of names with the values of this JSONArray.
names | A JSONArray containing a list of key strings. These will be paired with the values. |
---|
JSONException | If any of the names are null. |
---|
Make an JSON text of this JSONArray. For compactness, no unnecessary whitespace is added. If it is not possible to produce a syntactically correct JSON text then null will be returned instead. This could occur if the array contains an invalid number.
Warning: This method assumes that the data structure is acyclical.
Make a prettyprinted JSON text of this JSONArray. Warning: This method assumes that the data structure is acyclical.
indentFactor | The number of spaces to add to each level of indentation. |
---|
[
(left bracket) and ending
with ]
(right bracket).JSONException |
---|