KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > rice > cs > drjava > model > debug > DebugListener


1 /*BEGIN_COPYRIGHT_BLOCK
2  *
3  * This file is part of DrJava. Download the current version of this project from http://www.drjava.org/
4  * or http://sourceforge.net/projects/drjava/
5  *
6  * DrJava Open Source License
7  *
8  * Copyright (C) 2001-2006 JavaPLT group at Rice University (javaplt@rice.edu). All rights reserved.
9  *
10  * Developed by: Java Programming Languages Team, Rice University, http://www.cs.rice.edu/~javaplt/
11  *
12  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
13  * documentation files (the "Software"), to deal with the Software without restriction, including without limitation
14  * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
15  * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
16  *
17  * - Redistributions of source code must retain the above copyright notice, this list of conditions and the
18  * following disclaimers.
19  * - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
20  * following disclaimers in the documentation and/or other materials provided with the distribution.
21  * - Neither the names of DrJava, the JavaPLT, Rice University, nor the names of its contributors may be used to
22  * endorse or promote products derived from this Software without specific prior written permission.
23  * - Products derived from this software may not be called "DrJava" nor use the term "DrJava" as part of their
24  * names without prior written permission from the JavaPLT group. For permission, write to javaplt@rice.edu.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
27  * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28  * CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
29  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
30  * WITH THE SOFTWARE.
31  *
32  *END_COPYRIGHT_BLOCK*/
33
34 package edu.rice.cs.drjava.model.debug;
35
36 import edu.rice.cs.drjava.model.DocumentRegion;
37 import edu.rice.cs.drjava.model.RegionManagerListener;
38 import edu.rice.cs.drjava.model.OpenDefinitionsDocument;
39
40 /** Any class which wants to listen to events fired by the Debugger should implement this interface and use Debugger's
41  * addDebugListener() method.
42  * @version $Id: DebugListener.java 3901 2006-06-30 05:28:11Z rcartwright $
43  */
44 public interface DebugListener extends RegionManagerListener<Breakpoint> {
45   
46   /** Called when debugger mode has been enabled. Must be executed in event thread. */
47   public void debuggerStarted();
48   
49   /** Called when debugger mode has been disabled. Must be executed in event thread. */
50   public void debuggerShutdown();
51
52   /** Called when the given line is reached by the current thread in the debugger, to request that the line be
53    * displayed. Must be executed only in the event thread.
54    * @param doc Document to display
55    * @param lineNumber Line to display or highlight
56    * @param shouldHighlight true iff the line should be highlighted.
57    */
58   public void threadLocationUpdated(OpenDefinitionsDocument doc, int lineNumber, boolean shouldHighlight);
59   
60   /** Called when a breakpoint is reached during execution.
61    * @param bp the breakpoint
62    */
63   public void breakpointReached(Breakpoint bp);
64
65   /** Called when a watch is set. Must be executed in event thread.
66    * @param w the watch
67    */
68   public void watchSet(DebugWatchData w);
69   
70   /** Called when a watch is removed. Must be executed in event thread.
71    * @param w the watch
72    */
73   public void watchRemoved(DebugWatchData w);
74   
75   /** Called when a step is requested on the current thread. Must be executed in event thread. */
76   public void stepRequested();
77   
78   /** Called when the current thread is suspended. */
79   public void currThreadSuspended();
80   
81   /** Called when the current thread is resumed. Must be executed in event thread. */
82   public void currThreadResumed();
83   
84   /** Called when a thread starts. Must be executed in event thread. */
85   public void threadStarted();
86   
87   /** Called when the current thread dies. Must be executed in event thread. */
88   public void currThreadDied();
89   
90   /** Called when any thread other than the current thread dies. Must be executed in event thread. */
91   public void nonCurrThreadDied();
92
93   /** Called when the current (selected) thread is set in the debugger.
94    * @param thread the thread that was set as current
95    */
96   public void currThreadSet(DebugThreadData thread);
97   
98   // from RegionManagerListener<Breakpoint>:
99 // public void regionAdded(Breakpoint r, int index);
100 // public void regionChanged(Breakpoint r, int index);
101 // public void regionRemoved(Breakpoint r);
102 }
Popular Tags