org.apache.flex.compiler.workspaces

Interface IWorkspace

All Superinterfaces:

IFileSpecificationGetter

All Known Implementing Classes:

Workspace

public interface IWorkspace
extends IFileSpecificationGetter

Implementations maintain a collection of ICompilerProject's in the workspace and state that it is shared across multiple ICompilerProject's.

This interface extends IFileSpecificationGetter so that compilation units that do not wish to virtualize access to the file system can just use a workspace as their IFileSpecificationGetter.

Field Summary

Fields

Modifier and Type	Field and Description
static Map<ICompilerProject,Set<ICompilationUnit>>	NIL_COMPILATIONUNITS_TO_UPDATE Empty map that can be passed to endIdleState(Map) by callers who do not have a map containing ICompilationUnits whose updates to project symbol tables have been deferred.

Method Summary

Methods

Modifier and Type	Method and Description
void	addInvalidationListener(IInvalidationListener invalidationListner) Adds a IInvalidationListener on the workspace.
void	doneBuilding() Allows the workspace to enter the idle state once all pending operations are completed.
void	endIdleState(Map<ICompilerProject,Set<ICompilationUnit>> cusToUpdate) Updates symbol table entries for all the ICompilationUnits in the specified map and unlocks the lock acquired by calling startIdleState().
void	fileAdded(IFileSpecification addedFile) Called by clients of the driver object model when a file add has been detected.
void	fileChanged(IFileSpecification changedFile) Called by clients of the driver object model when a file change has been detected.
void	fileRemoved(IFileSpecification removedFile) Called by clients of the driver object model when a file remove has been detected.
IASDocDelegate	getASDocDelegate() Gets the IASDocDelegate that instances of ASParser will use to record information about ASDoc comments.
Collection<ICompilationUnit>	getCompilationUnits(String path, ICompilerProject project) Get all compilation units in the specified project related to the specified file name.
Iterable<ICompilationUnit>	getInvisibleAndVisibleCompilationUnits(String path, ICompilerProject project) Gets an iterator that iterates first over all invisible ICompilationUnit's for the specified file path in the specified ICompilerProject and then over all visible ICompilationUnit's for the specified file path in the specified ICompilerProject.
IMXMLDataManager	getMXMLDataManager() Gets the singleton that manages DOM-like MXMLData objects for MXML files in the workspace.
IWorkspaceProfilingDelegate	getProfilingDelegate() Gets the IWorkspaceProfilingDelegate from the workspace.
ISWCManager	getSWCManager() Get the SWC manager.
void	removeInvalidationListener(IInvalidationListener invalidationListner) Removes a IInvalidationListener on the workspace.
void	setASDocDelegate(IASDocDelegate asDocDelegate) Sets the IASDocDelegate that instances of ASParser will use to record information about ASDoc comments.
void	setProfilingDelegate(IWorkspaceProfilingDelegate profilingDelegate) Sets the IWorkspaceProfilingDelegate on the workspace.
void	startBuilding() Waits for the workspace to leave the idle state and prevents all threads from putting the workspace into the idle state.
void	startIdleState() Waits for all pending operation on all ICompilationUnit's in all ICompilerProjects in this IWorkspace to complete.

Methods inherited from interface org.apache.flex.compiler.common.IFileSpecificationGetter

getFileSpecification, getWorkspace

Field Detail

NIL_COMPILATIONUNITS_TO_UPDATE

static final Map<ICompilerProject,Set<ICompilationUnit>> NIL_COMPILATIONUNITS_TO_UPDATE

Empty map that can be passed to endIdleState(Map) by callers who do not have a map containing ICompilationUnits whose updates to project symbol tables have been deferred.

Method Detail

startIdleState

void startIdleState()

Waits for all pending operation on all ICompilationUnit's in all ICompilerProjects in this IWorkspace to complete. The activity lock will also be acquired in this call, so once this method has been called, no new work can be submitted until after the lock has been released by calling endIdleState(Map).

This method must never be called from an ICompilationUnit operation as that would result in dead lock.

endIdleState

void endIdleState(Map<ICompilerProject,Set<ICompilationUnit>> cusToUpdate)

Updates symbol table entries for all the ICompilationUnits in the specified map and unlocks the lock acquired by calling startIdleState().

