Module technology.sola.json

Package technology.sola.json

Class JsonArray

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<JsonElement>

technology.sola.json.JsonArray

All Implemented Interfaces:

Serializable, Cloneable, Iterable<JsonElement>, Collection<JsonElement>, List<JsonElement>, RandomAccess

@NullMarked
public class JsonArray
extends ArrayList<JsonElement>

JsonArray is an array of JsonElements. It includes methods for accessing members as various Java types.

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
JsonArray()	Constructs an empty JsonArray with an initial capacity of ten.
JsonArray(int initialCapacity)	Constructs an empty JsonArray with specified initial capacity.
JsonArray(Collection<? extends JsonElement> jsonElements)	Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator.

Method Summary

Modifier and Type	Method	Description
JsonArray	add(boolean value)	Appends the specified boolean to the end of this JsonArray.
JsonArray	add(double value)	Appends the specified double to the end of this JsonArray.
JsonArray	add(float value)	Appends the specified float to the end of this JsonArray.
JsonArray	add(int value)	Appends the specified integer to the end of this JsonArray.
void	add(int index, @Nullable JsonElement element)
JsonArray	add(long value)	Appends the specified long to the end of this JsonArray.
JsonArray	add(@Nullable Boolean value)	Appends the specified boolean to the end of this JsonArray.
JsonArray	add(@Nullable Double value)	Appends the specified double to the end of this JsonArray.
JsonArray	add(@Nullable Float value)	Appends the specified float to the end of this JsonArray.
JsonArray	add(@Nullable Integer value)	Appends the specified integer to the end of this JsonArray.
JsonArray	add(@Nullable Long value)	Appends the specified long to the end of this JsonArray.
JsonArray	add(@Nullable String value)	Appends the specified string to the end of this JsonArray.
JsonArray	add(@Nullable JsonArray value)	Appends the specified JsonArray to the end of this JsonArray.
boolean	add(@Nullable JsonElement jsonElement)
JsonArray	add(@Nullable JsonObject value)	Appends the specified JsonObject to the end of this JsonArray.
JsonArray	addNull()	Appends JsonElementType.NULL to the end of this JsonArray.
JsonArray	getArray(int index)	Returns the JsonArray at the specified position in this JsonArray.
@Nullable JsonArray	getArrayOrNull(int index)	Returns the JsonArray at the specified position in this JsonArray.
boolean	getBoolean(int index)	Returns the boolean at the specified position in this JsonArray.
@Nullable Boolean	getBooleanOrNull(int index)	Returns the boolean at the specified position in this JsonArray.
double	getDouble(int index)	Returns the double at the specified position in this JsonArray.
@Nullable Double	getDoubleOrNull(int index)	Returns the double at the specified position in this JsonArray.
float	getFloat(int index)	Returns the float at the specified position in this JsonArray.
@Nullable Float	getFloatOrNull(int index)	Returns the float at the specified position in this JsonArray.
int	getInt(int index)	Returns the integer at the specified position in this JsonArray.
@Nullable Integer	getIntOrNull(int index)	Returns the integer at the specified position in this JsonArray.
long	getLong(int index)	Returns the long at the specified position in this JsonArray.
@Nullable Long	getLongOrNull(int index)	Returns the long at the specified position in this JsonArray.
JsonObject	getObject(int index)	Returns the JsonObject at the specified position in this JsonArray.
@Nullable JsonObject	getObjectOrNull(int index)	Returns the JsonObject at the specified position in this JsonArray.
String	getString(int index)	Returns the String at the specified position in this JsonArray.
@Nullable String	getStringOrNull(int index)	Returns the String at the specified position in this JsonArray.
boolean	isNull(int index)	Returns true if the JsonElement at the specified position in this JsonArray as of type JsonElementType.NULL.
String	toString()	Formats this JsonArray as a string with no indentation.
String	toString(int spaces)	Formats this JsonArray as a string with specified number of spaces for indentation.

Methods inherited from class java.util.ArrayList

addAll, addAll, clear, clone, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.List

containsAll

Constructor Details

JsonArray

public JsonArray()

Constructs an empty JsonArray with an initial capacity of ten.

JsonArray

public JsonArray(int initialCapacity)

Constructs an empty JsonArray with specified initial capacity.

Parameters:

initialCapacity - the initial capacity of the list

Throws:

IllegalArgumentException - if specified, initial capacity is negative

JsonArray

public JsonArray(Collection<? extends JsonElement> jsonElements)

Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator.

Parameters:

