|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectwslite.json.JSONArray
public class 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
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).Constructor Summary | |
JSONArray()
Construct an empty JSONArray. |
|
JSONArray(JSONTokener x)
Construct a JSONArray from a JSONTokener. |
|
JSONArray(java.lang.String source)
Construct a JSONArray from a source JSON text. |
|
JSONArray(java.util.Collection collection)
Construct a JSONArray from a Collection. |
|
JSONArray(java.lang.Object array)
Construct a JSONArray from an array |
Method Summary | |
---|---|
boolean
|
add(java.lang.Object o)
|
void
|
add(int index, java.lang.Object element)
|
boolean
|
addAll(java.util.Collection c)
|
boolean
|
addAll(int index, java.util.Collection c)
|
void
|
clear()
|
boolean
|
contains(java.lang.Object o)
|
boolean
|
containsAll(java.util.Collection c)
|
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
|
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 index)
|
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(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(int value)
Append an int value. |
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. |
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, 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. |
java.lang.Object
|
remove(int index)
Remove an index and close the hole. |
boolean
|
remove(java.lang.Object o)
|
boolean
|
removeAll(java.util.Collection c)
|
boolean
|
retainAll(java.util.Collection c)
|
java.lang.Object
|
set(int index, java.lang.Object element)
|
int
|
size()
|
java.util.List
|
subList(int fromIndex, int toIndex)
|
Object[]
|
toArray()
|
Object[]
|
toArray(Object[] a)
|
JSONObject
|
toJSONObject(JSONArray names)
Produce a JSONObject by combining a JSONArray of names with the values of this JSONArray. |
java.lang.String
|
toString()
Make a JSON text of this JSONArray. |
java.lang.String
|
toString(int indentFactor)
Make a prettyprinted 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. |
Methods inherited from 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() |
Constructor Detail |
---|
public JSONArray()
public JSONArray(JSONTokener x)
x
- A JSONTokener
public JSONArray(java.lang.String source)
source
- A string that begins with
[
(left bracket)
and ends with ]
(right bracket).
public JSONArray(java.util.Collection collection)
collection
- A Collection.
public JSONArray(java.lang.Object array)
Method Detail |
---|
public boolean add(java.lang.Object o)
public void add(int index, java.lang.Object element)
public boolean addAll(java.util.Collection c)
public boolean addAll(int index, java.util.Collection c)
public void clear()
public boolean contains(java.lang.Object o)
public boolean containsAll(java.util.Collection c)
public java.lang.Object get(int index)
index
- The index must be between 0 and length() - 1.
public boolean getBoolean(int index)
index
- The index must be between 0 and length() - 1.
public double getDouble(int index)
index
- The index must be between 0 and length() - 1.
public int getInt(int index)
index
- The index must be between 0 and length() - 1.
public JSONArray getJSONArray(int index)
index
- The index must be between 0 and length() - 1.
public JSONObject getJSONObject(int index)
index
- subscript
public long getLong(int index)
index
- The index must be between 0 and length() - 1.
public java.lang.String getString(int index)
index
- The index must be between 0 and length() - 1.
public int indexOf(java.lang.Object o)
public boolean isEmpty()
public boolean isNull(int index)
index
- The index must be between 0 and length() - 1.
public java.util.Iterator iterator()
public java.lang.String join(java.lang.String separator)
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.
public int lastIndexOf(java.lang.Object o)
public int length()
public java.util.ListIterator listIterator()
public java.util.ListIterator listIterator(int index)
public java.lang.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
- subscript
public 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 java.lang.String optString(int index)
index
- The index must be between 0 and length() - 1.
public java.lang.String optString(int index, java.lang.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(java.util.Collection value)
value
- A Collection value.
public JSONArray put(double value)
value
- A double value.
public JSONArray put(int value)
value
- An int value.
public JSONArray put(long value)
value
- A long value.
public JSONArray put(java.util.Map value)
value
- A Map value.
public 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.
public JSONArray put(int index, boolean value)
index
- The subscript.value
- A boolean value.
public JSONArray put(int index, java.util.Collection value)
index
- The subscript.value
- A Collection value.
public JSONArray put(int index, double value)
index
- The subscript.value
- A double value.
public JSONArray put(int index, int value)
index
- The subscript.value
- An int value.
public JSONArray put(int index, long value)
index
- The subscript.value
- A long value.
public JSONArray put(int index, java.util.Map value)
index
- The subscript.value
- The Map value.
public JSONArray put(int index, java.lang.Object value)
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.
public java.lang.Object remove(int index)
index
- The index of the element to be removed.
public boolean remove(java.lang.Object o)
public boolean removeAll(java.util.Collection c)
public boolean retainAll(java.util.Collection c)
public java.lang.Object set(int index, java.lang.Object element)
public int size()
public java.util.List subList(int fromIndex, int toIndex)
public Object[] toArray()
public Object[] toArray(Object[] a)
public JSONObject toJSONObject(JSONArray names)
names
- A JSONArray containing a list of key strings. These will be
paired with the values.
public java.lang.String toString()
Warning: This method assumes that the data structure is acyclical.
public java.lang.String toString(int indentFactor)
indentFactor
- The number of spaces to add to each level of
indentation.[
(left bracket) and ending
with ]
(right bracket).
public java.io.Writer write(java.io.Writer writer)
Warning: This method assumes that the data structure is acyclical.
Groovy Documentation