edu.rice.cs.drjava.model
Interface GlobalModel

All Superinterfaces:

ILoadDocuments

All Known Subinterfaces:

SingleDisplayModel

All Known Implementing Classes:

AbstractGlobalModel, DefaultGlobalModel, DocumentCacheTest.TestGlobalModel, DummyGlobalModel, GlobalModelTestCase.TestGlobalModel, TestDocGetter

public interface GlobalModel
extends ILoadDocuments

Handles the bulk of DrJava's program logic. The UI components interface with the GlobalModel through its public methods, and GlobalModel responds via the GlobalModelListener interface. This removes the dependency on the UI for the logical flow of the program's features. With the current implementation, we can finally test the compile an unit testing functionality of DrJava, along with many other things. An ongoing refactoring effort will be moving many GlobalModel functions into more specific sub-interfaces for particular behaviors:

Version:

$Id: GlobalModel.java 5436 2011-08-02 06:58:19Z mgricken $

See Also:

DefaultGlobalModel, ILoadDocuments, CompilerModel, JUnitModel, JavadocModel

Method Summary

void	addAuxiliaryFile(OpenDefinitionsDocument doc) Adds a document to the list of auxiliary files.
void	addListener(GlobalModelListener listener) Add a listener to this global model.
void	addToBrowserHistory() Add the current location to the browser history.
void	cleanBuildDirectory() Cleans the build directory.
void	clearHistory() Clears the interactions history.
boolean	closeAllFiles() Attempts to close all open documents.
boolean	closeFile(OpenDefinitionsDocument doc) Closes an open definitions document, prompting to save if the document has been changed.
boolean	closeFiles(java.util.List<OpenDefinitionsDocument> docs) This function closes a group of files assuming that the files are contiguous in the enumeration provided by the document navigator.
boolean	closeFileWithoutPrompt(OpenDefinitionsDocument doc) Closes an open definitions document, without prompting to save if the document has been changed.
void	closeProject(boolean qutting) Performs any needed operations on the model before closing the project and its files.
void	configNewProject() Configures a new project (created by createNewProject) and saves it to disk.
RegionManager<MovingDocumentRegion>	createFindResultsManager()
void	createNewProject(java.io.File projFile) Creates a new project with specified project file and default values for other properties.
java.io.File	findFileInPaths(java.lang.String fileName, java.lang.Iterable<java.io.File> paths) Searches for a file with the given name on the provided paths.
java.lang.String	fixPathForNavigator(java.lang.String path) Formats a string pathname for use in the document navigator.
void	forceQuit() Halts the program immediately.
boolean	getAutoRefreshStatus() Gets autorefresh status of the project
java.lang.String	getAuxiliaryBinTitle() Gives the title of the aux files bin for the navigator
java.util.List<OpenDefinitionsDocument>	getAuxiliaryDocuments()
RegionManager<MovingDocumentRegion>	getBookmarkManager()
RegionManager<Breakpoint>	getBreakpointManager()
BrowserHistoryManager	getBrowserHistoryManager()
java.io.File	getBuildDirectory()
java.util.List<java.io.File>	getClassFiles()
java.lang.Iterable<java.io.File>	getClassPath() Get the class path to be used in all class-related operations.
CompilerModel	getCompilerModel() Gets the CompilerModel, which provides all methods relating to compilers.
ConsoleDocument	getConsoleDocument() Gets the console document.
java.io.File	getCreateJarFile() Return the create jar file for the project.
int	getCreateJarFlags() Return the create jar file for the project.
java.lang.String	getCustomManifest()
Debugger	getDebugger() Gets the Debugger, which interfaces with the integrated debugger.
int	getDebugPort() Returns an available port number to use for debugging the interactions JVM.
int	getDocumentCount() Returns the document count
OpenDefinitionsDocument	getDocumentForFile(java.io.File file) Returns the OpenDefinitionsDocument for the specified File, opening a new copy if one is not already open.
DocumentIterator	getDocumentIterator() Gets a DocumentIterator to allow navigating through open swing Documents.
IDocumentNavigator<OpenDefinitionsDocument>	getDocumentNavigator() Gets the DocumentNavigator, which controls the document view.
DefinitionsEditorKit	getEditorKit() Fetches the EditorKit implementation for use in the definitions pane.
java.lang.String	getExternalBinTitle() Gives the title of the external files bin for the navigator
java.lang.Iterable<AbsRelFile>	getExtraClassPath() Returns only the project's extra classpaths.
java.lang.String	getHistoryAsString() Returns the entire history as a String.
java.lang.String	getHistoryAsStringWithSemicolons() Returns the entire history as a String with semicolons as needed.
java.lang.Iterable<java.io.File>	getInteractionsClassPath() Returns the current classpath in use by the Interpreter JVM.
InteractionsDocument	getInteractionsDocument() Gets the (toolkit-independent) interactions document.
DefaultInteractionsModel	getInteractionsModel() Returns the interactions model.
JavadocModel	getJavadocModel() Gets the JavadocModel, which provides all methods relating to Javadoc.
JUnitModel	getJUnitModel() Gets the JUnitModel, which provides all methods relating to JUnit testing.
java.util.List<OpenDefinitionsDocument>	getLLOpenDefinitionsDocuments() Returns a collection of language level documents.
java.lang.String	getMainClass() Return the main file for the project If not in project mode, returns null.
java.io.File	getMainClassContainingFile() Return the File that contains the Main-Class.
java.io.File	getMasterWorkingDirectory()
java.util.List<OpenDefinitionsDocument>	getNonProjectDocuments() Returns a list of OpenDefinitionsDocuments that do not belong to the currently active project. If no project is active, all documents are returned.
GlobalEventNotifier	getNotifier()
int	getNumCompErrors() Returns the number of compiler errors produced by the last compilation.
OpenDefinitionsDocument	getODDForDocument(AbstractDocumentInterface doc) CHECK IF NEEDED!
java.util.List<OpenDefinitionsDocument>	getOpenDefinitionsDocuments() Returns a collection of all documents currently open for editing.
java.util.List<OpenDefinitionsDocument>	getOutOfSyncDocuments()
java.util.List<OpenDefinitionsDocument>	getOutOfSyncDocuments(java.util.List<OpenDefinitionsDocument> lod)
java.awt.print.PageFormat	getPageFormat()
java.util.Map<OptionParser<?>,java.lang.String>	getPreferencesStoredInProject()
java.util.List<OpenDefinitionsDocument>	getProjectDocuments() Teturns a list of OpenDefinitionsDocuments that do belong to the currently active project. If no project is active, no documents are returned.
java.io.File	getProjectFile()
java.io.File[]	getProjectFiles()
java.io.File	getProjectRoot()
java.lang.String	getSourceBinTitle() Gives the title of the source bin for the navigator
java.io.File	getSourceFile(java.lang.String fileName) Searches for a file with the given name on the current source roots and the augmented classpath.
java.lang.Iterable<java.io.File>	getSourceRootSet() Gets a list of all sourceRoots for the open definitions documents, without duplicates.
InteractionsDJDocument	getSwingConsoleDocument() TODO: remove this swing dependency.
InteractionsDJDocument	getSwingInteractionsDocument() TODO: remove this swing dependency.
java.io.File	getWorkingDirectory()
boolean	hasModifiedDocuments() Checks if any open definitions documents have been modified since last being saved.
boolean	hasModifiedDocuments(java.util.List<OpenDefinitionsDocument> lod) Checks if any of the given documents have been modified since last being saved.
boolean	hasOutOfSyncDocuments()
boolean	hasOutOfSyncDocuments(java.util.List<OpenDefinitionsDocument> lod)
boolean	hasUntitledDocuments() Checks if any open definitions documents are untitled.
boolean	inProject(java.io.File f) Returns true the given file is in the current project file.
boolean	inProjectPath(OpenDefinitionsDocument doc) A file is in the project if the source root is the same as the project root.
void	interpretCurrentInteraction() Interprets the current given text at the prompt in the interactions pane.
boolean	isProjectActive()
boolean	isProjectChanged() Returns true if the project state has been changed
void	loadHistory(FileOpenSelector selector) Interprets file selected in the FileOpenSelector.
InteractionsScriptModel	loadHistoryAsScript(FileOpenSelector selector) Loads the history/histories from the given selector.
OpenDefinitionsDocument	newFile() Creates a new document in the definitions pane and adds it to the list of open documents.
OpenDefinitionsDocument	newFile(java.lang.String text) Creates a new document in the definitions pane, containing the specified text, and adds it to the list of open documents.
OpenDefinitionsDocument	newTestCase(java.lang.String name, boolean makeSetUp, boolean makeTearDown) Creates a new junit test case.
void	openFolder(java.io.File dir, boolean rec, java.lang.String ext)
void	openProject(java.io.File file) Parses out the given project file, sets up the state and other configurations such as the Navigator and the classpath, and returns an array of files to open.
void	printDebugMessage(java.lang.String s) Called when the debugger wants to print a message.
void	quit() Exits the program.
void	refreshActiveDocument() Re-runs the global listeners on the active document.
void	reloadProject(java.io.File f, java.util.HashMap<OpenDefinitionsDocument,DocumentInfoGetter> info) Reloads a project without writing to disk.
void	removeAuxiliaryFile(OpenDefinitionsDocument doc) Removes a document from the list of auxiliary files.
void	removeFindResultsManager(RegionManager<MovingDocumentRegion> rm) Dispose a manager for find result regions.
void	removeListener(GlobalModelListener listener) Remove a listener from this global model.
void	resetConsole() Resets the console.
void	resetInteractions(java.io.File wd) Clears and resets the interactions pane in the specified working directory, provided that the operation has some effect.
void	resetInteractions(java.io.File wd, boolean forceReset) Clears and resets the interactions pane in the specified working directory.
void	saveAllFiles(FileSaveSelector com) Saves all open documents, prompting when necessary.
void	saveConsoleCopy(ConsoleDocument doc, FileSaveSelector selector) Save copy of Console or Interactions Pane to text file.
void	saveHistory(FileSaveSelector selector) Saves the unedited version of the current history to a file
void	saveHistory(FileSaveSelector selector, java.lang.String editedVersion) Saves the edited version of the current history to a file
void	saveProject(java.io.File f, java.util.HashMap<OpenDefinitionsDocument,DocumentInfoGetter> info) Writes the project file to disk
void	setAutoRefreshStatus(boolean b) Sets autorefresh status of the project
void	setBuildDirectory(java.io.File f) Sets the current build directory.
void	setCreateJarFile(java.io.File f) Sets the create jar file of the project.
void	setCreateJarFlags(int f) Sets the create jar flags of the project.
void	setCustomManifest(java.lang.String manifest)
void	setDocumentNavigator(IDocumentNavigator<OpenDefinitionsDocument> newnav)
void	setExtraClassPath(java.lang.Iterable<AbsRelFile> cp) Sets the set of classpath entries to use as the projects set of classpath entries.
void	setMainClass(java.lang.String f) Sets the main file of the project.
void	setNumCompErrors(int num) Sets the number of compiler errors produced by the last compilation.
void	setPageFormat(java.awt.print.PageFormat format)
void	setPreferencesStoredInProject(java.util.Map<OptionParser<?>,java.lang.String> sp) Set the preferences stored in the project.
void	setProjectChanged(boolean changed) Notifies the project state that the project has been changed.
void	setProjectFile(java.io.File f) Sets project file to specifed value; used in "Save Project As ..." command in MainFrame.
void	setProjectRoot(java.io.File f) Sets the source root for the project.
void	setWorkingDirectory(java.io.File f) Sets the working directory for the Slave JVM (only applies to project mode).
void	systemErrPrint(java.lang.String s) Prints System.err to the DrJava console.
void	systemInEcho(java.lang.String s) Prints the given string to the DrJava console as an echo of System.in.
void	systemOutPrint(java.lang.String s) Prints System.out to the DrJava console.

