KickJava   Java API By Example, From Geeks To Geeks.

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


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 edu.rice.cs.drjava.model.definitions.DefinitionsDocument;
37 import java.io.IOException JavaDoc;
38 import javax.swing.text.BadLocationException JavaDoc;
39 import javax.swing.event.DocumentListener JavaDoc;
40 import edu.rice.cs.drjava.model.FileMovedException;
41
42 /** The Reconstructor is a closure that builds a document. This class is used by the DocumentCache to load
43   * DefinitionsDocuments lazily from files on disk.
44   */
45 public interface DDReconstructor {
46   
47   /** @return a new DefinitionsDocument */
48   public DefinitionsDocument make() throws IOException JavaDoc, BadLocationException JavaDoc, FileMovedException;
49   
50   /** Saves information (like cursor location, highlight, etc.) from the DefinitionsDocument before the cache deletes it
51    * so that those pieces of info can be restored when reconstructing the DefinitionsDocument again.
52    * @param doc the DefinitionsDocument whose data needs saving
53    */
54   public void saveDocInfo(DefinitionsDocument doc);
55   
56   /** Sets a document listener to be added to the definitions document when it is created
57    * @param dl the listener to add to the document
58    */
59   public void addDocumentListener(DocumentListener JavaDoc dl);
60 }
61
Popular Tags