public class JsonArray extends JsonValue implements java.lang.Iterable<JsonValue>
Elements can be added using the add(...)
methods which accept instances of
JsonValue
, strings, primitive numbers, and boolean values. To replace an element of an
array, use the set(int, ...)
methods.
Elements can be accessed by their index using get(int)
. This class also supports
iterating over the elements in document order using an iterator()
or an enhanced for
loop:
for( JsonValue value : jsonArray ) { ... }
An equivalent List
can be obtained from the method values()
.
Note that this class is not thread-safe. If multiple threads access a
JsonArray
instance concurrently, while at least one of these threads modifies the
contents of this array, access to the instance must be synchronized externally. Failure to do so
may lead to an inconsistent state.
This class is not supposed to be extended by clients.
Constructor and Description |
---|
JsonArray()
Creates a new empty JsonArray.
|
JsonArray(JsonArray array)
Creates a new JsonArray with the contents of the specified JSON array.
|
Modifier and Type | Method and Description |
---|---|
JsonArray |
add(boolean value)
Adds the JSON representation of the specified
boolean value to the array. |
JsonArray |
add(double value)
Adds the JSON representation of the specified
double value to the array. |
JsonArray |
add(float value)
Adds the JSON representation of the specified
float value to the array. |
JsonArray |
add(int value)
Adds the JSON representation of the specified
int value to the array. |
JsonArray |
add(JsonValue value)
Adds the specified JSON value to the array.
|
JsonArray |
add(long value)
Adds the JSON representation of the specified
long value to the array. |
JsonArray |
add(java.lang.String value)
Adds the JSON representation of the specified string to the array.
|
JsonArray |
asArray()
Returns this JSON value as
JsonArray , assuming that this value represents a JSON
array. |
boolean |
equals(java.lang.Object object)
Indicates whether some other object is "equal to" this one according to the contract specified
in
Object.equals(Object) . |
JsonValue |
get(int index)
Returns the value of the element at the specified position in this array.
|
int |
hashCode() |
boolean |
isArray()
Detects whether this value represents a JSON array.
|
boolean |
isEmpty()
Returns
true if this array contains no elements. |
java.util.Iterator<JsonValue> |
iterator()
Returns an iterator over the values of this array in document order.
|
static JsonArray |
readFrom(java.io.Reader reader)
Reads a JSON array from the given reader.
|
static JsonArray |
readFrom(java.lang.String string)
Reads a JSON array from the given string.
|
JsonArray |
set(int index,
boolean value)
Replaces the element at the specified position in this array with the JSON representation of
the specified
boolean value. |
JsonArray |
set(int index,
double value)
Replaces the element at the specified position in this array with the JSON representation of
the specified
double value. |
JsonArray |
set(int index,
float value)
Replaces the element at the specified position in this array with the JSON representation of
the specified
float value. |
JsonArray |
set(int index,
int value)
Replaces the element at the specified position in this array with the JSON representation of
the specified
int value. |
JsonArray |
set(int index,
JsonValue value)
Replaces the element at the specified position in this array with the specified JSON value.
|
JsonArray |
set(int index,
long value)
Replaces the element at the specified position in this array with the JSON representation of
the specified
long value. |
JsonArray |
set(int index,
java.lang.String value)
Replaces the element at the specified position in this array with the JSON representation of
the specified string.
|
int |
size()
Returns the number of elements in this array.
|
static JsonArray |
unmodifiableArray(JsonArray array)
Returns an unmodifiable wrapper for the specified JsonArray.
|
java.util.List<JsonValue> |
values()
Returns a list of the values in this array in document order.
|
protected void |
write(org.eclipse.rap.json.JsonWriter writer) |
public JsonArray()
public JsonArray(JsonArray array)
array
- the JsonArray to get the initial contents from, must not be null
public static JsonArray readFrom(java.io.Reader reader) throws java.io.IOException
Characters are read in chunks and buffered internally, therefore wrapping an existing reader in
an additional BufferedReader
does not improve reading
performance.
reader
- the reader to read the JSON array fromjava.io.IOException
- if an I/O error occurs in the readerParseException
- if the input is not valid JSONjava.lang.UnsupportedOperationException
- if the input does not contain a JSON arraypublic static JsonArray readFrom(java.lang.String string)
string
- the string that contains the JSON arrayParseException
- if the input is not valid JSONjava.lang.UnsupportedOperationException
- if the input does not contain a JSON arraypublic static JsonArray unmodifiableArray(JsonArray array)
The returned JsonArray is backed by the given array and reflects subsequent changes. Attempts
to modify the returned JsonArray result in an UnsupportedOperationException
.
array
- the JsonArray for which an unmodifiable JsonArray is to be returnedpublic JsonArray add(int value)
int
value to the array.value
- the value to add to the arraypublic JsonArray add(long value)
long
value to the array.value
- the value to add to the arraypublic JsonArray add(float value)
float
value to the array.value
- the value to add to the arraypublic JsonArray add(double value)
double
value to the array.value
- the value to add to the arraypublic JsonArray add(boolean value)
boolean
value to the array.value
- the value to add to the arraypublic JsonArray add(java.lang.String value)
value
- the string to add to the arraypublic JsonArray add(JsonValue value)
value
- the JsonValue to add to the array, must not be null
public JsonArray set(int index, int value)
int
value.index
- the index of the array element to replacevalue
- the value to be stored at the specified array positionjava.lang.IndexOutOfBoundsException
- if the index is out of range, i.e. index < 0
or
index >= size
public JsonArray set(int index, long value)
long
value.index
- the index of the array element to replacevalue
- the value to be stored at the specified array positionjava.lang.IndexOutOfBoundsException
- if the index is out of range, i.e. index < 0
or
index >= size
public JsonArray set(int index, float value)
float
value.index
- the index of the array element to replacevalue
- the value to be stored at the specified array positionjava.lang.IndexOutOfBoundsException
- if the index is out of range, i.e. index < 0
or
index >= size
public JsonArray set(int index, double value)
double
value.index
- the index of the array element to replacevalue
- the value to be stored at the specified array positionjava.lang.IndexOutOfBoundsException
- if the index is out of range, i.e. index < 0
or
index >= size
public JsonArray set(int index, boolean value)
boolean
value.index
- the index of the array element to replacevalue
- the value to be stored at the specified array positionjava.lang.IndexOutOfBoundsException
- if the index is out of range, i.e. index < 0
or
index >= size
public JsonArray set(int index, java.lang.String value)
index
- the index of the array element to replacevalue
- the string to be stored at the specified array positionjava.lang.IndexOutOfBoundsException
- if the index is out of range, i.e. index < 0
or
index >= size
public JsonArray set(int index, JsonValue value)
index
- the index of the array element to replacevalue
- the value to be stored at the specified array position, must not be null
java.lang.IndexOutOfBoundsException
- if the index is out of range, i.e. index < 0
or
index >= size
public int size()
public boolean isEmpty()
true
if this array contains no elements.true
if this array contains no elementspublic JsonValue get(int index)
index
- the index of the array element to returnjava.lang.IndexOutOfBoundsException
- if the index is out of range (index < 0 || index >= size()).public java.util.List<JsonValue> values()
public java.util.Iterator<JsonValue> iterator()
iterator
in interface java.lang.Iterable<JsonValue>
protected void write(org.eclipse.rap.json.JsonWriter writer) throws java.io.IOException
public boolean isArray()
JsonValue
JsonArray
.public JsonArray asArray()
JsonValue
JsonArray
, assuming that this value represents a JSON
array. If this is not the case, an exception is thrown.public boolean equals(java.lang.Object object)
JsonValue
Object.equals(Object)
.
Two JsonValues are considered equal if and only if they represent the same JSON text. As a consequence, two given JsonObjects may be different even though they contain the same set of names with the same values, but in a different order.
Copyright (c) EclipseSource and others 2002, 2017.
All rights reserved. This program and the accompanying materials
are made available under the terms of the
Eclipse Public License v1.0