Parameters:

cusToUpdate - Map from ICompilerProject to Set of ICompilationUnits in the project whose externally visible symbols need to be re-registered with the symbol table of the containing ICompilerProject.

startBuilding

void startBuilding()

Waits for the workspace to leave the idle state and prevents all threads from putting the workspace into the idle state. Calls to this method must be balanced with calls to doneBuilding().

doneBuilding

void doneBuilding()

Allows the workspace to enter the idle state once all pending operations are completed. Each call to this method should succeed exactly one call to startBuilding().

setProfilingDelegate

void setProfilingDelegate(IWorkspaceProfilingDelegate profilingDelegate)

Sets the IWorkspaceProfilingDelegate on the workspace.

Parameters:

profilingDelegate - IWorkspaceProfilingDelegate that will receive profiling information. Can be null, in which case no profiling information is collected.

getProfilingDelegate

IWorkspaceProfilingDelegate getProfilingDelegate()

Gets the IWorkspaceProfilingDelegate from the workspace.

Returns:

The IWorkspaceProfilingDelegate for this IWorkspace. Can be null.

addInvalidationListener

void addInvalidationListener(IInvalidationListener invalidationListner)

Adds a IInvalidationListener on the workspace.

Parameters:

invalidationListner - IInvalidationListener that will receive invalidation notifications.

removeInvalidationListener

void removeInvalidationListener(IInvalidationListener invalidationListner)

Removes a IInvalidationListener on the workspace.

Parameters:

invalidationListner - IInvalidationListener that will be removed.

getSWCManager

ISWCManager getSWCManager()

Get the SWC manager.

Returns:

ISWCManager object

getMXMLDataManager

IMXMLDataManager getMXMLDataManager()

Gets the singleton that manages DOM-like MXMLData objects for MXML files in the workspace.

Returns:

IMXMLDataManager object

fileRemoved

void fileRemoved(IFileSpecification removedFile)

Called by clients of the driver object model when a file remove has been detected. It is the duty of the caller to ensure no new threads are created until after this call has completed.

Parameters:

removedFile - An IFileSpecification that can be used to get the new contents of the removed file.

fileChanged

void fileChanged(IFileSpecification changedFile)

Called by clients of the driver object model when a file change has been detected. It is the duty of the caller to ensure no new threads are created until after this call has completed.

Parameters:

changedFile - An IFileSpecification that can be used to get the change filename.

fileAdded

void fileAdded(IFileSpecification addedFile)

Called by clients of the driver object model when a file add has been detected. It is the duty of the caller to ensure no new threads are created until after this call has completed.

Parameters:

addedFile - An IFileSpecification that can be used to get the name and contents of the added file.

getCompilationUnits

Collection<ICompilationUnit> getCompilationUnits(String path,
                                               ICompilerProject project)

Get all compilation units in the specified project related to the specified file name. This method will not return any invisible compilation units.

Parameters:

path - String to source filename

project - containing project

getInvisibleAndVisibleCompilationUnits

Iterable<ICompilationUnit> getInvisibleAndVisibleCompilationUnits(String path,
                                                                ICompilerProject project)

Gets an iterator that iterates first over all invisible ICompilationUnit's for the specified file path in the specified ICompilerProject and then over all visible ICompilationUnit's for the specified file path in the specified ICompilerProject.

Parameters:

path - Normalized absolute file name.

project - ICompilerProject that will contains all the ICompilationUnit in the returned Iterable.

Returns:

An iterator that iterates first over all invisible ICompilationUnit's for the specified file path in the specified ICompilerProject and then over all visible ICompilationUnit's for the specified file path in the specified ICompilerProject

getASDocDelegate

IASDocDelegate getASDocDelegate()

Gets the IASDocDelegate that instances of ASParser will use to record information about ASDoc comments.

Returns:

The IASDocDelegate that instances of ASParser will use to record information about ASDoc comments.

setASDocDelegate

void setASDocDelegate(IASDocDelegate asDocDelegate)

Sets the IASDocDelegate that instances of ASParser will use to record information about ASDoc comments.

Parameters:

asDocDelegate - IASDocDelegate that instances of ASParser will use to record information about ASDoc comments.