org.graalvm.polyglot.proxy

Interface ProxyArray

All Superinterfaces:

Proxy

public interface ProxyArray
extends Proxy

Interface to be implemented to mimic guest language arrays. Arrays are always interpreted as zero-based arrays, independent of whether the Graal language uses one-based arrays. For example an access to array index one in a language with one-based arrays will access the proxy array at index zero.

Since:

19.0

See Also:

Proxy

Method Summary

Modifier and Type	Method and Description
static ProxyArray	fromArray(Object... values) Creates a proxy array backed by a Java array.
static ProxyArray	fromList(List<Object> values) Creates a proxy array backed by a Java List.
Object	get(long index) Returns the element at the given index.
long	getSize() Returns the reported size of the array.
default boolean	remove(long index) Removes the element at the given index.
void	set(long index, Value value) Sets the element at the given index.

Method Detail

get

Object get(long index)

Returns the element at the given index.

Throws:

ArrayIndexOutOfBoundsException - if the index is out of bounds

UnsupportedOperationException - if the operation is not supported

Since:

19.0

set

void set(long index,
         Value value)

Sets the element at the given index.

Throws:

ArrayIndexOutOfBoundsException - if the index is out of bounds

UnsupportedOperationException - if the operation is not supported

Since:

19.0

remove

default boolean remove(long index)

Removes the element at the given index.

Returns:

true when the element was removed, false when the element didn't exist.

Throws:

ArrayIndexOutOfBoundsException - if the index is out of bounds

UnsupportedOperationException - if the operation is not supported

Since:

19.0

getSize

long getSize()

Returns the reported size of the array. The returned size of an array does not limit a guest language to get and set values using arbitrary indices. The array size is typically used by Graal languages to traverse the array.

Since:

19.0

fromArray

static ProxyArray fromArray(Object... values)

Creates a proxy array backed by a Java array. If the set values of the array are host values then the they will be unboxed.

Since:

19.0

fromList

static ProxyArray fromList(List<Object> values)

Creates a proxy array backed by a Java List. If the set values of the list are host values then the they will be unboxed.

Since:

19.0