Methods inherited from interface edu.rice.cs.drjava.model.ILoadDocuments

openFile, openFiles

Method Detail

addListener

void addListener(GlobalModelListener listener)

Add a listener to this global model.

Parameters:

listener - a listener that reacts on events generated by the GlobalModel

removeListener

void removeListener(GlobalModelListener listener)

Remove a listener from this global model.

Parameters:

listener - a listener that reacts on events generated by the GlobalModel

getInteractionsModel

DefaultInteractionsModel getInteractionsModel()

Returns the interactions model.

getCompilerModel

CompilerModel getCompilerModel()

Gets the CompilerModel, which provides all methods relating to compilers.

getJUnitModel

JUnitModel getJUnitModel()

Gets the JUnitModel, which provides all methods relating to JUnit testing.

getJavadocModel

JavadocModel getJavadocModel()

Gets the JavadocModel, which provides all methods relating to Javadoc.

getDebugger

Debugger getDebugger()

Gets the Debugger, which interfaces with the integrated debugger.

getDocumentNavigator

IDocumentNavigator<OpenDefinitionsDocument> getDocumentNavigator()

Gets the DocumentNavigator, which controls the document view.

setDocumentNavigator

void setDocumentNavigator(IDocumentNavigator<OpenDefinitionsDocument> newnav)

