Class Array

java.lang.Object

com.surrealdb.Native

com.surrealdb.Array

All Implemented Interfaces:

Iterable<Value>

public class Array
extends Native
implements Iterable<Value>

The Array class represents a native array structure and provides methods to interact with and retrieve values from the array. It implements the Iterable interface for Value type.

Method Summary

Modifier and Type	Method	Description
static Array	fromList(List<?> elements)	List-based counterpart to of(java.lang.Object...) for callers that already hold a List.
final Value	get(int idx)
final Iterator<Value>	iterator()
final <T> Iterator<T>	iterator(Class<T> clazz)
final int	len()
static Array	of(Object... elements)	Creates an Array from a heterogeneous sequence of Java values.
final Iterator<Value>	synchronizedIterator()
final <T> Iterator<T>	synchronizedIterator(Class<T> clazz)

Methods inherited from class Native

equals, finalize, hashCode, toString

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Method Details

of

public static Array of(Object... elements)

Creates an Array from a heterogeneous sequence of Java values. Supported element types include null, String, the boxed numeric types, Boolean, BigDecimal, UUID, Duration, ZonedDateTime, and the SurrealDB wrappers Array, Id, RecordId, and Object. Unsupported types raise IllegalArgumentException.

To build a single-element [null] array, cast the argument: Array.of((java.lang.Object) null). A bare Array.of(null) is a null varargs array and will throw NullPointerException.

fromList

public static Array fromList(List<?> elements)

List-based counterpart to of(java.lang.Object...) for callers that already hold a List. Named distinctly from of(...) to avoid a null-call overload ambiguity.

get

public final Value get(int idx)

len

public final int len()

iterator

public final Iterator<Value> iterator()

Specified by:

iterator in interface Iterable<Value>

iterator

public final <T> Iterator<T> iterator(Class<T> clazz)

synchronizedIterator

public final Iterator<Value> synchronizedIterator()

synchronizedIterator

public final <T> Iterator<T> synchronizedIterator(Class<T> clazz)