KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > rice > cs > drjava > model > LightWeightParsingControl


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-2005 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;
35
36 import java.util.List JavaDoc;
37
38 import edu.rice.cs.drjava.model.definitions.*;
39
40 /** Light-weight parsing control.
41  * @version $Id$
42  */
43 public interface LightWeightParsingControl {
44   /** Perform light-weight parsing on the document if the delay has been exceeded.
45    * @param doc the document to parse. */
46   public void update(OpenDefinitionsDocument doc);
47   
48   /** Delay the next update. */
49   public void delay();
50   
51   /** Start or stop automatic updates.
52    * @param b {@code true} to start or {@code false} to stop automatic updates */
53   public void setAutomaticUpdates(boolean b);
54
55   /** Reset light-weight parsing. Forget everything. */
56   public void reset();
57   
58   /** Return the last enclosing class name for the specified document, "" if not inside a class, or
59    * null if unknown.
60    * @param doc the document for which we want the information
61    * @return the enclosing class name
62    */
63   public String JavaDoc getEnclosingClassName(OpenDefinitionsDocument doc);
64   
65   /** Add the listener to this controller.
66    * @param l listener to add */
67   public void addListener(LightWeightParsingListener l);
68   
69   /** Remove the listener from this controller. */
70   public void removeListener(LightWeightParsingListener l);
71   
72   /** Remove all listeners from this controller. */
73   public void removeAllListeners();
74   
75   /** @return a copy of the list of listeners. */
76   public List JavaDoc<LightWeightParsingListener> getListeners();
77 }
Popular Tags