getBreakpointManager

RegionManager<Breakpoint> getBreakpointManager()

Returns:

manager for breakpoint regions.

getBookmarkManager

RegionManager<MovingDocumentRegion> getBookmarkManager()

Returns:

manager for bookmark regions.

createFindResultsManager

RegionManager<MovingDocumentRegion> createFindResultsManager()

Returns:

new manager for find result regions.

removeFindResultsManager

void removeFindResultsManager(RegionManager<MovingDocumentRegion> rm)

Dispose a manager for find result regions.

getBrowserHistoryManager

BrowserHistoryManager getBrowserHistoryManager()

Returns:

manager for browser history regions.

addToBrowserHistory

void addToBrowserHistory()

Add the current location to the browser history.

newFile

OpenDefinitionsDocument newFile()

Creates a new document in the definitions pane and adds it to the list of open documents.

Returns:

The new open document

newFile

OpenDefinitionsDocument newFile(java.lang.String text)

Creates a new document in the definitions pane, containing the specified text, and adds it to the list of open documents.

Parameters:

text - for the new document

Returns:

The new open document

newTestCase

OpenDefinitionsDocument newTestCase(java.lang.String name,
                                    boolean makeSetUp,
                                    boolean makeTearDown)

Creates a new junit test case. TODO: Move to JUnitModel?

