org.graalvm.polyglot

Class PolyglotException.StackFrame

java.lang.Object

org.graalvm.polyglot.PolyglotException.StackFrame

Enclosing class:

PolyglotException

public final class PolyglotException.StackFrame
extends Object

Represents a polyglot stack frame originating from a guest language or the host language Java.

Since:

19.0

Method Summary

Modifier and Type	Method and Description
Language	getLanguage() Returns the language of this stack frame.
String	getRootName() Returns the root name of this stack frame.
SourceSection	getSourceLocation() Returns the source location of the stack frame or null if no source location is available.
boolean	isGuestFrame() Returns true if the stack frame originates from the guest language.
boolean	isHostFrame() Returns true if the stack frame originates from the host language.
StackTraceElement	toHostFrame() Returns a Java stack trace element representation of the polyglot stack trace element.
String	toString() Returns a string representation of this stack frame.

Methods inherited from class java.lang.Object

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

Method Detail

isHostFrame

public boolean isHostFrame()

Returns true if the stack frame originates from the host language. Host frames do not provide a source location. Instead the Java stack frame can be accessed using PolyglotException.StackFrame.toHostFrame().

Since:

19.0

isGuestFrame

public boolean isGuestFrame()

Returns true if the stack frame originates from the guest language.

Since:

19.0

toHostFrame

public StackTraceElement toHostFrame()

Returns a Java stack trace element representation of the polyglot stack trace element. This is supported for host stack frames as well as guest language stack frames. A conversion to the host frame format can be useful for interoperability.

Since:

19.0

getSourceLocation

public SourceSection getSourceLocation()

Returns the source location of the stack frame or null if no source location is available. Host frames do never provide a source location.

Since:

19.0

getRootName

public String getRootName()

Returns the root name of this stack frame. In case of the host language the Java method name is returned. In guest languages it returns a useful identifier for code. For example, in JavaScript this can be the function name.

Since:

19.0

getLanguage

public Language getLanguage()

Returns the language of this stack frame. In case of the host language a synthetic Java language object is returned.

Since:

19.0

toString

public String toString()

Returns a string representation of this stack frame. The format is inspired by the Java stack frame format.

Overrides:

toString in class Object

Since:

19.0