Class JsonArray
- java.lang.Object
-
- org.eclipse.rap.json.JsonValue
-
- org.eclipse.rap.json.JsonArray
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Iterable<JsonValue>
public class JsonArray extends JsonValue implements java.lang.Iterable<JsonValue>
/** Represents a JSON array, i.e. an ordered collection of JSON values.Elements can be added using the
add(...)methods which accept instances ofJsonValue, strings, primitive numbers, and boolean values. To replace an element of an array, use theset(int, ...)methods.Elements can be accessed by their index using
get(int). This class also supports iterating over the elements in document order using aniterator()or an enhanced for loop:for( JsonValue value : jsonArray ) { ... }An equivalent
Listcan be obtained from the methodvalues().Note that this class is not thread-safe. If multiple threads access a
JsonArrayinstance 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.
- Since:
- 2.1
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description JsonArrayadd(boolean value)Adds the JSON representation of the specifiedbooleanvalue to the array.JsonArrayadd(double value)Adds the JSON representation of the specifieddoublevalue to the array.JsonArrayadd(float value)Adds the JSON representation of the specifiedfloatvalue to the array.JsonArrayadd(int value)Adds the JSON representation of the specifiedintvalue to the array.JsonArrayadd(long value)Adds the JSON representation of the specifiedlongvalue to the array.JsonArrayadd(java.lang.String value)Adds the JSON representation of the specified string to the array.JsonArrayadd(JsonValue value)Adds the specified JSON value to the array.JsonArrayasArray()Returns this JSON value asJsonArray, assuming that this value represents a JSON array.booleanequals(java.lang.Object object)Indicates whether some other object is "equal to" this one according to the contract specified inObject.equals(Object).JsonValueget(int index)Returns the value of the element at the specified position in this array.inthashCode()booleanisArray()Detects whether this value represents a JSON array.booleanisEmpty()Returnstrueif this array contains no elements.java.util.Iterator<JsonValue>iterator()Returns an iterator over the values of this array in document order.static JsonArrayreadFrom(java.io.Reader reader)Reads a JSON array from the given reader.static JsonArrayreadFrom(java.lang.String string)Reads a JSON array from the given string.JsonArrayset(int index, boolean value)Replaces the element at the specified position in this array with the JSON representation of the specifiedbooleanvalue.JsonArrayset(int index, double value)Replaces the element at the specified position in this array with the JSON representation of the specifieddoublevalue.JsonArrayset(int index, float value)Replaces the element at the specified position in this array with the JSON representation of the specifiedfloatvalue.JsonArrayset(int index, int value)Replaces the element at the specified position in this array with the JSON representation of the specifiedintvalue.JsonArrayset(int index, long value)Replaces the element at the specified position in this array with the JSON representation of the specifiedlongvalue.JsonArrayset(int index, java.lang.String value)Replaces the element at the specified position in this array with the JSON representation of the specified string.JsonArrayset(int index, JsonValue value)Replaces the element at the specified position in this array with the specified JSON value.intsize()Returns the number of elements in this array.static JsonArrayunmodifiableArray(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 voidwrite(org.eclipse.rap.json.JsonWriter writer)-
Methods inherited from class org.eclipse.rap.json.JsonValue
asBoolean, asDouble, asFloat, asInt, asLong, asObject, asString, isBoolean, isFalse, isNull, isNumber, isObject, isString, isTrue, toString, valueOf, valueOf, valueOf, valueOf, valueOf, valueOf, writeTo
-
-
-
-
Constructor Detail
-
JsonArray
public JsonArray()
Creates a new empty JsonArray.
-
JsonArray
public JsonArray(JsonArray array)
Creates a new JsonArray with the contents of the specified JSON array.- Parameters:
array- the JsonArray to get the initial contents from, must not benull
-
-
Method Detail
-
readFrom
public static JsonArray readFrom(java.io.Reader reader) throws java.io.IOException
Reads a JSON array from the given reader.Characters are read in chunks and buffered internally, therefore wrapping an existing reader in an additional
BufferedReaderdoes not improve reading performance.- Parameters:
reader- the reader to read the JSON array from- Returns:
- the JSON array that has been read
- Throws:
java.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 array
-
readFrom
public static JsonArray readFrom(java.lang.String string)
Reads a JSON array from the given string.- Parameters:
string- the string that contains the JSON array- Returns:
- the JSON array that has been read
- Throws:
ParseException- if the input is not valid JSONjava.lang.UnsupportedOperationException- if the input does not contain a JSON array
-
unmodifiableArray
public static JsonArray unmodifiableArray(JsonArray array)
Returns an unmodifiable wrapper for the specified JsonArray. This method allows to provide read-only access to a JsonArray.The returned JsonArray is backed by the given array and reflects subsequent changes. Attempts to modify the returned JsonArray result in an
UnsupportedOperationException.- Parameters:
array- the JsonArray for which an unmodifiable JsonArray is to be returned- Returns:
- an unmodifiable view of the specified JsonArray
-
add
public JsonArray add(int value)
Adds the JSON representation of the specifiedintvalue to the array.- Parameters:
value- the value to add to the array- Returns:
- the array itself, to enable method chaining
- Since:
- 2.2
-
add
public JsonArray add(long value)
Adds the JSON representation of the specifiedlongvalue to the array.- Parameters:
value- the value to add to the array- Returns:
- the array itself, to enable method chaining
-
add
public JsonArray add(float value)
Adds the JSON representation of the specifiedfloatvalue to the array.- Parameters:
value- the value to add to the array- Returns:
- the array itself, to enable method chaining
-
add
public JsonArray add(double value)
Adds the JSON representation of the specifieddoublevalue to the array.- Parameters:
value- the value to add to the array- Returns:
- the array itself, to enable method chaining
-
add
public JsonArray add(boolean value)
Adds the JSON representation of the specifiedbooleanvalue to the array.- Parameters:
value- the value to add to the array- Returns:
- the array itself, to enable method chaining
-
add
public JsonArray add(java.lang.String value)
Adds the JSON representation of the specified string to the array.- Parameters:
value- the string to add to the array- Returns:
- the array itself, to enable method chaining
-
add
public JsonArray add(JsonValue value)
Adds the specified JSON value to the array.- Parameters:
value- the JsonValue to add to the array, must not benull- Returns:
- the array itself, to enable method chaining
-
set
public JsonArray set(int index, int value)
Replaces the element at the specified position in this array with the JSON representation of the specifiedintvalue.- Parameters:
index- the index of the array element to replacevalue- the value to be stored at the specified array position- Returns:
- the array itself, to enable method chaining
- Throws:
java.lang.IndexOutOfBoundsException- if the index is out of range, i.e.index < 0orindex >= size- Since:
- 2.2
-
set
public JsonArray set(int index, long value)
Replaces the element at the specified position in this array with the JSON representation of the specifiedlongvalue.- Parameters:
index- the index of the array element to replacevalue- the value to be stored at the specified array position- Returns:
- the array itself, to enable method chaining
- Throws:
java.lang.IndexOutOfBoundsException- if the index is out of range, i.e.index < 0orindex >= size- Since:
- 2.2
-
set
public JsonArray set(int index, float value)
Replaces the element at the specified position in this array with the JSON representation of the specifiedfloatvalue.- Parameters:
index- the index of the array element to replacevalue- the value to be stored at the specified array position- Returns:
- the array itself, to enable method chaining
- Throws:
java.lang.IndexOutOfBoundsException- if the index is out of range, i.e.index < 0orindex >= size- Since:
- 2.2
-
set
public JsonArray set(int index, double value)
Replaces the element at the specified position in this array with the JSON representation of the specifieddoublevalue.- Parameters:
index- the index of the array element to replacevalue- the value to be stored at the specified array position- Returns:
- the array itself, to enable method chaining
- Throws:
java.lang.IndexOutOfBoundsException- if the index is out of range, i.e.index < 0orindex >= size- Since:
- 2.2
-
set
public JsonArray set(int index, boolean value)
Replaces the element at the specified position in this array with the JSON representation of the specifiedbooleanvalue.- Parameters:
index- the index of the array element to replacevalue- the value to be stored at the specified array position- Returns:
- the array itself, to enable method chaining
- Throws:
java.lang.IndexOutOfBoundsException- if the index is out of range, i.e.index < 0orindex >= size- Since:
- 2.2
-
set
public 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.- Parameters:
index- the index of the array element to replacevalue- the string to be stored at the specified array position- Returns:
- the array itself, to enable method chaining
- Throws:
java.lang.IndexOutOfBoundsException- if the index is out of range, i.e.index < 0orindex >= size- Since:
- 2.2
-
set
public JsonArray set(int index, JsonValue value)
Replaces the element at the specified position in this array with the specified JSON value.- Parameters:
index- the index of the array element to replacevalue- the value to be stored at the specified array position, must not benull- Returns:
- the array itself, to enable method chaining
- Throws:
java.lang.IndexOutOfBoundsException- if the index is out of range, i.e.index < 0orindex >= size- Since:
- 2.2
-
size
public int size()
Returns the number of elements in this array.- Returns:
- the number of elements in this array
-
isEmpty
public boolean isEmpty()
Returnstrueif this array contains no elements.- Returns:
trueif this array contains no elements
-
get
public JsonValue get(int index)
Returns the value of the element at the specified position in this array.- Parameters:
index- the index of the array element to return- Returns:
- the value of the element at the specified position
- Throws:
java.lang.IndexOutOfBoundsException- if the index is out of range (index < 0 || index >= size()).
-
values
public java.util.List<JsonValue> values()
Returns a list of the values in this array in document order. The returned list is backed by this array and will reflect subsequent changes. It cannot be used to modify this array. Attempts to modify the returned list will result in an exception.- Returns:
- a list of the values in this array
-
iterator
public java.util.Iterator<JsonValue> iterator()
Returns an iterator over the values of this array in document order. The returned iterator cannot be used to modify this array.- Specified by:
iteratorin interfacejava.lang.Iterable<JsonValue>- Returns:
- an iterator over the values of this array
-
write
protected void write(org.eclipse.rap.json.JsonWriter writer) throws java.io.IOException
-
isArray
public boolean isArray()
Description copied from class:JsonValueDetects whether this value represents a JSON array. If this is the case, this value is an instance ofJsonArray.
-
asArray
public JsonArray asArray()
Description copied from class:JsonValueReturns this JSON value asJsonArray, assuming that this value represents a JSON array. If this is not the case, an exception is thrown.
-
equals
public boolean equals(java.lang.Object object)
Description copied from class:JsonValueIndicates whether some other object is "equal to" this one according to the contract specified inObject.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.
-
-