Parameters:

name - the name of the new test case

makeSetUp - true iff an empty setUp() method should be included

makeTearDown - true iff an empty tearDown() method should be included

Returns:

the new open test case

closeFile

boolean closeFile(OpenDefinitionsDocument doc)

Closes an open definitions document, prompting to save if the document has been changed. Returns whether the file was successfully closed.

Returns:

true if the document was closed

closeFileWithoutPrompt

boolean closeFileWithoutPrompt(OpenDefinitionsDocument doc)

Closes an open definitions document, without prompting to save if the document has been changed. Returns whether the file was successfully closed.

Returns:

true if the document was closed

closeAllFiles

boolean closeAllFiles()

Attempts to close all open documents.

Returns:

true if all documents were closed

closeFiles

boolean closeFiles(java.util.List<OpenDefinitionsDocument> docs)

This function closes a group of files assuming that the files are contiguous in the enumeration provided by the document navigator. This assumption is used in selecting which remaining document (if any) to activate.

The corner cases in which the file that is being closed had been externally deleted have been addressed in a few places, namely DefaultGlobalModel.canAbandonFile() and MainFrame.ModelListener.canAbandonFile(). If the DefinitionsDocument for the OpenDefinitionsDocument being closed is not in the cache (see model.cache.DocumentCache) then it is closed without prompting the user to save it. If it is in the cache, then we can successfully notify the user that the file is selected for closing and ask whether to saveAs, close, or cancel.

