ptolemy.gui
Class CancelException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--ptolemy.gui.CancelException
All Implemented Interfaces:
java.io.Serializable

public class CancelException
extends java.lang.Exception

An exception that is not reported to the user. This exception can be used to cancel an ongoing operation. It works together with MessageHandler, where it might be thrown when the user clicks "cancel" in a dialog box. Throwing an exception allows the execution environment to unwind the stack, cancelling operations that may only lead to an endless stream of warnings or errors. This class is really just a marker, and is intended to not be reported to the user. It is a runtime exception so it can be thrown without being declared.

Since:
Ptolemy II 1.0
Version:
$Id: CancelException.java,v 1.9 2002/02/21 19:07:55 cxh Exp $
Author:
Edward A. Lee
See Also:
MessageHandler, Serialized Form

Constructor Summary
CancelException()
          Construct an exception with a default message.
CancelException(java.lang.String message)
          Construct an exception with the specified message.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CancelException

public CancelException()
Construct an exception with a default message.

CancelException

public CancelException(java.lang.String message)
Construct an exception with the specified message.