com.oracle.truffle.api.interop

Class InvalidArrayIndexException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.oracle.truffle.api.interop.InteropException

com.oracle.truffle.api.interop.InvalidArrayIndexException

All Implemented Interfaces:

Serializable

public final class InvalidArrayIndexException
extends InteropException

An exception thrown if an array does not contain a element with an index. Interop exceptions are supposed to be caught and converted into a guest language error by the caller.

Since:

19.0

See Also:

InvalidArrayIndexException.getInvalidIndex(), InteropLibrary, Serialized Form

Method Summary

Modifier and Type	Method and Description
static InvalidArrayIndexException	create(long invalidIndex) Creates an InvalidArrayIndexException to indicate that an array index is invalid.
static InvalidArrayIndexException	create(long invalidIndex, Throwable cause) Creates an InvalidArrayIndexException to indicate that an array index is invalid.
long	getInvalidIndex() Returns the invalid index that was used.
String	getMessage()

Methods inherited from class com.oracle.truffle.api.interop.InteropException

fillInStackTrace, getCause

Methods inherited from class java.lang.Throwable

addSuppressed, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

Since:

19.0

getInvalidIndex

public long getInvalidIndex()

Returns the invalid index that was used.

Since:

19.0

create

public static InvalidArrayIndexException create(long invalidIndex)

Creates an InvalidArrayIndexException to indicate that an array index is invalid.

This method is designed to be used in compiled code paths.

Parameters:

invalidIndex - the index that could not be accessed

Since:

19.0

create

public static InvalidArrayIndexException create(long invalidIndex,
                                                Throwable cause)

Creates an InvalidArrayIndexException to indicate that an array index is invalid.

In addition a cause may be provided. The cause should only be set if the guest language code caused this problem. An example for this is a language specific proxy mechanism that invokes guest language code to describe an object. If the guest language code fails to execute and this interop exception is a valid interpretation of the error, then the error should be provided as cause. The cause can then be used by the source language as new exception cause if the InteropException is translated to a source language error. If the InteropException is discarded, then the cause will most likely get discarded by the source language as well. Note that the cause must be of type TruffleException in addition to Throwable otherwise an IllegalArgumentException is thrown.

This method is designed to be used in compiled code paths.

Parameters:

invalidIndex - the index that could not be accessed

cause - the guest language exception that caused the error.

Since:

20.2