Parameters:

docs - the list od OpenDefinitionsDocuments to close

Returns:

whether all files were closed

openFolder

void openFolder(java.io.File dir,
                boolean rec,
                java.lang.String ext)
                throws java.io.IOException,
                       OperationCanceledException,
                       AlreadyOpenException

Throws:

java.io.IOException

OperationCanceledException

AlreadyOpenException

saveAllFiles

void saveAllFiles(FileSaveSelector com)
                  throws java.io.IOException

Saves all open documents, prompting when necessary.

Throws:

java.io.IOException

createNewProject

void createNewProject(java.io.File projFile)

Creates a new project with specified project file and default values for other properties.

Parameters:

projFile - the new project file (which does not yet exist in the file system).

configNewProject

void configNewProject()
                      throws java.io.IOException

Configures a new project (created by createNewProject) and saves it to disk.

Throws:

java.io.IOException

saveProject

void saveProject(java.io.File f,
                 java.util.HashMap<OpenDefinitionsDocument,DocumentInfoGetter> info)
                 throws java.io.IOException

Writes the project file to disk

Parameters:

f - where to save the project

info - Extra view-related information that should be included in the project file

Throws:

java.io.IOException

reloadProject

void reloadProject(java.io.File f,
                   java.util.HashMap<OpenDefinitionsDocument,DocumentInfoGetter> info)
                   throws java.io.IOException

Reloads a project without writing to disk.

Parameters:

f - project file; does not actually get touched

Throws:

java.io.IOException

fixPathForNavigator

java.lang.String fixPathForNavigator(java.lang.String path)
                                     throws java.io.IOException

Formats a string pathname for use in the document navigator.

Throws:

java.io.IOException

getSourceBinTitle

java.lang.String getSourceBinTitle()

Gives the title of the source bin for the navigator

Returns:

The text used for the source bin in the tree navigator

getExternalBinTitle

java.lang.String getExternalBinTitle()

Gives the title of the external files bin for the navigator

Returns:

The text used for the external files bin in the tree navigator

getAuxiliaryBinTitle

java.lang.String getAuxiliaryBinTitle()

Gives the title of the aux files bin for the navigator

Returns:

The text used for the aux files bin in the tree navigator

addAuxiliaryFile

void addAuxiliaryFile(OpenDefinitionsDocument doc)

Adds a document to the list of auxiliary files.

removeAuxiliaryFile

void removeAuxiliaryFile(OpenDefinitionsDocument doc)

Removes a document from the list of auxiliary files.

openProject

void openProject(java.io.File file)
                 throws java.io.IOException,
                        MalformedProjectFileException

Parses out the given project file, sets up the state and other configurations such as the Navigator and the classpath, and returns an array of files to open.

Parameters:

file - The project file to parse

Throws:

java.io.IOException

MalformedProjectFileException

closeProject

void closeProject(boolean qutting)

Performs any needed operations on the model before closing the project and its files. This is not responsible for actually closing the files since that is handled in MainFrame._closeProject()

getSourceFile

java.io.File getSourceFile(java.lang.String fileName)

Searches for a file with the given name on the current source roots and the augmented classpath.

Parameters:

fileName - Name of the source file to look for

Returns:

the file corresponding to the given name, or null if it cannot be found

findFileInPaths

java.io.File findFileInPaths(java.lang.String fileName,
                             java.lang.Iterable<java.io.File> paths)

