001/* An exception that is not reported to the user.
002
003 Copyright (c) 2003-2014 The Regents of the University of California.
004 All rights reserved.
005 Permission is hereby granted, without written agreement and without
006 license or royalty fees, to use, copy, modify, and distribute this
007 software and its documentation for any purpose, provided that the above
008 copyright notice and the following two paragraphs appear in all copies
009 of this software.
010
011 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
012 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
013 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
014 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
015 SUCH DAMAGE.
016
017 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
018 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
019 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
020 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
021 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
022 ENHANCEMENTS, OR MODIFICATIONS.
023
024 PT_COPYRIGHT_VERSION_2
025 COPYRIGHTENDKEY
026 */
027package ptolemy.util;
028
029//////////////////////////////////////////////////////////////////////////
030//// CancelException
031
032/**
033 An exception that is not reported to the user.  This exception can be used
034 to cancel an ongoing operation.  It works together with MessageHandler,
035 where it might be thrown when the user clicks "cancel" in a dialog box.
036 Throwing an exception allows the execution environment to unwind the stack,
037 cancelling operations that may only lead to an endless stream of warnings
038 or errors.  This class is really just a marker, and is intended to not be
039 reported to the user.
040
041 @see MessageHandler
042 @author Edward A. Lee
043 @version $Id$
044 @since Ptolemy II 4.0
045 @Pt.ProposedRating Green (eal)
046 @Pt.AcceptedRating Green (janneck)
047 */
048@SuppressWarnings("serial")
049public class CancelException extends Exception {
050    /** Construct an exception with a default message.
051     */
052    public CancelException() {
053        super("Operation cancelled by the user");
054    }
055
056    /** Construct an exception with the specified message.
057     *  @param message The message.
058     */
059    public CancelException(String message) {
060        super(message);
061    }
062}