001/* Handle a model error by throwing an exception.
002
003 Copyright (c) 2000-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
027 */
028package ptolemy.kernel.util;
029
030///////////////////////////////////////////////////////////////////
031//// BasicModelErrorHandler
032
033/**
034 Default model error handler.  A model error is an exception that is
035 passed up the Ptolemy II hierarchy for handling until a container with
036 a registered error handler is found.  If there is no registered error
037 handler, then the error is ignored.  It is like throwing an exception, except
038 that instead of unraveling the calling stack, it travels up the Ptolemy II
039 hierarchy.  This class handles the error by simply throwing the
040 exception that has been passed to it.
041
042 @author Edward A. Lee
043 @version $Id$
044 @since Ptolemy II 2.1
045 @Pt.ProposedRating Green (eal)
046 @Pt.AcceptedRating Green (hyzheng)
047 */
048public class BasicModelErrorHandler implements ModelErrorHandler {
049    ///////////////////////////////////////////////////////////////////
050    ////                         public methods                    ////
051
052    /** Handle a model error by throwing the specified exception.
053     *  @param context The object in which the error occurred.
054     *  @param exception An exception that represents the error.
055     *  @return Never returns.
056     *  @exception IllegalActionException The exception passed
057     *   as an argument is always thrown.
058     */
059    @Override
060    public boolean handleModelError(NamedObj context,
061            IllegalActionException exception) throws IllegalActionException {
062        throw exception;
063    }
064}