KickJava   Java API By Example, From Geeks To Geeks.

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


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-2006 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.io.IOException JavaDoc;
37 import edu.rice.cs.util.FileOpenSelector;
38 import edu.rice.cs.util.OperationCanceledException;
39
40 /** This interface encapsulates the behavior of a document loader. Components which provide a means to load
41  * documents (e.g. from disk, from a stream, from the ether) should implement this interface, rather than the
42  * entire GlobalModel. Components which simply need access to documents should use the more general IGetDocuments
43  * instead of this interface.
44  * TODO: Subdivide GlobalModelListener to target only events generated here.
45  * TODO: Simplify signatures to avoid command pattern overhead.
46  * @see GlobalModel
47  * @see DefaultGlobalModel
48  * @version $Id: ILoadDocuments.java 3901 2006-06-30 05:28:11Z rcartwright $
49  */

50 public interface ILoadDocuments {
51   /** Open a file and read it into the definitions. The provided file selector chooses a file, and on a successful
52    * open, the fileOpened() event is fired.
53    * @param com a command pattern command that selects what file to open
54    * @return The open document, or null if unsuccessful
55    * @exception IOException
56    * @exception OperationCanceledException if the open was canceled
57    * @exception AlreadyOpenException if the file is already open
58    */

59   public OpenDefinitionsDocument openFile(FileOpenSelector com) throws IOException JavaDoc, OperationCanceledException,
60     AlreadyOpenException;
61
62   /** Opens multiple files and reads them into the definitions. The provided file selector chooses multiple files,
63    * and for each successful open, the fileOpened() event is fired. Note that getFile called on the returned
64    * OpenDefinitionsDocument is guaranteed to return an absolute path, as this method makes it absolute.
65    *
66    * @param com a command pattern command that selects which files to open
67    * @return The last opened document, or null if unsuccessful.
68    * @exception IOException if an underlying I/O operation fails
69    * @exception OperationCanceledException if the open was canceled
70    * @exception AlreadyOpenException if the file is already open
71    */

72   public OpenDefinitionsDocument[] openFiles(FileOpenSelector com) throws IOException JavaDoc, OperationCanceledException,
73     AlreadyOpenException;
74 }
Popular Tags