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.io.IOException;
40: import edu.rice.cs.util.FileOpenSelector;
41: import edu.rice.cs.util.OperationCanceledException;
42:
43: /** This interface encapsulates the behavior of a document loader. Components which provide a means to load
44: * documents (e.g. from disk, from a stream, from the ether) should implement this interface, rather than the
45: * entire GlobalModel. Components which simply need access to documents should use the more general IGetDocuments
46: * instead of this interface.
47: * TODO: Subdivide GlobalModelListener to target only events generated here.
48: * TODO: Simplify signatures to avoid command pattern overhead.
49: * @see GlobalModel
50: * @see DefaultGlobalModel
51: * @version $Id: ILoadDocuments.java 4255 2007-08-28 19:17:37Z mgricken $
52: */
53: public interface ILoadDocuments {
54: /** Open a file and read it into the definitions. The provided file selector chooses a file, and on a successful
55: * open, the fileOpened() event is fired.
56: * @param com a command pattern command that selects what file to open
57: * @return The open document, or null if unsuccessful
58: * @exception IOException
59: * @exception OperationCanceledException if the open was canceled
60: * @exception AlreadyOpenException if the file is already open
61: */
62: public OpenDefinitionsDocument openFile(FileOpenSelector com)
63: throws IOException, OperationCanceledException,
64: AlreadyOpenException;
65:
66: /** Opens multiple files and reads them into the definitions. The provided file selector chooses multiple files,
67: * and for each successful open, the fileOpened() event is fired. Note that getFile called on the returned
68: * OpenDefinitionsDocument is guaranteed to return an absolute path, as this method makes it absolute.
69: *
70: * @param com a command pattern command that selects which files to open
71: * @return The last opened document, or null if unsuccessful.
72: * @exception IOException if an underlying I/O operation fails
73: * @exception OperationCanceledException if the open was canceled
74: * @exception AlreadyOpenException if the file is already open
75: */
76: public OpenDefinitionsDocument[] openFiles(FileOpenSelector com)
77: throws IOException, OperationCanceledException,
78: AlreadyOpenException;
79: }
|