io.lettuce.core.json

Interface JsonArray

All Superinterfaces:

JsonValue

public interface JsonArray
extends JsonValue

Representation of a JSON array as per RFC 8259 - The JavaScript Object Notation (JSON) Data Interchange Format, Section 5. Arrays

Since:

6.5

Author:

Tihomir Mateev

See Also:

JsonValue

Method Summary

Modifier and Type	Method and Description
JsonArray	add(JsonValue element) Add a new JsonValue to the array.
void	addAll(JsonArray element) Add all elements from the provided JsonArray to this array.
List<JsonValue>	asList() Get all the JsonValues in the array as a List.
JsonValue	get(int index) Get the JsonValue at the provided index.
JsonValue	getFirst() Get the first JsonValue in the array.
Iterator<JsonValue>	iterator() Get an Iterator allowing access to all the JsonValues in the array.
JsonValue	remove(int index) Remove the JsonValue at the provided index.
JsonValue	replace(int index, JsonValue newElement) Replace the JsonValue at the provided index with the provided new JsonValue.
int	size()

Methods inherited from interface io.lettuce.core.json.JsonValue

asBoolean, asByteBuffer, asJsonArray, asJsonObject, asNumber, asString, isBoolean, isJsonArray, isJsonObject, isNull, isNumber, isString, toObject, toString

Method Detail

add

JsonArray add(JsonValue element)

Add a new JsonValue to the array. Supports chaining of calls.

Parameters:

element - the value to add

Returns:

the updated JsonArray to allow call chaining

addAll

void addAll(JsonArray element)

Add all elements from the provided JsonArray to this array.

Parameters:

element - the array to add all elements from

asList

List<JsonValue> asList()

Get all the JsonValues in the array as a List.

Returns:

the List of JsonValues in the array

get

JsonValue get(int index)

Get the JsonValue at the provided index.

Parameters:

index - the index to get the value for

Returns:

the JsonValue at the provided index or null if no value is found

getFirst

JsonValue getFirst()

Get the first JsonValue in the array.

Returns:

the first JsonValue in the array or null if the array is empty

iterator

Iterator<JsonValue> iterator()

Get an Iterator allowing access to all the JsonValues in the array.

Returns:

the last JsonValue in the array or null if the array is empty

remove

JsonValue remove(int index)

Remove the JsonValue at the provided index.

Parameters:

index - the index to remove the value for

Returns:

the removed JsonValue or null if no value is found

replace

JsonValue replace(int index,
                  JsonValue newElement)

Replace the JsonValue at the provided index with the provided new JsonValue.

Parameters:

index - the index to replace the value for

newElement - the new value to replace the old one with

Returns:

the updated JsonArray to allow call chaining

size

int size()

Returns:

the number of elements in this JsonArray