Searches for a file with the given name on the provided paths. Returns null if the file is not found.

Parameters:

fileName - Name of the source file to look for

paths - An array of directories to search

getSourceRootSet

java.lang.Iterable<java.io.File> getSourceRootSet()

Gets a list of all sourceRoots for the open definitions documents, without duplicates.

getEditorKit

DefinitionsEditorKit getEditorKit()

Fetches the EditorKit implementation for use in the definitions pane.

getDocumentIterator

DocumentIterator getDocumentIterator()

Gets a DocumentIterator to allow navigating through open swing Documents. TODO: remove ugly swing dependency.

refreshActiveDocument

void refreshActiveDocument()

Re-runs the global listeners on the active document.

getConsoleDocument

ConsoleDocument getConsoleDocument()

Gets the console document.

getSwingConsoleDocument

InteractionsDJDocument getSwingConsoleDocument()

TODO: remove this swing dependency.

Returns:

InteractionsDJDocument in use by the ConsoleDocument.

resetConsole

void resetConsole()

Resets the console. Fires consoleReset() event.

systemOutPrint

void systemOutPrint(java.lang.String s)

Prints System.out to the DrJava console. This method may be safely called from outside the event thread.

systemErrPrint

void systemErrPrint(java.lang.String s)

Prints System.err to the DrJava console. This method may be safely called from outside the event thread.

systemInEcho

void systemInEcho(java.lang.String s)

Prints the given string to the DrJava console as an echo of System.in. This method may be safely called from outside the event thread.

getInteractionsDocument

InteractionsDocument getInteractionsDocument()

Gets the (toolkit-independent) interactions document.

getSwingInteractionsDocument

InteractionsDJDocument getSwingInteractionsDocument()

TODO: remove this swing dependency.

Returns:

InteractionsDJDocument in use by the InteractionsDocument.

resetInteractions

void resetInteractions(java.io.File wd)

Clears and resets the interactions pane in the specified working directory, provided that the operation has some effect.

resetInteractions

void resetInteractions(java.io.File wd,
                       boolean forceReset)

Clears and resets the interactions pane in the specified working directory.

interpretCurrentInteraction

void interpretCurrentInteraction()

Interprets the current given text at the prompt in the interactions pane.

getInteractionsClassPath

java.lang.Iterable<java.io.File> getInteractionsClassPath()

Returns the current classpath in use by the Interpreter JVM. This includes the original jvm classpath, the global drjava extra classpaths, and the project extra classpaths.

loadHistory

void loadHistory(FileOpenSelector selector)
                 throws java.io.IOException

Interprets file selected in the FileOpenSelector. Assumes all strings have no trailing whitespace. Interprets the list of interactions as a single transaction so the first error aborts all processing.

Throws:

java.io.IOException

loadHistoryAsScript

InteractionsScriptModel loadHistoryAsScript(FileOpenSelector selector)
                                            throws java.io.IOException,
                                                   OperationCanceledException

Loads the history/histories from the given selector.

Throws:

java.io.IOException

OperationCanceledException

clearHistory

void clearHistory()

Clears the interactions history.

saveConsoleCopy

void saveConsoleCopy(ConsoleDocument doc,
                     FileSaveSelector selector)
                     throws java.io.IOException

Save copy of Console or Interactions Pane to text file.

Throws:

java.io.IOException

saveHistory

void saveHistory(FileSaveSelector selector)
                 throws java.io.IOException

Saves the unedited version of the current history to a file

Parameters:

selector - File to save to

Throws:

java.io.IOException

saveHistory

void saveHistory(FileSaveSelector selector,
                 java.lang.String editedVersion)
                 throws java.io.IOException

Saves the edited version of the current history to a file

Parameters:

selector - File to save to

editedVersion - Edited verison of the history which will be saved to file instead of the lines saved in the history. The saved file will still include any tags needed to recognize it as a saved interactions file.

Throws:

java.io.IOException

