@java.lang.SuppressWarnings({ "unchecked", "rawtypes" }) public class JSONArray extends java.lang.Object
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
.
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 and description |
---|
JSONArray
() Construct an empty JSONArray. |
JSONArray
(JSONTokener x) Construct a JSONArray from a JSONTokener. |
JSONArray
(java.lang.String string) Construct a JSONArray from a source sJSON text. |
JSONArray
(java.util.Collection collection) Construct a JSONArray from a Collection. |
Type Params | Return Type | Name and description |
---|---|---|
|
boolean |
add(java.lang.Object o) |
|
void |
add(int i, java.lang.Object o) |
|
boolean |
addAll(java.util.Collection collection) |
|
boolean |
addAll(int i, java.util.Collection collection) |
|
void |
clear() |
|
java.lang.Object |
clone() |
|
boolean |
contains(java.lang.Object o) |
|
boolean |
containsAll(java.util.Collection collection) |
|
void |
ensureCapacity(int i) |
|
boolean |
equals(java.lang.Object obj) If the passed object is a JSONArray, then the underlying collection must be equal. |
|
java.lang.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. |
|
java.lang.String |
getString(int index) Get the string associated with an index. |
|
int |
hashCode() |
|
int |
indexOf(java.lang.Object o) |
|
boolean |
isEmpty() |
|
boolean |
isNull(int index) Determine if the value is null. |
|
java.util.Iterator |
iterator() |
|
java.lang.String |
join(java.lang.String separator) Make a string from the contents of this JSONArray. |
|
int |
lastIndexOf(java.lang.Object o) |
|
int |
length() Get the number of elements in the JSONArray, included nulls. |
|
java.util.ListIterator |
listIterator() |
|
java.util.ListIterator |
listIterator(int i) |
|
java.lang.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. |
|
java.lang.String |
optString(int index) Get the optional string value associated with an index. |
|
java.lang.String |
optString(int index, java.lang.String defaultValue) Get the optional string associated with an index. |
|
JSONArray |
put(boolean value) Append a boolean value. |
|
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(java.lang.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, 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, java.lang.Object value) Put or replace an object value in the JSONArray. |
|
java.lang.Object |
remove(int i) |
|
boolean |
remove(java.lang.Object o) |
|
boolean |
removeAll(java.util.Collection collection) |
|
boolean |
retainAll(java.util.Collection collection) |
|
java.lang.Object |
set(int i, java.lang.Object o) |
|
int |
size() |
|
java.util.List |
subList(int i, int i1) |
|
java.lang.Object[] |
toArray() |
|
java.lang.Object[] |
toArray(java.lang.Object[] objects) |
|
JSONObject |
toJSONObject(JSONArray names) Produce a JSONObject by combining a JSONArray of names with the values of this JSONArray. |
|
java.lang.String |
toString() Make an JSON text of this JSONArray. |
|
java.lang.String |
toString(int indentFactor) Make a prettyprinted JSON text of this JSONArray. |
|
void |
trimToSize() |
|
java.io.Writer |
write(java.io.Writer writer) Write the contents of the JSONArray as JSON text to a writer. |
|
java.io.Writer |
writeTo(java.io.Writer out) |
Methods inherited from class | Name |
---|---|
class java.lang.Object |
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
Construct an empty JSONArray.
Construct a JSONArray from a JSONTokener.
x
- A JSONTokenerConstruct a JSONArray from a source sJSON text.
string
- A string that begins with
[
(left bracket)
and ends with ]
(right bracket).Construct a JSONArray from a Collection.
collection
- A Collection.If the passed object is a JSONArray, then the underlying collection must be equal.
Get the object value associated with an index.
index
- The index must be between 0 and length() - 1.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.Get the double value associated with an index.
index
- The index must be between 0 and length() - 1.Get the int value associated with an index.
index
- The index must be between 0 and length() - 1.Get the JSONArray associated with an index.
index
- The index must be between 0 and length() - 1.Get the JSONObject associated with an index.
index
- subscriptGet the long value associated with an index.
index
- The index must be between 0 and length() - 1.Get the string associated with an index.
index
- The index must be between 0 and length() - 1.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.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 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 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 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 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
- subscriptdefaultValue
- 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 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 JSONArray associated with an index.
index
- subscriptGet 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. 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 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 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.Append a boolean value. This increases the array's length by one.
value
- A boolean value.Append a double value. This increases the array's length by one.
value
- A double value.Append an int value. This increases the array's length by one.
value
- An int value.Append an long value. This increases the array's length by one.
value
- A long value.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 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.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.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.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.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.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.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).Write the contents of the JSONArray as JSON text to a writer. For compactness, no whitespace is added.
Warning: This method assumes that the data structure is acyclical.