public final class StopIterationException extends InteropException
This exception is thrown by the getIteratorNextElement
when the iterator has no more elements to return.
Interop exceptions are supposed to be caught and converted into a guest language error by the caller.
InteropLibrary
,
Serialized FormModifier and Type | Method and Description |
---|---|
static StopIterationException |
create()
Creates an
StopIterationException to indicate that iteration was stopped. |
static StopIterationException |
create(Throwable cause)
Creates an
StopIterationException to indicate that iteration was stopped. |
String |
getMessage() |
fillInStackTrace, getCause
addSuppressed, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
public String getMessage()
getMessage
in class Throwable
public static StopIterationException create()
StopIterationException
to indicate that iteration was stopped.
This method is designed to be used in compiled
code paths.
public static StopIterationException create(Throwable cause)
StopIterationException
to indicate that iteration was stopped.
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
AbstractTruffleException
otherwise an
IllegalArgumentException
is thrown.
This method is designed to be used in compiled
code paths.
cause
- the guest language exception that caused the error.