public class JSONArray extends java.lang.Object implements JSONElement, java.lang.Iterable<java.lang.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 coercion 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.| Constructor and Description |
|---|
JSONArray()
Construct an empty JSONArray.
|
JSONArray(java.util.Collection<?> collection)
Construct a JSONArray from a Collection.
|
JSONArray(JSONTokener x)
Construct a JSONArray from a JSONTokener.
|
JSONArray(java.lang.Object array)
Construct a JSONArray from an array
|
JSONArray(java.lang.String source)
Construct a JSONArray from a source JSON text.
|
| Modifier and Type | Method and Description |
|---|---|
JSONArray |
clone()
Clone the element.
|
static JSONArray |
create()
Create a new JSONArray.
|
boolean |
equals(java.lang.Object o) |
java.lang.Object |
get(int index)
Get the object value associated with an index.
|
java.math.BigDecimal |
getBigDecimal(int index)
Get the BigDecimal value associated with an index.
|
java.math.BigInteger |
getBigInteger(int index)
Get the BigInteger 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.
|
<E extends java.lang.Enum<E>> |
getEnum(java.lang.Class<E> clazz,
int index)
Get the enum value associated with an index.
|
float |
getFloat(int index)
Get the float value associated with a key.
|
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.Number |
getNumber(int index)
Get the Number value associated with a key.
|
java.lang.String |
getString(int index)
Get the string associated with an index.
|
int |
hashCode() |
boolean |
isEmpty()
Check if JSONArray is empty.
|
boolean |
isNull(int index)
Determine if the value is
null. |
java.util.Iterator<java.lang.Object> |
iterator() |
java.lang.String |
join(java.lang.String separator)
Make a string from the contents of this JSONArray.
|
int |
length()
Get the number of elements in the JSONArray, included nulls.
|
java.lang.Object |
opt(int index)
Get the optional object value associated with an index.
|
java.math.BigDecimal |
optBigDecimal(int index,
java.math.BigDecimal defaultValue)
Get the optional BigDecimal value associated with an index.
|
java.math.BigInteger |
optBigInteger(int index,
java.math.BigInteger defaultValue)
Get the optional BigInteger 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.
|
<E extends java.lang.Enum<E>> |
optEnum(java.lang.Class<E> clazz,
int index)
Get the enum value associated with a key.
|
<E extends java.lang.Enum<E>> |
optEnum(java.lang.Class<E> clazz,
int index,
E defaultValue)
Get the enum value associated with a key.
|
float |
optFloat(int index)
Get the optional float value associated with an index.
|
float |
optFloat(int index,
float defaultValue)
Get the optional float 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.Number |
optNumber(int index)
Get an optional
Number value associated with a key, or null if there is no such key or if the value is not a number. |
java.lang.Number |
optNumber(int index,
java.lang.Number defaultValue)
Get an optional
Number value associated with a key, or the default if there is no such key or if the value is not a number. |
java.lang.Object |
optQuery(JSONPointer jsonPointer)
Queries and returns a value from this object using
jsonPointer, or returns null if the query fails due to a missing key. |
java.lang.Object |
optQuery(java.lang.String jsonPointer)
Queries and returns a value from this object using
jsonPointer, or returns null if the query fails due to a missing key. |
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(java.util.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(float value)
Append a float value.
|
JSONArray |
put(int value)
Append an int value.
|
JSONArray |
put(int index,
boolean value)
Put or replace a boolean value in the JSONArray.
|
JSONArray |
put(int index,
java.util.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,
float value)
Put or replace a float 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.util.Map<?,?> value)
Put a value in the JSONArray, where the value will be a JSONObject that is produced from a Map.
|
JSONArray |
put(int index,
java.lang.Object value)
Put or replace an object value in the JSONArray.
|
JSONArray |
put(long value)
Append an long value.
|
JSONArray |
put(java.util.Map<?,?> value)
Put a value in the JSONArray, where the value will be a JSONObject which is produced from a Map.
|
JSONArray |
put(java.lang.Object value)
Append an object value.
|
java.lang.Object |
query(JSONPointer jsonPointer)
Uses a uaer initialized JSONPointer and tries to match it to an item whithin this JSONArray.
|
java.lang.Object |
query(java.lang.String jsonPointer)
Creates a JSONPointer using an initialization string and tries to match it to an item within this JSONArray.
|
java.lang.Object |
remove(int index)
Remove an index and close the hole.
|
boolean |
similar(java.lang.Object other)
Determine if two JSONArrays are similar.
|
JSONObject |
toJSONObject(JSONArray names)
Produce a JSONObject by combining a JSONArray of names with the values of this JSONArray.
|
java.util.List<java.lang.Object> |
toList()
Returns a java.util.List containing all of the elements in this array.
|
java.lang.String |
toString()
Make a JSON text of this JSONArray.
|
java.lang.String |
toString(int indentFactor)
Make a pretty-printed JSON text of this JSONArray.
|
java.io.Writer |
write(java.io.Writer writer)
Write the contents of the JSONArray as JSON text to a writer.
|
java.io.Writer |
write(java.io.Writer writer,
int indent)
Write the contents of the JSONArray as JSON text to a writer.
|
java.io.Writer |
write(java.io.Writer writer,
int indent,
boolean isValue,
JSONOptions options)
Write the contents of the JSONArray as JSON text to a writer.
|
finalize, getClass, notify, notifyAll, wait, wait, waitfromString, writepublic JSONArray()
public JSONArray(JSONTokener x) throws JSONException
x - A JSONTokenerJSONException - If there is a syntax error.public JSONArray(java.lang.String source)
throws JSONException
source - A string that begins with [ (left bracket) and ends with ] (right
bracket).JSONException - If there is a syntax error.public JSONArray(java.util.Collection<?> collection)
collection - A Collection.public JSONArray(java.lang.Object array)
throws JSONException
array - the arrayJSONException - If not an array or if an array value is non-finite number.public static JSONArray create()
public JSONArray clone()
JSONElementclone in interface JSONElementclone in class java.lang.Objectpublic boolean equals(java.lang.Object o)
equals in class java.lang.Objectpublic int hashCode()
hashCode in class java.lang.Objectpublic java.util.Iterator<java.lang.Object> iterator()
iterator in interface java.lang.Iterable<java.lang.Object>public java.lang.Object get(int index)
throws JSONException
index - The index must be between 0 and length() - 1.JSONException - If there is no value for the index.public boolean getBoolean(int index)
throws JSONException
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 convertible to boolean.public double getDouble(int index)
throws JSONException
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.public float getFloat(int index)
throws JSONException
index - The index must be between 0 and length() - 1.JSONException - if the key is not found or if the value is not a Number object and cannot be converted to a number.public java.lang.Number getNumber(int index)
throws JSONException
index - The index must be between 0 and length() - 1.JSONException - if the key is not found or if the value is not a Number object and cannot be converted to a number.public <E extends java.lang.Enum<E>> E getEnum(java.lang.Class<E> clazz,
int index)
throws JSONException
E - the enum classclazz - The type of enum to retrieveindex - The index must be between 0 and length() - 1JSONException - if the key is not found or if the value cannot be converted to an enum.public java.math.BigDecimal getBigDecimal(int index)
throws JSONException
index - The index must be between 0 and length() - 1JSONException - If the key is not found or if the value cannot be converted to a BigDecimalpublic java.math.BigInteger getBigInteger(int index)
throws JSONException
index - The index must be between 0 and length() - 1JSONException - If the key is not found or if the value cannot be converted to a BigInteger.public int getInt(int index)
throws JSONException
index - The index must be between 0 and length() - 1JSONException - If the key is not found or if the value is not a numberpublic JSONArray getJSONArray(int index) throws JSONException
index - The index must be between 0 and length() - 1JSONException - If there is no value for the index. or if the value is not a JSONArraypublic JSONObject getJSONObject(int index) throws JSONException
index - subscriptJSONException - If there is no value for the index or if the value is not a JSONObjectpublic long getLong(int index)
throws JSONException
index - The index must be between 0 and length() - 1JSONException - If the key is not found or if the value cannot be converted to a number.public java.lang.String getString(int index)
throws JSONException
index - The index must be between 0 and length() - 1JSONException - If there is no string value for the index.public boolean isNull(int index)
null.index - The index must be between 0 and length() - 1null, or if there is no value.public java.lang.String join(java.lang.String separator)
throws JSONException
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 elementsJSONException - If the array contains an invalid number.public int length()
length in interface JSONElementpublic java.lang.Object opt(int index)
index - The index must be between 0 and length() - 1. If not, null is returnedpublic boolean optBoolean(int index)
index - The index must be between 0 and length() - 1public boolean optBoolean(int index,
boolean defaultValue)
index - The index must be between 0 and length() - 1defaultValue - A boolean default.public double optDouble(int index)
index - The index must be between 0 and length() - 1public double optDouble(int index,
double defaultValue)
index - subscriptdefaultValue - The default valuepublic float optFloat(int index)
index - The index must be between 0 and length() - 1public float optFloat(int index,
float defaultValue)
index - subscriptdefaultValue - The default valuepublic int optInt(int index)
index - The index must be between 0 and length() - 1public int optInt(int index,
int defaultValue)
index - The index must be between 0 and length() - 1defaultValue - The default valuepublic <E extends java.lang.Enum<E>> E optEnum(java.lang.Class<E> clazz,
int index)
E - the enum classclazz - The type of enum to retrieveindex - The index must be between 0 and length() - 1public <E extends java.lang.Enum<E>> E optEnum(java.lang.Class<E> clazz,
int index,
E defaultValue)
E - the enum classclazz - The type of enum to retrieveindex - The index must be between 0 and length() - 1defaultValue - The default in case the value is not foundpublic java.math.BigInteger optBigInteger(int index,
java.math.BigInteger defaultValue)
index - The index must be between 0 and length() - 1defaultValue - The default value.public java.math.BigDecimal optBigDecimal(int index,
java.math.BigDecimal defaultValue)
index - The index must be between 0 and length() - 1defaultValue - The default valuepublic JSONArray optJSONArray(int index)
index - subscriptpublic JSONObject optJSONObject(int index)
index - The index must be between 0 and length() - 1public long optLong(int index)
index - The index must be between 0 and length() - 1public long optLong(int index,
long defaultValue)
index - The index must be between 0 and length() - 1defaultValue - The default valuepublic java.lang.Number optNumber(int index)
Number value associated with a key, or null if there is no such key or if the value is not a number. If the
value is a string, an attempt will be made to evaluate it as a number (BigDecimal). This method would be used in cases where type
coercion of the number value is unwanted.index - The index must be between 0 and length() - 1public java.lang.Number optNumber(int index,
java.lang.Number defaultValue)
Number value associated with a key, or the default if there is no such key or if the value is not a number. If the value
is a string, an attempt will be made to evaluate it as a number (BigDecimal). This method would be used in cases where type coercion of
the number value is unwanted.index - The index must be between 0 and length() - 1defaultValue - The defaultpublic java.lang.String optString(int index)
index - The index must be between 0 and length() - 1public java.lang.String optString(int index,
java.lang.String defaultValue)
index - The index must be between 0 and length() - 1defaultValue - The default valuepublic JSONArray put(boolean value)
value - A boolean valuepublic JSONArray put(java.util.Collection<?> value)
value - A Collection valueJSONException - If the value is non-finite numberpublic JSONArray put(double value) throws JSONException
value - A double valueJSONException - if the value is not finitepublic JSONArray put(float value) throws JSONException
value - A float valueJSONException - if the value is not finitepublic JSONArray put(int value)
value - An int valuepublic JSONArray put(long value)
value - A long valuepublic JSONArray put(java.util.Map<?,?> value)
value - A Map valueJSONException - If a value in the map is non-finite numberjava.lang.NullPointerException - If a key in the map is nullpublic JSONArray put(java.lang.Object value)
value - An object value. The value should be a Boolean, Double, Integer, JSONArray, JSONObject, Long, or String, or the JSONObject.NULL
object.JSONException - If the value is non-finite numberpublic JSONArray put(int index, boolean value) throws JSONException
index - The subscriptvalue - A boolean valueJSONException - If the index is negativepublic JSONArray put(int index, java.util.Collection<?> value) throws JSONException
index - The subscriptvalue - A Collection valueJSONException - If the index is negative or if the value is non-finitepublic JSONArray put(int index, double value) throws JSONException
index - The subscriptvalue - A double valueJSONException - If the index is negative or if the value is non-finitepublic JSONArray put(int index, float value) throws JSONException
index - The subscriptvalue - A float valueJSONException - If the index is negative or if the value is non-finitepublic JSONArray put(int index, int value) throws JSONException
index - The subscriptvalue - An int valueJSONException - If the index is negativepublic JSONArray put(int index, long value) throws JSONException
index - The subscriptvalue - A long valueJSONException - If the index is negativepublic JSONArray put(int index, java.util.Map<?,?> value) throws JSONException
index - The subscriptvalue - The Map valueJSONException - If the index is negative or if the the value is an invalid numberjava.lang.NullPointerException - If a key in the map is nullpublic JSONArray put(int index, java.lang.Object value) throws JSONException
index - The subscriptvalue - 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.JSONException - If the index is negative or if the the value is an invalid numberpublic java.lang.Object query(java.lang.String jsonPointer)
[
{"b":"c"}
]
and this JSONPointer string:
"/0/b"Then this method will return the String "c" A JSONPointerException may be thrown from code called by this method.
query in interface JSONElementjsonPointer - string that can be used to create a JSONPointerpublic java.lang.Object query(JSONPointer jsonPointer)
[
{"b":"c"}
]
and this JSONPointer:
"/0/b"Then this method will return the String "c" A JSONPointerException may be thrown from code called by this method.
query in interface JSONElementjsonPointer - string that can be used to create a JSONPointerpublic java.lang.Object optQuery(java.lang.String jsonPointer)
jsonPointer, or returns null if the query fails due to a missing key.jsonPointer - the string representation of the JSON pointernulljava.lang.IllegalArgumentException - if jsonPointer has invalid syntaxpublic java.lang.Object optQuery(JSONPointer jsonPointer)
jsonPointer, or returns null if the query fails due to a missing key.jsonPointer - The JSON pointernulljava.lang.IllegalArgumentException - if jsonPointer has invalid syntaxpublic java.lang.Object remove(int index)
index - The index of the element to be removedpublic boolean similar(java.lang.Object other)
other - The other JSONArraypublic JSONObject toJSONObject(JSONArray names) throws JSONException
names - A JSONArray containing a list of key strings. These will be paired with the valuesJSONException - If any of the names are nullpublic java.lang.String toString()
Warning: This method assumes that the data structure is acyclical.
toString in class java.lang.Objectpublic java.lang.String toString(int indentFactor)
throws JSONException
If indentFactor > 0 and the JSONArray has only one element, then the array will be output on a single line:
[1]
If an array has 2 or more elements, then it will be output across multiple lines:
[
1,
"value 2",
3
]
Warning: This method assumes that the data structure is acyclical.
toString in interface JSONElementindentFactor - The number of spaces to add to each level of indentation[ (left bracket)
and ending with ] (right bracket).JSONExceptionpublic java.io.Writer write(java.io.Writer writer)
throws JSONException
Warning: This method assumes that the data structure is acyclical.
write in interface JSONElementwriter - the writerJSONExceptionpublic java.io.Writer write(java.io.Writer writer,
int indent)
throws JSONException
write in interface JSONElementwriter - Writes the serialized JSONindent - The indentation of the top levelJSONExceptionpublic java.io.Writer write(java.io.Writer writer,
int indent,
boolean isValue,
JSONOptions options)
throws JSONException
If indentFactor > 0 and the JSONArray has only one element, then the array will be output on a single line:
[1]
If an array has 2 or more elements, then it will be output across multiple lines:
[
1,
"value 2",
3
]
Warning: This method assumes that the data structure is acyclical.
write in interface JSONElementwriter - Writes the serialized JSONindent - The indentation of the top levelisValue - true to write a valueoptions - true if the natural ordering of the keys must be keptJSONExceptionpublic java.util.List<java.lang.Object> toList()
Warning: This method assumes that the data structure is acyclical.
public boolean isEmpty()
isEmpty in interface JSONElementCopyright (C) 2017 Wei Song. Copyright (c) 2002 JSON.org. Copyright © 2018, 2019, 2026 Herve Girod. All Rights Reserved. elasticlunr Documentation and source under the MIT licence. JSON Documentation and source under the JSON licence