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
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
.;
(semicolon) as
well as by ,
(comma).0-
(octal) or
0x-
(hex) prefix.Constructor and Description |
---|
JSONArray()
Construct an empty JSONArray.
|
JSONArray(Collection collection)
Construct a JSONArray from a Collection.
|
JSONArray(Collection collection,
boolean includeSuperClass)
Construct a JSONArray from a collection of beans.
|
JSONArray(JSONTokener x)
Construct a JSONArray from a JSONTokener.
|
JSONArray(Object array)
Construct a JSONArray from an array
|
JSONArray(Object array,
boolean includeSuperClass)
Construct a JSONArray from an array with a bean.
|
JSONArray(String source)
Construct a JSONArray from a source JSON text.
|
Modifier and Type | Method and Description |
---|---|
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(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.
|
JSONArray |
put(long value)
Append a 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.
|
Object |
remove(int index)
Remove an index and close the hole.
|
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 pretty-printed JSON text of this JSONArray.
|
Writer |
write(Writer writer)
Write the contents of the JSONArray as JSON text to a writer.
|
public JSONArray()
public JSONArray(JSONTokener x) throws JSONException
x
- A JSONTokenerJSONException
- If there is a syntax error.public JSONArray(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(Collection collection)
collection
- A Collection.public JSONArray(Collection collection, boolean includeSuperClass)
public JSONArray(Object array) throws JSONException
JSONException
- If not an array.public JSONArray(Object array, boolean includeSuperClass) throws JSONException
JSONException
- If not an array.public 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 convertable 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 int getInt(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.
if the value cannot be converted to a number.public JSONArray getJSONArray(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 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() - 1.JSONException
- If the key is not found or if the value cannot
be converted to a number.public String getString(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 isNull(int index)
index
- The index must be between 0 and length() - 1.public String join(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 elements.JSONException
- If the array contains an invalid number.public int length()
public Object opt(int index)
index
- The index must be between 0 and length() - 1.public boolean optBoolean(int index)
index
- The index must be between 0 and length() - 1.public boolean optBoolean(int index, boolean defaultValue)
index
- The index must be between 0 and length() - 1.defaultValue
- A boolean default.public double optDouble(int index)
index
- The index must be between 0 and length() - 1.public double optDouble(int index, double defaultValue)
index
- subscriptdefaultValue
- The default value.public int optInt(int index)
index
- The index must be between 0 and length() - 1.public int optInt(int index, int defaultValue)
index
- The index must be between 0 and length() - 1.defaultValue
- The default value.public JSONArray optJSONArray(int index)
index
- subscriptpublic JSONObject optJSONObject(int index)
index
- The index must be between 0 and length() - 1.public long optLong(int index)
index
- The index must be between 0 and length() - 1.public long optLong(int index, long defaultValue)
index
- The index must be between 0 and length() - 1.defaultValue
- The default value.public String optString(int index)
index
- The index must be between 0 and length() - 1.public String optString(int index, String defaultValue)
index
- The index must be between 0 and length() - 1.defaultValue
- The default value.public JSONArray put(boolean value)
value
- A boolean value.public JSONArray put(Collection value)
value
- A Collection value.public JSONArray put(double value) throws JSONException
value
- A double value.JSONException
- if the value is not finite.public JSONArray put(int value)
value
- An int value.public JSONArray put(long value)
value
- A long value.public JSONArray put(Map value)
value
- A Map value.public JSONArray put(Object value)
value
- An object value. The value should be a
Boolean, Double, Integer, JSONArray, JSONObject, Long, or String, or the
JSONObject.NULL object.public JSONArray put(int index, boolean value) throws JSONException
index
- The subscript.value
- A boolean value.JSONException
- If the index is negative.public JSONArray put(int index, Collection value) throws JSONException
index
- The subscript.value
- A Collection value.JSONException
- If the index is negative or if the value is
not finite.public JSONArray put(int index, double value) throws JSONException
index
- The subscript.value
- A double value.JSONException
- If the index is negative or if the value is
not finite.public JSONArray put(int index, int value) throws JSONException
index
- The subscript.value
- An int value.JSONException
- If the index is negative.public JSONArray put(int index, long value) throws JSONException
index
- The subscript.value
- A long value.JSONException
- If the index is negative.public JSONArray put(int index, Map value) throws JSONException
index
- The subscript.value
- The Map value.JSONException
- If the index is negative or if the the value is
an invalid number.public JSONArray put(int index, Object value) throws JSONException
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.JSONException
- If the index is negative or if the the value is
an invalid number.public Object remove(int index)
index
- The index of the element to be removed.public JSONObject toJSONObject(JSONArray names) throws JSONException
names
- A JSONArray containing a list of key strings. These will be
paired with the values.JSONException
- If any of the names are null.public String toString()
Warning: This method assumes that the data structure is acyclical.
public String toString(int indentFactor) throws JSONException
indentFactor
- The number of spaces to add to each level of indentation.[
(left bracket) and ending with ]
(right bracket).JSONException
public Writer write(Writer writer) throws JSONException
Warning: This method assumes that the data structure is acyclical.
JSONException
Copyright © 2016 JBoss by Red Hat. All rights reserved.