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.project;
038:
039: import java.io.*;
040: import java.util.List;
041:
042: import edu.rice.cs.drjava.model.DocumentRegion;
043: import edu.rice.cs.drjava.model.debug.DebugBreakpointData;
044: import edu.rice.cs.drjava.model.debug.DebugWatchData;
045:
046: public interface ProjectFileIR {
047: /** @return an array full of all the source files in this project file. */
048: public DocFile[] getSourceFiles();
049:
050: /** These files are the files outside of the project tree that are saved in the project file so that they are opened
051: * as well as the project files.
052: * @return an array full of all the aux files in this project file
053: */
054: public DocFile[] getAuxiliaryFiles();
055:
056: /** @return the build directory stored in this project file */
057: public File getBuildDirectory();
058:
059: /** @return the working directory stored in this project file */
060: public File getWorkingDirectory();
061:
062: /** @return an array of path strings correspond to which folders in the tree should not be shown. Any paths not in
063: * this list will be expanded when the project is opened.
064: */
065: public String[] getCollapsedPaths();
066:
067: /** @return an array full of all the classpath path elements in the classpath for this project file */
068: public Iterable<File> getClassPaths();
069:
070: /** @return the name of the file that holds the Jar main class associated with this project */
071: public File getMainClass();
072:
073: /** @return the project file for this project. */
074: public File getProjectFile();
075:
076: /** @return the directory that is the root of the project source tree. */
077: public File getProjectRoot();
078:
079: /** @return the output file used in the "Create Jar" dialog. */
080: public File getCreateJarFile();
081:
082: /** @return the flags used in the "Create Jar" dialog. */
083: public int getCreateJarFlags();
084:
085: /** @return the array of bookmarks. */
086: public DocumentRegion[] getBookmarks();
087:
088: /** @return the array of breakpoints. */
089: public DebugBreakpointData[] getBreakpoints();
090:
091: /** @return the array of watches. */
092: public DebugWatchData[] getWatches();
093:
094: public void setSourceFiles(List<DocFile> sf);
095:
096: public void setAuxiliaryFiles(List<DocFile> aux);
097:
098: public void setCollapsedPaths(List<String> paths);
099:
100: public void setClassPaths(Iterable<? extends File> cp);
101:
102: public void setBuildDirectory(File dir);
103:
104: public void setWorkingDirectory(File dir);
105:
106: public void setMainClass(File main);
107:
108: public void setProjectRoot(File root);
109:
110: public void setCreateJarFile(File createJarFile);
111:
112: public void setCreateJarFlags(int createJarFlags);
113:
114: public void setBookmarks(List<? extends DocumentRegion> bms);
115:
116: public void setBreakpoints(List<? extends DebugBreakpointData> bps);
117:
118: public void setWatches(List<? extends DebugWatchData> ws);
119: }
|