Package com.oracle.truffle.api.interop

Enum Class ExceptionType

java.lang.Object

java.lang.Enum<ExceptionType>

com.oracle.truffle.api.interop.ExceptionType

All Implemented Interfaces:

Serializable, Comparable<ExceptionType>, Constable

public enum ExceptionType
extends Enum<ExceptionType>

Represents a type of a Truffle exception.

Since:

20.3

See Also:

• InteropLibrary.isException(Object)
• InteropLibrary.getExceptionType(Object)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXIT	Indicates that the application was soft-exited within the guest language program.
INTERRUPT	Indicates that the application thread was interrupted by an InterruptedException.
PARSE_ERROR	Indicates a parser or syntax error.
RUNTIME_ERROR	Indicates a guest language error.

Method Summary

Modifier and Type	Method	Description
static ExceptionType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ExceptionType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EXIT

public static final ExceptionType EXIT

Indicates that the application was soft-exited within the guest language program. To obtain the exit status use getExceptionExitStatus. See Context Exit for further information.

If a language uses hard exits, it should not use soft exits, i.e. throw exceptions of this type on its own.

If a language that does not use soft exits sees an exception of this type, it should re-throw it like other foreign exceptions, triggering finally blocks.

Since:

20.3

See Also:

• InteropLibrary.getExceptionExitStatus(Object)

INTERRUPT

public static final ExceptionType INTERRUPT

Indicates that the application thread was interrupted by an InterruptedException.

Since:

20.3

RUNTIME_ERROR

public static final ExceptionType RUNTIME_ERROR

Indicates a guest language error.

Since:

20.3

PARSE_ERROR

public static final ExceptionType PARSE_ERROR

Indicates a parser or syntax error. Syntax errors typically occur while parsing of guest language source code. Use isExceptionIncompleteSource to find out if the parse error happened due to incomplete source.

Since:

20.3

See Also:

• InteropLibrary.isExceptionIncompleteSource(Object)

Method Details

values

public static ExceptionType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ExceptionType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null