01: /*BEGIN_COPYRIGHT_BLOCK
02: *
03: * Copyright (c) 2001-2007, JavaPLT group at Rice University (javaplt@rice.edu)
04: * All rights reserved.
05: *
06: * Redistribution and use in source and binary forms, with or without
07: * modification, are permitted provided that the following conditions are met:
08: * * Redistributions of source code must retain the above copyright
09: * notice, this list of conditions and the following disclaimer.
10: * * Redistributions in binary form must reproduce the above copyright
11: * notice, this list of conditions and the following disclaimer in the
12: * documentation and/or other materials provided with the distribution.
13: * * Neither the names of DrJava, the JavaPLT group, Rice University, nor the
14: * names of its contributors may be used to endorse or promote products
15: * derived from this software without specific prior written permission.
16: *
17: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28: *
29: * This software is Open Source Initiative approved Open Source Software.
30: * Open Source Initative Approved is a trademark of the Open Source Initiative.
31: *
32: * This file is part of DrJava. Download the current version of this project
33: * from http://www.drjava.org/ or http://sourceforge.net/projects/drjava/
34: *
35: * END_COPYRIGHT_BLOCK*/
36:
37: package edu.rice.cs.drjava.model;
38:
39: import java.util.List;
40:
41: import edu.rice.cs.drjava.model.definitions.*;
42:
43: /** Light-weight parsing control.
44: * @version $Id$
45: */
46: public interface LightWeightParsingControl {
47: /** Perform light-weight parsing on the document if the delay has been exceeded.
48: * @param doc the document to parse. */
49: public void update(OpenDefinitionsDocument doc);
50:
51: /** Delay the next update. */
52: public void delay();
53:
54: /** Start or stop automatic updates.
55: * @param b {@code true} to start or {@code false} to stop automatic updates */
56: public void setAutomaticUpdates(boolean b);
57:
58: /** Reset light-weight parsing. Forget everything. */
59: public void reset();
60:
61: /** Return the last enclosing class name for the specified document, "" if not inside a class, or
62: * null if unknown.
63: * @param doc the document for which we want the information
64: * @return the enclosing class name
65: */
66: public String getEnclosingClassName(OpenDefinitionsDocument doc);
67:
68: /** Add the listener to this controller.
69: * @param l listener to add */
70: public void addListener(LightWeightParsingListener l);
71:
72: /** Remove the listener from this controller. */
73: public void removeListener(LightWeightParsingListener l);
74:
75: /** Remove all listeners from this controller. */
76: public void removeAllListeners();
77:
78: /** @return a copy of the list of listeners. */
79: public List<LightWeightParsingListener> getListeners();
80: }
|