001/* Interface for objects that can attach debug listeners.
002
003 Copyright (c) 1997-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//// Debuggable
032
033/**
034 This is an interface for objects that debug listeners can be attached to.
035
036 @author Jie Liu
037 @version $Id$
038 @since Ptolemy II 0.4
039 @Pt.ProposedRating Green (neuendor)
040 @Pt.AcceptedRating Green (neuendor)
041 @see DebugListener
042 @see DebugEvent
043 */
044public interface Debuggable {
045    ///////////////////////////////////////////////////////////////////
046    ////                         public methods                    ////
047
048    /** Add a debug listener.
049     *  If the listener is already in the list, do not add it again.
050     *  @param listener The listener to which to send debug messages.
051     *  @see #removeDebugListener(DebugListener)
052     */
053    public void addDebugListener(DebugListener listener);
054
055    /** Unregister a debug listener.  If the specified listener has not
056     *  been previously registered, then do nothing.
057     *  @param listener The listener to remove from the list of listeners
058     *   to which debug messages are sent.
059     *  @see #addDebugListener(DebugListener)
060     */
061    public void removeDebugListener(DebugListener listener);
062}