TruffleException

```
public interface TruffleException
```
Represents an exception thrown during the execution of a guest language program. All exceptions thrown in a guest language implementation that are not implementing TruffleException are considered internal errors.
TruffleException is most efficient if the cause is left uninitialized. Implementations of TruffleException also should not prevent initialization of the exception cause, e.g., by overriding Throwable.initCause(Throwable).
In order to be efficient, a TruffleException should override Throwable.fillInStackTrace() without the synchronized modifier, so that it returns this:
```
 @SuppressWarnings("sync-override")
 @Override
 public final Throwable fillInStackTrace() {
     return this;
 }
 
```
Since:

0.27

See Also:

TruffleStackTrace to access the stack trace of an exception.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default Object`	`getExceptionObject()` Returns an additional guest language object.
`default int`	`getExitStatus()` Returns the exit status if this exception indicates that the application was `exited`.
`Node`	`getLocation()` Returns a node indicating the location where this exception occurred in the AST.
`default SourceSection`	`getSourceLocation()` Returns a location where this exception occurred in the AST.
`default int`	`getStackTraceElementLimit()` Returns the number of guest language frames that should be collected for this exception.
`default boolean`	`isCancelled()` Returns `true` if this exception indicates that guest language application was cancelled during its execution.
`default boolean`	`isExit()` Returns `true` if the exception indicates that the application was exited within the guest language program.
`default boolean`	`isIncompleteSource()` Returns `true` if this exception indicates a syntax error that is indicating that the syntax is incomplete.
`default boolean`	`isInternalError()` Returns `true` if this exception indicates an internal error.
`default boolean`	`isSyntaxError()` Returns `true` if this exception indicates a parser or syntax error.

- Method Detail
  - getLocation
```
Node getLocation()
```
    Returns a node indicating the location where this exception occurred in the AST. This method may return null to indicate that the location is not available.
    
    Since:
    
    0.27
  - getExceptionObject
```
default Object getExceptionObject()
```
    Returns an additional guest language object. The return object must be an interop type so it must be either implementing TruffleObject or be a primitive value. The default implementation returns null to indicate that no object is available for this exception.
    
    Since:
    
    0.27
  - isSyntaxError
```
default boolean isSyntaxError()
```
    Returns true if this exception indicates a parser or syntax error. Syntax errors typically occur while parsing of guest language source code.
    
    Since:
    
    0.27
  - isIncompleteSource
```
default boolean isIncompleteSource()
```
    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) {
 
```
    A shell might react to this exception and prompt for additional source code, if this method returns true.
    Since:
    
    0.27
  - isInternalError
```
default boolean isInternalError()
```
    Returns true if this exception indicates an internal error. Note that all exceptions thrown in a guest language implementation that are not implementing TruffleException are considered internal.
    
    Since:
    
    0.27
  - isCancelled
```
default boolean isCancelled()
```
    Returns true if this exception indicates that guest language application was cancelled during its execution.
    
    Since:
    
    0.27
  - isExit
```
default boolean isExit()
```
    Returns true if the exception indicates that the application was exited within the guest language program. If TruffleException.isExit() returns true also TruffleException.getExitStatus() should be implemented.
    
    Since:
    
    0.27
    
    See Also:
    
    TruffleException.getExitStatus()
  - getExitStatus
```
default int getExitStatus()
```
    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).
    
    Since:
    
    0.27
    
    See Also:
    
    TruffleException.isExit()
  - getStackTraceElementLimit
```
default int getStackTraceElementLimit()
```
    Returns the number of guest language frames that should be collected for this exception. Returns a negative integer by default for unlimited guest language frames. This is intended to be used by guest languages to limit the number of guest language stack frames. Languages might want to limit the number of frames for performance reasons. Frames that point to internal internal root nodes are not counted when the stack trace limit is computed.
    
    Since:
    
    0.27
  - getSourceLocation
```
default SourceSection getSourceLocation()
```
    Returns a location where this exception occurred in the AST. This method may return null to indicate that the location is not available.
    
    Returns:
    
    the SourceSection or null
    
    Since:
    
    0.33

Interface TruffleException

Method Summary

Method Detail

getLocation

getExceptionObject

isSyntaxError

isIncompleteSource

isInternalError

isCancelled

isExit

getExitStatus

getStackTraceElementLimit

getSourceLocation