getHistoryAsStringWithSemicolons

java.lang.String getHistoryAsStringWithSemicolons()

Returns the entire history as a String with semicolons as needed.

getHistoryAsString

java.lang.String getHistoryAsString()

Returns the entire history as a String.

printDebugMessage

void printDebugMessage(java.lang.String s)

Called when the debugger wants to print a message.

getDebugPort

int getDebugPort()
                 throws java.io.IOException

Returns an available port number to use for debugging the interactions JVM.

Throws:

java.io.IOException - if unable to get a valid port number.

getClassPath

java.lang.Iterable<java.io.File> getClassPath()

Get the class path to be used in all class-related operations. TODO: Insure that this is used wherever appropriate.

getPageFormat

java.awt.print.PageFormat getPageFormat()

setPageFormat

void setPageFormat(java.awt.print.PageFormat format)

quit

void quit()

Exits the program. Only quits if all documents are successfully closed.

forceQuit

void forceQuit()

Halts the program immediately.

getDocumentCount

int getDocumentCount()

Returns the document count

getNumCompErrors

int getNumCompErrors()

Returns the number of compiler errors produced by the last compilation.

setNumCompErrors

void setNumCompErrors(int num)

Sets the number of compiler errors produced by the last compilation.

getODDForDocument

OpenDefinitionsDocument getODDForDocument(AbstractDocumentInterface doc)

CHECK IF NEEDED!

getNonProjectDocuments

java.util.List<OpenDefinitionsDocument> getNonProjectDocuments()

Returns a list of OpenDefinitionsDocuments that do not belong to the currently active project.
If no project is active, all documents are returned.

getProjectDocuments

java.util.List<OpenDefinitionsDocument> getProjectDocuments()

Teturns a list of OpenDefinitionsDocuments that do belong to the currently active project.
If no project is active, no documents are returned.

isProjectActive

boolean isProjectActive()

Returns:

true if the model has a project open, false otherwise.

getProjectFile

java.io.File getProjectFile()

Returns:

the file that points to the current project file. Null if not currently in project view

getProjectFiles

java.io.File[] getProjectFiles()

Returns:

the directory that the class files should be stored after compilation.

getProjectRoot

java.io.File getProjectRoot()

Returns:

the source root for the project.

setProjectFile

void setProjectFile(java.io.File f)

Sets project file to specifed value; used in "Save Project As ..." command in MainFrame.

setProjectRoot

void setProjectRoot(java.io.File f)

Sets the source root for the project.

getBuildDirectory

java.io.File getBuildDirectory()

Returns:

the directory that the class files should be stored after compilation.

setBuildDirectory

void setBuildDirectory(java.io.File f)

Sets the current build directory.

getAutoRefreshStatus

boolean getAutoRefreshStatus()

Gets autorefresh status of the project

setAutoRefreshStatus

void setAutoRefreshStatus(boolean b)

Sets autorefresh status of the project

getPreferencesStoredInProject

java.util.Map<OptionParser<?>,java.lang.String> getPreferencesStoredInProject()

Returns:

the stored preferences.

setPreferencesStoredInProject

void setPreferencesStoredInProject(java.util.Map<OptionParser<?>,java.lang.String> sp)

Set the preferences stored in the project.

getMasterWorkingDirectory

java.io.File getMasterWorkingDirectory()

Returns:

the working directory for the Master JVM.

getWorkingDirectory

java.io.File getWorkingDirectory()

Returns:

the working directory for the Slave JVM (only applied to project mode).

setWorkingDirectory

void setWorkingDirectory(java.io.File f)

Sets the working directory for the Slave JVM (only applies to project mode).

setMainClass

void setMainClass(java.lang.String f)

Sets the main file of the project.

getMainClass

java.lang.String getMainClass()

Return the main file for the project If not in project mode, returns null.

getMainClassContainingFile

java.io.File getMainClassContainingFile()

Return the File that contains the Main-Class.

