Class Die

All Implemented Interfaces:
Serializable
Direct Known Subclasses:
TextBuiltin.TerminatedByHelpException

public class Die extends RuntimeException
Indicates a TextBuiltin implementation has failed during execution.

Typically the stack trace for a Die exception is not shown to the user as it may indicate a simple error condition that the end-user can fix on their own, without needing a screen of Java stack frames.

See Also:
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:
    • aborted

      private boolean aborted
  • Constructor Details

    • Die

      public Die(String why)
      Construct a new message explaining what has gone wrong.
      Parameters:
      why - the message to show to the end-user.
    • Die

      public Die(String why, Throwable cause)
      Construct a new message explaining what has gone wrong.
      Parameters:
      why - the message to show to the end-user.
      cause - why the command has failed.
    • Die

      public Die(boolean aborted)
      Construct a new exception reflecting the fact that the command execution has been aborted before running.
      Parameters:
      aborted - boolean indicating the fact the execution has been aborted
      Since:
      3.4
    • Die

      public Die(boolean aborted, Throwable cause)
      Construct a new exception reflecting the fact that the command execution has been aborted before running.
      Parameters:
      aborted - boolean indicating the fact the execution has been aborted
      cause - can be null
      Since:
      4.2
  • Method Details

    • isAborted

      public boolean isAborted()
      Check if this exception should cause the execution to be aborted.
      Returns:
      boolean indicating that the execution should be aborted
      Since:
      3.4