jsonElements - the collection whose elements are to be placed into this list

Throws:

NullPointerException - – if the specified collection is null

Method Details

getObject

public JsonObject getObject(int index)

Returns the JsonObject at the specified position in this JsonArray.

Parameters:

index - the index of the JsonObject to return

Returns:

the JsonObject at specified index

Throws:

JsonElementTypeException - if JsonElement at index is not of type JsonElementType.JSON_OBJECT

getObjectOrNull

public @Nullable JsonObject getObjectOrNull(int index)

Returns the JsonObject at the specified position in this JsonArray. If the JsonElement at index is JsonElementType.NULL then null is returned.

Parameters:

index - the index of the JsonObject to return

Returns:

the JsonObject at specified index

Throws:

JsonElementTypeException - if JsonElement at index is not of type JsonElementType.JSON_OBJECT

getArray

public JsonArray getArray(int index)

Returns the JsonArray at the specified position in this JsonArray.

Parameters:

index - the index of the JsonArray to return

Returns:

the JsonArray at specified index

Throws:

JsonElementTypeException - if JsonElement at index is not of type JsonElementType.JSON_ARRAY

getArrayOrNull

public @Nullable JsonArray getArrayOrNull(int index)

Returns the JsonArray at the specified position in this JsonArray. If the JsonElement at index is JsonElementType.NULL then null is returned.

Parameters:

index - the index of the JsonArray to return

Returns:

the JsonArray at specified index

Throws:

JsonElementTypeException - if JsonElement at index is not of type JsonElementType.JSON_ARRAY

getString

public String getString(int index)

Returns the String at the specified position in this JsonArray.

Parameters:

index - the index of the String to return

Returns:

the String at specified index

Throws:

JsonElementTypeException - if JsonElement at index is not of type JsonElementType.STRING

getStringOrNull

public @Nullable String getStringOrNull(int index)

Returns the String at the specified position in this JsonArray. If the JsonElement at index is JsonElementType.NULL then null is returned.

Parameters:

index - the index of the String to return

Returns:

the String at specified index or null if JsonElementType.NULL

Throws:

JsonElementTypeException - if JsonElement at index is not of type JsonElementType.STRING

getInt

public int getInt(int index)

Returns the integer at the specified position in this JsonArray.

Parameters:

index - the index of the integer to return

Returns:

the integer at the specified index

Throws:

JsonElementTypeException - if JsonElement at index is not of type JsonElementType.LONG

getIntOrNull

public @Nullable Integer getIntOrNull(int index)

Returns the integer at the specified position in this JsonArray. If the JsonElement at index is JsonElementType.NULL then null is returned.

Parameters:

index - the index of the integer to return

Returns:

the integer at specified index or null if JsonElementType.NULL

Throws:

JsonElementTypeException - if JsonElement at index is not of type JsonElementType.LONG

getLong

public long getLong(int index)

Returns the long at the specified position in this JsonArray.

Parameters:

index - the index of the long to return

Returns:

the long at specified index

Throws:

JsonElementTypeException - if JsonElement at index is not of type JsonElementType.LONG

getLongOrNull

public @Nullable Long getLongOrNull(int index)

Returns the long at the specified position in this JsonArray. If the JsonElement at index is JsonElementType.NULL then null is returned.

Parameters:

index - the index of the long to return

Returns:

the long at specified index or null if JsonElementType.NULL

Throws:

JsonElementTypeException - if JsonElement at index is not of type JsonElementType.LONG

getDouble

public double getDouble(int index)

Returns the double at the specified position in this JsonArray.

Parameters:

index - the index of the double to return

Returns:

the double at specified index

Throws:

JsonElementTypeException - if JsonElement at index is not of type JsonElementType.DOUBLE

getDoubleOrNull

public @Nullable Double getDoubleOrNull(int index)

Returns the double at the specified position in this JsonArray. If the JsonElement at index is JsonElementType.NULL then null is returned.

Parameters:

index - the index of the double to return

Returns:

the double at specified index or null if JsonElementType.NULL

Throws:

JsonElementTypeException - if JsonElement at index is not of type JsonElementType.DOUBLE

getFloat

public float getFloat(int index)

Returns the float at the specified position in this JsonArray.

Parameters:

index - the index of the float to return

Returns:

the float at a specified index

Throws:

JsonElementTypeException - if JsonElement at index is not of type JsonElementType.DOUBLE

getFloatOrNull

public @Nullable Float getFloatOrNull(int index)

Returns the float at the specified position in this JsonArray. If the JsonElement at index is JsonElementType.NULL then null is returned.