getExtraClassPath

java.lang.Iterable<AbsRelFile> getExtraClassPath()

Returns only the project's extra classpaths.

Returns:

The classpath entries loaded along with the project

setExtraClassPath

void setExtraClassPath(java.lang.Iterable<AbsRelFile> cp)

Sets the set of classpath entries to use as the projects set of classpath entries. This is normally used by the project preferences.

setCreateJarFile

void setCreateJarFile(java.io.File f)

Sets the create jar file of the project.

getCreateJarFile

java.io.File getCreateJarFile()

Return the create jar file for the project. If not in project mode, returns null.

setCreateJarFlags

void setCreateJarFlags(int f)

Sets the create jar flags of the project.

getCreateJarFlags

int getCreateJarFlags()

Return the create jar file for the project. If not in project mode, returns 0.

inProject

boolean inProject(java.io.File f)

Returns true the given file is in the current project file.

inProjectPath

boolean inProjectPath(OpenDefinitionsDocument doc)

A file is in the project if the source root is the same as the project root. This means that project files must be saved in the source root. (we query the model through the model's state)

setProjectChanged

void setProjectChanged(boolean changed)

Notifies the project state that the project has been changed.

isProjectChanged

boolean isProjectChanged()

Returns true if the project state has been changed

hasOutOfSyncDocuments

boolean hasOutOfSyncDocuments()

Returns:

true iff no open document is out of sync with its primary class file.

hasOutOfSyncDocuments

boolean hasOutOfSyncDocuments(java.util.List<OpenDefinitionsDocument> lod)

Returns:

true iff no document in given list is out of sync with its primary class file.

getOutOfSyncDocuments

java.util.List<OpenDefinitionsDocument> getOutOfSyncDocuments()

Returns:

list of open documents that are out of sync with their primary class files.

getOutOfSyncDocuments

java.util.List<OpenDefinitionsDocument> getOutOfSyncDocuments(java.util.List<OpenDefinitionsDocument> lod)

Returns:

list of open documents in given list that are out of sync with their primary class files.

cleanBuildDirectory

void cleanBuildDirectory()

Cleans the build directory.

getClassFiles

java.util.List<java.io.File> getClassFiles()

Returns:

a list of class files.

getOpenDefinitionsDocuments

java.util.List<OpenDefinitionsDocument> getOpenDefinitionsDocuments()

Returns a collection of all documents currently open for editing. This is equivalent to the results of getDocumentForFile for the set of all files for which isAlreadyOpen returns true. The order of documents is the same as in the display of documents in the view.

Returns:

a List of the open definitions documents.

getLLOpenDefinitionsDocuments

java.util.List<OpenDefinitionsDocument> getLLOpenDefinitionsDocuments()

Returns a collection of language level documents.

getAuxiliaryDocuments

java.util.List<OpenDefinitionsDocument> getAuxiliaryDocuments()

hasModifiedDocuments

boolean hasModifiedDocuments()

Checks if any open definitions documents have been modified since last being saved.

Returns:

whether any documents have been modified

hasModifiedDocuments

boolean hasModifiedDocuments(java.util.List<OpenDefinitionsDocument> lod)

Checks if any of the given documents have been modified since last being saved.

Returns:

whether any documents have been modified

hasUntitledDocuments

boolean hasUntitledDocuments()

Checks if any open definitions documents are untitled.

Returns:

whether any documents are untitled

getDocumentForFile

OpenDefinitionsDocument getDocumentForFile(java.io.File file)
                                           throws java.io.IOException

Returns the OpenDefinitionsDocument for the specified File, opening a new copy if one is not already open.

Parameters:

file - File contained by the document to be returned

Returns:

OpenDefinitionsDocument containing file

Throws:

java.io.IOException

getNotifier

GlobalEventNotifier getNotifier()

getCustomManifest

java.lang.String getCustomManifest()

setCustomManifest

void setCustomManifest(java.lang.String manifest)