KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > rice > cs > drjava > model > cache > DCacheAdapter


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.cache;
35
36 import java.io.IOException JavaDoc;
37
38 import edu.rice.cs.drjava.model.FileMovedException;
39 import edu.rice.cs.drjava.model.definitions.DefinitionsDocument;
40
41 /** A lightweight wrapper type for DefinitionsDocuments that may or may not be resident in memory.
42  * An object of within OpenDefinitionsDocument holds the DefinitionsDocument associated with the
43  * OpenDefinitionsDocument.
44  */
45 public interface DCacheAdapter {
46   
47   /** Retrieves the document for its corresponding ODD
48    * @return the definitions document for the corresponding ODD
49    */
50   public DefinitionsDocument getDocument() throws IOException JavaDoc, FileMovedException;
51   
52   /** Checks whether the document is ready to be returned. If false, then the document would have to be
53    * loaded from disk when getDocument() is called.
54    * @return if the document is already loaded
55    */
56   public boolean isReady();
57   
58   /** Closes the corresponding document for this adapter. */
59   public void close();
60   
61   public DDReconstructor getReconstructor();
62   
63   /* Method for notifying the DCacheAdapter that this document has been saved to a file. */
64   public void documentSaved(String JavaDoc fileName);
65   
66   /* Method for notifying the DCacheAdapter that this document has been modified. */
67   public void documentModified();
68   
69   /* Method for notifying the DCacheAdapter that this document has been reset via undo commands. */
70   public void documentReset();
71   
72 }
Popular Tags