Returns the original Java host exception that caused this exception. The original host exception contains a stack trace that is hardly interpretable by users as it contains details of the language implementation. The polyglot exception provides information for user-friendly error reporting with the polyglot stack trace.

Exceptions

UnsupportedOperationException:

if this exception is not a host exception. Call isHostException() to ensure its originating from the host language.

Since

19.0

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

Since

19.0

Overrides java.lang.Throwable.fillInStackTrace.

Unsupported, PolyglotException instances are not writable therefore filling the stack trace has no effect for them.

Returns:Throwable

Doc from java.lang.Throwable.fillInStackTrace.

a reference to this Throwable instance.

Annotations

@SuppressWarnings:sync-override

@Override

Since

19.0

Returns the exit status if this exception indicates that the application was exited. The exit status is intended to be passed to System#exit(int). In case of hard exit the application can be configured to call System#exit(int) directly using Context.Builder#useSystemExit(boolean).

Since

19.0

See Also

Context

Returns an additional guest language object. Returns null if no exception object is available.

Since

19.0

Overrides java.lang.Throwable.getMessage.

Gets a user readable message for the polyglot exception. In case the exception is internal then the original java class name is included in the message. The message never returns null.

Returns:String

Doc from java.lang.Throwable.getMessage.

the detail message string of this Throwable instance (which may be null).

Annotations

@Override

Since

19.0

Provides programmatic access to the polyglot stack trace information printed by printStackTrace(). Returns an array of stack trace elements, each representing one stack frame. The zeroth element of the array (assuming the array's length is non-zero) represents the top of the stack, which is the last invocation in the sequence. Typically, this is the point at which this throwable was created and thrown. The last element of the array (assuming the array's length is non-zero) represents the bottom of the stack, which is the first method invocation in the sequence.

Annotations

@SuppressWarnings:unchecked

Since

19.0

See Also

StackFrame

Gets a guest language source location of this error or null if no source location is available for this exception.

Since

19.0

Overrides java.lang.Throwable.getStackTrace.

Gets stack trace elements for Java and guest languages. For polyglot exceptions it recommended to use getPolyglotStackTrace() as the guest language stack elements do not always fit the Java format for stack trace elements.

Returns:StackTraceElement[]

Doc from java.lang.Throwable.getStackTrace.

an array of stack trace elements representing the stack trace pertaining to this throwable.

Annotations

@Override

Since

19.0

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

Since

19.0

Returns true if the execution was cancelled. The execution can be cancelled by closing a context, if an instrument such as a debugger decides to cancel the current execution or if a resource limit was exceeded. The context that caused a cancel event becomes unusable, i.e. closed.

Since

19.0

Returns true if this exception is caused by an attempt of a guest language program to exit the application. The provided exit code can be accessed using getExitStatus(). This can be the result of either the soft or the hard exit.

Since

19.0

See Also

Context

Returns true if this exception originates from a Graal guest language. In such a case the first stack frame returns a guest frame as zeroth element.

Since

19.0

Returns true if this exception originates from the Java host language. In such a case the first stack frame returns a host frame as zeroth element.

Since

19.0

Returns true if this exception indicates a syntax error that is indicating that the syntax is incomplete. This allows guest language programmers to find out if more code is expected from a given source. For example, an incomplete JavaScript program could look like this:

function incompleteFunction(arg) {

Since

19.0

Returns true if this exception was caused by an internal implementation error. These errors should be reported as bugs if observed. Internal error messages are typically hard to understand for guest language programmers and might contain implementation specific details that allows guest language implementers to debug the problem.

Since

19.0

Returns true if the current application thread was interrupted by an InterruptedException, or by calling Context#interrupt(Duration) from the host.

Since

20.3

Returns true if this exception indicates that a resource limit was exceeded, else false. Resource limit exceeded errors may be raised for the following reasons:

• The host runtime run out of memory or stack space. For example if host runtime throws OutOfMemoryError or StackOverflowError, then they will be translated to a PolyglotException that return true for isResourceExhausted().
• A configured resource limit was exceeded.
• A runtime specific per context resource limit was exceeded. Depending on the host runtime implementation additional options to restrict the resource usage of a context may be specified using options.

Resource limit exceptions may be originating from the host or guest. Resource limit exceeded errors are never internal, but may have caused the context to be cancelled such that it is no longer usable.

Since

20.2

Returns true if this exception indicates a parser or syntax error. In such a case #get

Since

19.0

Overrides java.lang.Throwable.printStackTrace.

Prints host and guest language stack frames to the standard error output.

Annotations

@Override

Since

19.0

Overrides java.lang.Throwable.printStackTrace.

Prints host and guest language stack frames to specified print stream.

Parameters

s:PrintStream

Doc from java.lang.Throwable.printStackTrace.

PrintStream to use for output

Annotations

@Override

Since

19.0

Overrides java.lang.Throwable.printStackTrace.

Prints host and guest language stack frames to specified print writer.

Parameters

s:PrintWriter

Doc from java.lang.Throwable.printStackTrace.

PrintWriter to use for output

Annotations

@Override

Since

19.0

Overrides java.lang.Throwable.setStackTrace.

Unsupported, PolyglotException instances are not writable therefore setting the stack trace has no effect for them.

Parameters

stackTrace:StackTraceElement[]

Doc from java.lang.Throwable.setStackTrace.

the stack trace elements to be associated with this Throwable. The specified array is copied by this call; changes in the specified array after the method invocation returns will have no effect on this Throwable's stack trace.

Annotations

@Override

Since

19.0