ptolemy.util

Class CancelException

java.lang.Object

java.lang.Throwable

java.lang.Exception

ptolemy.util.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.

Since:

Ptolemy II 4.0

Version:

$Id: CancelException.java 69602 2014-07-30 14:20:15Z cxh $

Author:

Edward A. Lee

See Also:

MessageHandler, Serialized Form

Accepted Rating:

Green (janneck)

Proposed Rating:

Green (eal)

Constructor Summary

Constructors

Constructor and Description
CancelException() Construct an exception with a default message.
CancelException(java.lang.String message) Construct an exception with the specified message.

Method Summary

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, 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.

Parameters:

message - The message.