org.embulk.spi.json

Class JsonArray

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<JsonValue>

org.embulk.spi.json.JsonArray

All Implemented Interfaces:

Iterable<JsonValue>, Collection<JsonValue>, List<JsonValue>, JsonValue

public final class JsonArray
extends AbstractList<JsonValue>
implements JsonValue

Represents an array in JSON.

Since:

0.10.42

See Also:

RFC 8259 - The JavaScript Object Notation (JSON) Data Interchange Format

Nested Class Summary

Nested classes/interfaces inherited from interface org.embulk.spi.json.JsonValue

JsonValue.EntityType

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Method Summary

Modifier and Type	Method and Description
JsonArray	asJsonArray() Returns this value as JsonArray.
boolean	equals(Object otherObject) Compares the specified object with this JSON array for equality.
JsonValue	get(int index) Returns the JSON value at the specified position in this array.
JsonValue.EntityType	getEntityType() Returns JsonValue.EntityType.ARRAY, which is the entity type of JsonArray.
int	hashCode() Returns the hash code value for this JSON array.
static JsonArray	of() Returns a JSON array containing zero JSON values.
static JsonArray	of(JsonValue... values) Returns a JSON array containing an arbitrary number of JSON values.
static JsonArray	ofList(List<? extends JsonValue> values) Returns a JSON array containing an arbitrary number of JSON values.
static JsonArray	ofUnsafe(JsonValue... array) Returns a JSON array containing the specified array as its internal representation.
int	presumeReferenceSizeInBytes() Returns the approximate size of this JSON array in bytes presumed to occupy in Page as a reference.
int	size() Returns the number of JSON values in this array.
String	toJson() Returns the stringified JSON representation of this JSON array.
org.msgpack.value.Value	toMsgpack() Deprecated. Do not use this method. It is to be removed at some point after Embulk v1.0.0. It is here only to ensure a migration period from MessagePack-based JSON values to new JSON values of JsonValue.
String	toString() Returns the string representation of this JSON array.

Methods inherited from class java.util.AbstractList

add, add, addAll, clear, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.embulk.spi.json.JsonValue

asJsonBoolean, asJsonDouble, asJsonLong, asJsonNull, asJsonObject, asJsonString, fromMsgpack, isJsonArray, isJsonBoolean, isJsonDouble, isJsonLong, isJsonNull, isJsonObject, isJsonString

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

of

public static JsonArray of()

Returns a JSON array containing zero JSON values.

Returns:

an empty JSON array

Since:

0.10.42

of

public static JsonArray of(JsonValue... values)

Returns a JSON array containing an arbitrary number of JSON values.

Parameters:

values - the JSON values to be contained in the JSON array, not null

Returns:

a JSON array containing the specified JSON values

Throws:

NullPointerException - if the array, or any value is null

Since:

0.10.42

ofList

public static JsonArray ofList(List<? extends JsonValue> values)

Returns a JSON array containing an arbitrary number of JSON values.

Parameters:

values - the JSON values to be contained in the JSON array, not null

Returns:

a JSON array containing the specified JSON values

Throws:

NullPointerException - if the list, or any value is null

Since:

0.10.42

ofUnsafe

public static JsonArray ofUnsafe(JsonValue... array)

Returns a JSON array containing the specified array as its internal representation.

This method is not safe. If the specified array is modified after creating a JsonArray instance with this method, the created JsonArray instance can unintentionally behave differently.

It has no null checks. If the specified array is null, or contains null, the created JsonArray can behave unexpectedly.

Parameters:

array - the array of JSON values to be the internal representation as-is in the new JsonArray

Returns:

a JSON array containing the specified array as the internal representation

Since:

0.10.42

getEntityType

public JsonValue.EntityType getEntityType()

Returns JsonValue.EntityType.ARRAY, which is the entity type of JsonArray.

Specified by:

getEntityType in interface JsonValue

Returns:

JsonValue.EntityType.ARRAY, which is the entity type of JsonArray

Since:

0.10.42

asJsonArray

public JsonArray asJsonArray()

Returns this value as JsonArray.

Specified by:

asJsonArray in interface JsonValue

Returns:

itself as JsonArray

Since:

0.10.42

presumeReferenceSizeInBytes

public int presumeReferenceSizeInBytes()

Returns the approximate size of this JSON array in bytes presumed to occupy in Page as a reference.

This approximate size is used only as a threshold whether PageBuilder is flushed, or not. It is not accurate, it does not need to be accurate, and it is impossible in general to tell an accurate size that a Java object occupies in the Java heap. But, a reasonable approximate would help to keep Page performant in the Java heap.

It is better to flush more frequently for bigger JSON value objects, less often for smaller JSON value objects, but no infinite accumulation even for empty JSON value objects.

Specified by:

presumeReferenceSizeInBytes in interface JsonValue

Returns:

the approximate size of this JSON array in bytes presumed to occupy in Page as a reference

See Also:

"org.embulk.spi.PageBuilderImpl#addRecord"

size

public int size()

Returns the number of JSON values in this array.

Specified by:

size in interface Collection<JsonValue>

Specified by:

size in interface List<JsonValue>

Specified by:

size in class AbstractCollection<JsonValue>

Returns:

the number of JSON values in this array

Since:

0.10.42

get

public JsonValue get(int index)

Returns the JSON value at the specified position in this array.

Specified by:

get in interface List<JsonValue>

Specified by:

get in class AbstractList<JsonValue>

Parameters:

index - index of the JSON value to return

Returns:

the JSON value at the specified position in this array

Throws:

IndexOutOfBoundsException - If the index is out of range (index < 0 || index >= size())

Since:

0.10.42

toJson

public String toJson()

Returns the stringified JSON representation of this JSON array.

Specified by:

toJson in interface JsonValue

Returns:

the stringified JSON representation of this JSON array

Since:

0.10.42

toMsgpack

@Deprecated
public org.msgpack.value.Value toMsgpack()

Deprecated. Do not use this method. It is to be removed at some point after Embulk v1.0.0. It is here only to ensure a migration period from MessagePack-based JSON values to new JSON values of JsonValue.

Returns the corresponding MessagePack's Array value of this JSON array.

Specified by:

toMsgpack in interface JsonValue

Returns:

the corresponding MessagePack's Array value of this JSON array

Since:

0.10.42

See Also:

Draft EEP: JSON Column Type

toString

public String toString()

Returns the string representation of this JSON array.

Overrides:

toString in class AbstractCollection<JsonValue>

Returns:

the string representation of this JSON array

Since:

0.10.42

equals

public boolean equals(Object otherObject)

Compares the specified object with this JSON array for equality.

Note that it can return true only when JsonArray is given. It checks the equality as a JSON array. It does not return true for a general List even though the given list contains the same elements.

Specified by:

equals in interface Collection<JsonValue>

Specified by:

equals in interface List<JsonValue>

Overrides:

equals in class AbstractList<JsonValue>

Returns:

true if the specified object is equal to this JSON array

Since:

0.10.42

hashCode

public int hashCode()

Returns the hash code value for this JSON array.

Specified by:

hashCode in interface Collection<JsonValue>

Specified by:

hashCode in interface List<JsonValue>

Overrides:

hashCode in class AbstractList<JsonValue>

Returns:

the hash code value for this JSON array

Since:

0.10.42