public final class JsonArray extends JsonValue implements Iterable<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(Collection<?> collection)
Construct a JSONArray from a Collection.
|
JsonArray(JsonTokener x)
Construct a JSONArray from a JsonTokener.
|
JsonArray(Object array)
Construct a JSONArray from an array
|
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.
|
BigDecimal |
getBigDecimal(int index)
Get the BigDecimal value associated with an index.
|
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 Enum<E>> |
getEnum(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.
|
Number |
getNumber(int index)
Get the Number value associated with a key.
|
String |
getString(int index)
Get the string associated with an index.
|
JsonType |
getType() |
boolean |
isNull(int index)
Determine if the value is null.
|
Iterator<Object> |
iterator() |
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.
|
BigDecimal |
optBigDecimal(int index,
BigDecimal defaultValue)
Get the optional BigDecimal value associated with an index.
|
BigInteger |
optBigInteger(int index,
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 Enum<E>> |
optEnum(Class<E> clazz,
int index)
Get the enum value associated with a key.
|
<E extends Enum<E>> |
optEnum(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.
|
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. |
Number |
optNumber(int index,
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. |
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. |
Object |
optQuery(String jsonPointer)
Queries and returns a value from this object using
jsonPointer , or returns null if the
query fails due to a missing key. |
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 that 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 an 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 |
query(JsonPointer jsonPointer)
Uses a uaer initialized JsonPointer and tries to match it to an item whithin this JsonArray.
|
Object |
query(String jsonPointer)
Creates a JsonPointer using an initialization string and tries to match it to an item within
this JsonArray.
|
Object |
remove(int index)
Remove an index and close the hole.
|
boolean |
similar(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.
|
List<Object> |
toList()
Returns a java.util.List containing all of the elements in this array.
|
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.
|
Writer |
write(Writer writer,
int indentFactor,
int indent)
Write the contents of the JsonArray as JSON text to a writer.
|
isJsonArray, isJsonLiteral, isJsonObject, toBuffer
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
forEach, spliterator
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(Object array) 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 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 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 Enum<E>> E getEnum(Class<E> clazz, int index) throws JsonException
clazz
- The type of enum to retrieve.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 an enum.public BigDecimal getBigDecimal(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
BigDecimal.public BigInteger getBigInteger(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
BigInteger.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 is not 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 string 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. If not, null is returned.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 float optFloat(int index)
index
- The index must be between 0 and length() - 1.public float optFloat(int index, float 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 <E extends Enum<E>> E optEnum(Class<E> clazz, int index)
clazz
- The type of enum to retrieve.index
- The index must be between 0 and length() - 1.public <E extends Enum<E>> E optEnum(Class<E> clazz, int index, E defaultValue)
clazz
- The type of enum to retrieve.index
- The index must be between 0 and length() - 1.defaultValue
- The default in case the value is not foundpublic BigInteger optBigInteger(int index, BigInteger defaultValue)
index
- The index must be between 0 and length() - 1.defaultValue
- The default value.public BigDecimal optBigDecimal(int index, BigDecimal 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 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() - 1.public Number optNumber(int index, 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() - 1.defaultValue
- The default.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 query(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.
jsonPointer
- string that can be used to create a JsonPointerpublic 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.
jsonPointer
- string that can be used to create a JsonPointerpublic Object optQuery(String jsonPointer)
jsonPointer
, or returns null if the
query fails due to a missing key.jsonPointer
- the string representation of the JSON pointernull
IllegalArgumentException
- if jsonPointer
has invalid syntaxpublic Object optQuery(JsonPointer jsonPointer)
jsonPointer
, or returns null if the
query fails due to a missing key.jsonPointer
- The JSON pointernull
IllegalArgumentException
- if jsonPointer
has invalid syntaxpublic Object remove(int index)
index
- The index of the element to be removed.public boolean similar(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
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
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.
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
public Writer write(Writer writer, int indentFactor, int indent) 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.
writer
- Writes the serialized JSONindentFactor
- The number of spaces to add to each level of indentation.indent
- The indentation of the top level.JsonException
public List<Object> toList()
Warning: This method assumes that the data structure is acyclical.
Copyright © 2018 Terra Software Informatics LLC.. All rights reserved.