001/* Handle an exception.
002
003 Copyright (c) 2006-2013 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
027 */
028package ptolemy.kernel.util;
029
030///////////////////////////////////////////////////////////////////
031//// ExceptionHandler
032
033/**
034 Interface for exception handlers. If a model contains an entity that
035 implements this interface, then if running the model results in an
036 exception, the exception is delegated to this exception handler.
037
038 @author Haiyang Zheng
039 @version $Id$
040 @since Ptolemy II 5.2
041 @Pt.ProposedRating Green (hyzheng)
042 @Pt.AcceptedRating Green (hyzheng)
043 */
044public interface ExceptionHandler {
045    ///////////////////////////////////////////////////////////////////
046    ////                         public methods                    ////
047
048    /** Handle an exception. This method may throw another exception.
049     *  @param context The object in which the exception occurred.
050     *  @param exception An exception to be handled.
051     *  @return True if the exception has been handled, or false if the
052     *   exception is not handled.
053     *  @exception IllegalActionException If this handler handles the
054     *   exception by throwing an exception.
055     */
056    public boolean handleException(NamedObj context, Throwable exception)
057            throws IllegalActionException;
058}