001: /*BEGIN_COPYRIGHT_BLOCK
002: *
003: * Copyright (c) 2001-2007, JavaPLT group at Rice University (javaplt@rice.edu)
004: * All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions are met:
008: * * Redistributions of source code must retain the above copyright
009: * notice, this list of conditions and the following disclaimer.
010: * * Redistributions in binary form must reproduce the above copyright
011: * notice, this list of conditions and the following disclaimer in the
012: * documentation and/or other materials provided with the distribution.
013: * * Neither the names of DrJava, the JavaPLT group, Rice University, nor the
014: * names of its contributors may be used to endorse or promote products
015: * derived from this software without specific prior written permission.
016: *
017: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
018: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
019: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
020: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
021: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
022: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
023: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
024: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
025: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
026: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
027: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
028: *
029: * This software is Open Source Initiative approved Open Source Software.
030: * Open Source Initative Approved is a trademark of the Open Source Initiative.
031: *
032: * This file is part of DrJava. Download the current version of this project
033: * from http://www.drjava.org/ or http://sourceforge.net/projects/drjava/
034: *
035: * END_COPYRIGHT_BLOCK*/
036:
037: package edu.rice.cs.drjava.model;
038:
039: import java.io.File;
040: import java.io.IOException;
041: import java.util.List;
042:
043: /** This state pattern is used by the global model to store any information pertaining to the currently open project.
044: * The state pattern is used because most project information is not needed in list view. (Elspeth Rocks)
045: *
046: * Hint: if you're looking for the instances of this interface, look in DefaultGlobalModel where they are defined
047: * as anonymous inner classes.
048: */
049: public interface FileGroupingState {
050:
051: /** @return true if the model is in project mode, false otherwi */
052: public boolean isProjectActive();
053:
054: /** @return true if the document is part of the active project (in the project path), or false
055: * if it is not (or the model is not in project mode)
056: */
057: public boolean inProjectPath(OpenDefinitionsDocument doc);
058:
059: /** @return true if the file is part of the active project (in the project path), or false
060: * if it is not (or the model is not in project mode)
061: */
062: public boolean inProjectPath(File f);
063:
064: // /** junits all files that the state considers "all" (ie, all files in project directory in project mode). */
065: // public void junitAll();
066:
067: /** Returns the current project file
068: * @return null if not currently in a project
069: */
070: public File getProjectFile();
071:
072: /** Returns the project source root
073: * @return null if no build directory is specified
074: */
075: public File getProjectRoot();
076:
077: /** Sets project file to specifed value; used in "Save Project As ..." command in MainFrame. */
078: public void setProjectFile(File f);
079:
080: /** Sets the current project root. */
081: public void setProjectRoot(File f);
082:
083: /** Adds file to list of auxiliary files in project */
084: public void addAuxFile(File f);
085:
086: /** Removes file to list of auxiliary files in project. Throws an UnexpectedException if auxFiles does not contain
087: * exactly one instance of f.*/
088: public void remAuxFile(File f);
089:
090: /** Returns the directory in which to put the class files after compilation
091: * @return null if no build directory is specified
092: */
093: public File getBuildDirectory();
094:
095: /** Sets the current build directory. */
096: public void setBuildDirectory(File f);
097:
098: /** Returns the working directory for the slave (interactions pane) JVM. */
099: public File getWorkingDirectory();
100:
101: /** Sets the current working directory for the interactions pane. */
102: public void setWorkingDirectory(File f);
103:
104: /** Returns the source file that has the main method of the project
105: * @return null if no build directory is specified
106: */
107: public File getMainClass();
108:
109: /** Sets the file that has the main method of the project
110: * (Note: should point to the sourcefile of the document, not the class file)
111: */
112: public void setMainClass(File f);
113:
114: /** Sets the create jar file of the project. */
115: public void setCreateJarFile(File f);
116:
117: /** Return the create jar file for the project. If not in project mode, returns 0. */
118: public File getCreateJarFile();
119:
120: /** Sets the create jar flags of the project. */
121: public void setCreateJarFlags(int f);
122:
123: /** Return the create jar flags for the project. If not in project mode, returns null. */
124: public int getCreateJarFlags();
125:
126: /** Return all files saved as source files in the project file. If not in project mode, returns null. */
127: public File[] getProjectFiles();
128:
129: /** Returns true the given file is in the current project file. */
130: public boolean inProject(File f);
131:
132: /** @return true if the file is a project auxiliary file */
133: public boolean isAuxiliaryFile(File f);
134:
135: /** Returns true if in project mode and the current project file has changed. */
136: public boolean isProjectChanged();
137:
138: /** Sets that the project state is no longer a snapshot of the open project. */
139: public void setProjectChanged(boolean changed);
140:
141: /** Cleans the build directory. */
142: public void cleanBuildDirectory();
143:
144: /** @return a list of class files. */
145: public List<File> getClassFiles();
146:
147: /** Returns a collection of classpath entries specific to the current project.
148: * @return the project's extra classpath
149: */
150: public Iterable<File> getExtraClassPath();
151:
152: /** Sets the list of project-specific classpath entries. */
153: public void setExtraClassPath(Iterable<File> cp);
154:
155: }
|