ProjectFileIR


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.project;
35  
36  import java.io.*;
37  import java.util.List  ;
38  
39  import edu.rice.cs.drjava.model.DocumentRegion;
40  import edu.rice.cs.drjava.model.debug.DebugBreakpointData;
41  import edu.rice.cs.drjava.model.debug.DebugWatchData;
42  
43  public interface ProjectFileIR {
44    /** @return an array full of all the source files in this project file. */
45    public DocFile[] getSourceFiles();
46      
47    /** These files are the files outside of the project tree that are saved in the project file so that they are opened
48     *  as well as the project files.
49     *  @return an array full of all the aux files in this project file
50     */
51    public DocFile[] getAuxiliaryFiles();
52      
53    /** @return the build directory stored in this project file */
54    public File getBuildDirectory();
55    
56     /** @return the working directory stored in this project file */
57    public File getWorkingDirectory();
58    
59    /** @return an array of path strings correspond to which folders in the tree should not be shown.  Any paths not in 
60     *  this list will be expanded when the project is opened.
61     */
62    public String  [] getCollapsedPaths();
63      
64    /** @return an array full of all the classpath path elements in the classpath for this project file */
65    public File[] getClassPaths();
66    
67    /** @return the name of the file that holds the Jar main class associated with this project */
68    public File getMainClass();
69    
70    /** @return the project file for this project. */
71    public File getProjectFile();
72    
73    /** @return the directory that is the root of the project source tree. */
74    public File getProjectRoot();
75    
76    /** @return the output file used in the "Create Jar" dialog. */
77    public File getCreateJarFile();
78    
79    /** @return the flags used in the "Create Jar" dialog. */
80    public int getCreateJarFlags();
81    
82    /** @return the array of bookmarks. */
83    public DocumentRegion[] getBookmarks();
84    
85    /** @return the array of breakpoints. */
86    public DebugBreakpointData[] getBreakpoints();
87    
88    /** @return the array of watches. */
89    public DebugWatchData[] getWatches();
90    
91    public void setSourceFiles(List  <DocFile> sf);
92    public void setAuxiliaryFiles(List  <DocFile> aux);
93    public void setCollapsedPaths(List  <String  > paths);
94    public void setClassPaths(List  <? extends File> cp);
95    public void setBuildDirectory(File dir);
96    public void setWorkingDirectory(File dir);
97    public void setMainClass(File main);
98    public void setProjectRoot(File root);
99    public void setCreateJarFile(File createJarFile);
100   public void setCreateJarFlags(int createJarFlags);
101   public void setBookmarks(List  <? extends DocumentRegion> bms);
102   public void setBreakpoints(List  <? extends DebugBreakpointData> bps);
103   public void setWatches(List  <? extends DebugWatchData> ws);
104 }
105
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags