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.cache;
38:
39: import java.io.IOException;
40: import javax.swing.event.DocumentListener;
41: import javax.swing.text.BadLocationException;
42:
43: import edu.rice.cs.drjava.model.FileMovedException;
44: import edu.rice.cs.drjava.model.definitions.DefinitionsDocument;
45:
46: /** A lightweight wrapper type for DefinitionsDocuments that may or may not be resident in memory. An instance of this
47: * The wrapper includes a copy of the String text of the document if it has been kicked out of the cache.
48: */
49: public interface DCacheAdapter {
50:
51: /** Retrieves the document for its corresponding ODD
52: * @return the definitions document for the corresponding ODD
53: */
54: public DefinitionsDocument getDocument() throws IOException,
55: FileMovedException;
56:
57: public int getLength();
58:
59: /* Gets the entire text of this document. */
60: public String getText();
61:
62: /* Gets the specified substring of this document.
63: * @throws an IndexOutOfBounds exception if the specification is ill-formed.
64: */
65: public String getText(int offset, int length);
66:
67: /** Checks whether the document is ready to be returned. If false, then the document would have to be
68: * loaded from disk when getDocument() is called.
69: * @return if the document is already loaded
70: */
71: public boolean isReady();
72:
73: /** Closes the corresponding document for this adapter. */
74: public void close();
75:
76: /** Adds a DocumentListener to the reconstructor. */
77: public void addDocumentListener(DocumentListener l);
78:
79: /* Method for notifying the DCacheAdapter that this document has been saved to a file. */
80: public void documentSaved();
81:
82: /* Method for notifying the DCacheAdapter that this document has been modified. */
83: public void documentModified();
84:
85: /* Method for notifying the DCacheAdapter that this document has been reset via undo commands. */
86: public void documentReset();
87:
88: }
|