Parameters:

index - the index of the float to return

Returns:

the float at a specified index or null if JsonElementType.NULL

Throws:

JsonElementTypeException - if JsonElement at index is not of type JsonElementType.DOUBLE

getBoolean

public boolean getBoolean(int index)

Returns the boolean at the specified position in this JsonArray.

Parameters:

index - the index of the boolean to return

Returns:

the boolean at a specified index

Throws:

JsonElementTypeException - if JsonElement at index is not of type JsonElementType.BOOLEAN

getBooleanOrNull

public @Nullable Boolean getBooleanOrNull(int index)

Returns the boolean at the specified position in this JsonArray. If the JsonElement at index is JsonElementType.NULL then null is returned.

Parameters:

index - the index of the boolean to return

Returns:

the boolean at a specified index or null if JsonElementType.NULL

Throws:

JsonElementTypeException - if JsonElement at index is not of type JsonElementType.BOOLEAN

isNull

public boolean isNull(int index)

Returns true if the JsonElement at the specified position in this JsonArray as of type JsonElementType.NULL.

Parameters:

index - the index to check if JsonElementType.NULL

Returns:

the true if JsonElementType.NULL is at specified index

add

public boolean add(@Nullable JsonElement jsonElement)

Specified by:

add in interface Collection<JsonElement>

Specified by:

add in interface List<JsonElement>

Overrides:

add in class ArrayList<JsonElement>

add

public void add(int index,
 @Nullable JsonElement element)

Specified by:

add in interface List<JsonElement>

Overrides:

add in class ArrayList<JsonElement>

add

public JsonArray add(@Nullable JsonObject value)

Appends the specified JsonObject to the end of this JsonArray. If the specified value is null the JsonElementType.NULL will be appended.

Parameters:

value - the JsonObject to append

Returns:

this

add

public JsonArray add(@Nullable JsonArray value)

Appends the specified JsonArray to the end of this JsonArray. If the specified value is null the JsonElementType.NULL will be appended.

Parameters:

value - the JsonArray to append

Returns:

this

add

public JsonArray add(@Nullable String value)

Appends the specified string to the end of this JsonArray. If the specified value is null the JsonElementType.NULL will be appended.

Parameters:

value - the string to append

Returns:

this

add

public JsonArray add(int value)

Appends the specified integer to the end of this JsonArray.

Parameters:

value - the integer to append

Returns:

this

add

public JsonArray add(@Nullable Integer value)

Appends the specified integer to the end of this JsonArray. If the specified value is null the JsonElementType.NULL will be appended.

Parameters:

value - the integer to append

Returns:

this

add

public JsonArray add(long value)

Appends the specified long to the end of this JsonArray.

Parameters:

value - the long to append

Returns:

this

add

public JsonArray add(@Nullable Long value)

Appends the specified long to the end of this JsonArray. If the specified value is null the JsonElementType.NULL will be appended.

Parameters:

value - the long to append

Returns:

this

add

public JsonArray add(float value)

Appends the specified float to the end of this JsonArray.

Parameters:

value - the float to append

Returns:

this

add

public JsonArray add(@Nullable Float value)

Appends the specified float to the end of this JsonArray. If the specified value is null the JsonElementType.NULL will be appended.

Parameters:

value - the float to append

Returns:

this

add

public JsonArray add(double value)

Appends the specified double to the end of this JsonArray.

Parameters:

value - the double to append

Returns:

this

add

public JsonArray add(@Nullable Double value)

Appends the specified double to the end of this JsonArray. If the specified value is null the JsonElementType.NULL will be appended.

Parameters:

value - the double to append

Returns:

this

add

public JsonArray add(boolean value)

Appends the specified boolean to the end of this JsonArray.

Parameters:

value - the boolean to append

Returns:

this

add

public JsonArray add(@Nullable Boolean value)

Appends the specified boolean to the end of this JsonArray. If the specified value is null the JsonElementType.NULL will be appended.

Parameters:

value - the boolean to append

Returns:

this

addNull

public JsonArray addNull()

Appends JsonElementType.NULL to the end of this JsonArray.

Returns:

this

toString

public String toString()

Formats this JsonArray as a string with no indentation.

Overrides:

toString in class AbstractCollection<JsonElement>

Returns:

formatted JSON string

toString

public String toString(int spaces)

Formats this JsonArray as a string with specified number of spaces for indentation.

Parameters:

spaces - the spaces for each indentation

Returns:

formatted JSON string with spaces for indentation