edu.rice.cs.drjava.project
Interface ProjectFileIR

All Known Implementing Classes:

ProjectProfile

public interface ProjectFileIR

Method Summary

boolean	getAutoRefreshStatus()
DocFile[]	getAuxiliaryFiles() These files are the files outside of the project tree that are saved in the project file so that they are opened as well as the project files.
FileRegion[]	getBookmarks()
DebugBreakpointData[]	getBreakpoints()
File	getBuildDirectory()
Iterable<AbsRelFile>	getClassPaths()
String[]	getCollapsedPaths()
File	getCreateJarFile()
int	getCreateJarFlags()
String	getCustomManifest() Accessor for custom manifest in project.
String	getDrJavaVersion() The version of dr java that created this project (as determined from its serialization as a .pjt or .drjava or .xml file)
DocFile[]	getExcludedFiles() These files are in the project source tree, but have been explicitly excluded from the project.
String	getMainClass()
File	getMainClassContainingFile()
Map<OptionParser<?>,String>	getPreferencesStoredInProject()
File	getProjectFile()
File	getProjectRoot()
DocFile[]	getSourceFiles()
DebugWatchData[]	getWatches()
File	getWorkingDirectory()
void	setAutoRefreshStatus(boolean b)
void	setAuxiliaryFiles(List<DocFile> aux)
void	setBookmarks(List<? extends FileRegion> bms)
void	setBreakpoints(List<? extends DebugBreakpointData> bps)
void	setBuildDirectory(File dir)
void	setClassPaths(Iterable<? extends AbsRelFile> cp)
void	setCollapsedPaths(List<String> paths)
void	setCreateJarFile(File createJarFile)
void	setCreateJarFlags(int createJarFlags)
void	setCustomManifest(String manifest) Mutator for custom manifest.
void	setDrJavaVersion(String version) Sets the version of DrJava that built this project.
void	setExcludedFiles(List<DocFile> ef)
void	setMainClass(String main)
void	setPreferencesStoredInProject(Map<OptionParser<?>,String> sp)
void	setProjectRoot(File root)
void	setSourceFiles(List<DocFile> sf)
void	setWatches(List<? extends DebugWatchData> ws)
void	setWorkingDirectory(File dir)

Method Detail

getSourceFiles

DocFile[] getSourceFiles()

Returns:

an array full of all the source files in this project file.

getAuxiliaryFiles

DocFile[] getAuxiliaryFiles()

These files are the files outside of the project tree that are saved in the project file so that they are opened as well as the project files.

Returns:

an array full of all the aux files in this project file

getExcludedFiles

DocFile[] getExcludedFiles()

These files are in the project source tree, but have been explicitly excluded from the project.

Returns:

an array full of all the excluded files in this project file.

getBuildDirectory

File getBuildDirectory()

Returns:

the build directory stored in this project file

getWorkingDirectory

File getWorkingDirectory()

Returns:

the working directory stored in this project file

getCollapsedPaths

String[] getCollapsedPaths()

Returns:

an array of path strings correspond to which folders in the tree should not be shown. Any paths not in this list will be expanded when the project is opened.

getClassPaths

Iterable<AbsRelFile> getClassPaths()

Returns:

an array full of all the classpath path elements in the classpath for this project file

getMainClass

String getMainClass()

Returns:

the fully qualified name of the class that holds the Jar main class associated with this project

getMainClassContainingFile

File getMainClassContainingFile()

Returns:

the File that contains the class specified by getMainClass()

getProjectFile

File getProjectFile()

Returns:

the project file for this project.

getProjectRoot

File getProjectRoot()

Returns:

the directory that is the root of the project source tree.

getCreateJarFile

File getCreateJarFile()

Returns:

the output file used in the "Create Jar" dialog.

getCreateJarFlags

int getCreateJarFlags()

Returns:

the flags used in the "Create Jar" dialog.

getBookmarks

FileRegion[] getBookmarks()

Returns:

the array of bookmarks.

getBreakpoints

DebugBreakpointData[] getBreakpoints()

Returns:

the array of breakpoints.

getWatches

DebugWatchData[] getWatches()

Returns:

the array of watches.

getAutoRefreshStatus

boolean getAutoRefreshStatus()

getPreferencesStoredInProject

Map<OptionParser<?>,String> getPreferencesStoredInProject()

Returns:

the stored preferences.

setSourceFiles

void setSourceFiles(List<DocFile> sf)

setAuxiliaryFiles

void setAuxiliaryFiles(List<DocFile> aux)

setExcludedFiles

void setExcludedFiles(List<DocFile> ef)

setCollapsedPaths

void setCollapsedPaths(List<String> paths)

setClassPaths

void setClassPaths(Iterable<? extends AbsRelFile> cp)

setBuildDirectory

void setBuildDirectory(File dir)

setWorkingDirectory

void setWorkingDirectory(File dir)

setMainClass

void setMainClass(String main)

setProjectRoot

void setProjectRoot(File root)

setCreateJarFile

void setCreateJarFile(File createJarFile)

setCreateJarFlags

void setCreateJarFlags(int createJarFlags)

setBookmarks

void setBookmarks(List<? extends FileRegion> bms)

setBreakpoints

void setBreakpoints(List<? extends DebugBreakpointData> bps)

setWatches

void setWatches(List<? extends DebugWatchData> ws)

setAutoRefreshStatus

void setAutoRefreshStatus(boolean b)

setPreferencesStoredInProject

void setPreferencesStoredInProject(Map<OptionParser<?>,String> sp)

getDrJavaVersion

String getDrJavaVersion()

The version of dr java that created this project (as determined from its serialization as a .pjt or .drjava or .xml file)

Returns:

The version string, if known, or "unknown" otherwise.

setDrJavaVersion

void setDrJavaVersion(String version)

Sets the version of DrJava that built this project.

Parameters:

version - - the version string, should be called with "unknown" if the version could not be determined.

getCustomManifest

String getCustomManifest()

Accessor for custom manifest in project. Note that the existance of such a manifest does not mean that the custom manifest is in USE. That depends on other JAR creation settings.

See Also:

getCreateJarFlags()

setCustomManifest

void setCustomManifest(String manifest)

Mutator for custom manifest.