001/* A wrapper class that delegates exceptions caused by a Runnable to the MessageHandler
002
003 Copyright (c) 2008-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 */
028
029package ptolemy.util;
030
031///////////////////////////////////////////////////////////////////
032////RunnableExceptionCatcher
033
034/**
035A class (that implements the proxy design pattern) that encapsulates a
036runnable, catches the exception and will report the exception to the
037Ptolemy Message Handler.
038
039@author Bert Rodiers
040@version $Id$
041@since Ptolemy II 8.0
042@Pt.ProposedRating Green (rodiers)
043@Pt.AcceptedRating Green (rodiers)
044 */
045
046public class RunnableExceptionCatcher implements Runnable {
047    ///////////////////////////////////////////////////////////////////
048    ////                         public methods                    ////
049
050    /** Construct an instance that will wrap a runnable,
051     * catch its exceptions and report it to the Ptolemy
052     * Message Handler.
053     * @param runnable The runnable.
054     */
055    public RunnableExceptionCatcher(Runnable runnable) {
056        _runnable = runnable;
057    }
058
059    /** Execute the runnable.
060     */
061    @Override
062    public void run() {
063        try {
064            _runnable.run();
065        } catch (Throwable e) {
066            ptolemy.util.MessageHandler
067                    .error(ptolemy.util.MessageHandler.shortDescription(e), e);
068        }
069    }
070
071    ///////////////////////////////////////////////////////////////////
072    ////                         private variables                 ////
073
074    // The runnable.
075    private Runnable _runnable;
076}