org.apache.flex.compiler.projects

Interface IASProject

All Superinterfaces:

ICompilerProject

All Known Subinterfaces:

IFlexProject

All Known Implementing Classes:

ASProject, FlexJSProject, FlexProject

public interface IASProject
extends ICompilerProject

Base interface for all project types that use a source manager and library manager to create ICompilationUnits.

Method Summary

Methods

Modifier and Type	Method and Description
void	addIncludeSourceFile(File file) Adds a new include source file to the project.
void	addIncludeSourceFile(File file, boolean overrideSourcePath) Adds a new include source file to the project.
void	addProjectDependeny(IASProject project, String swcFilename) Adds a new project dependency to this project.
void	attachExternalLibrarySourcePath(File library, File sourceDir) Attach the source directory to an external SWC library.
void	attachInternalLibrarySourcePath(File library, File sourceDir) Attach the source directory to a SWC library.
IInvisibleCompilationUnit	createInvisibleCompilationUnit(String absoluteFileName, IFileSpecificationGetter fileSpecGetter) Creates an IInvisibleCompilationUnit for the specified absolute file name.
IInvisibleCompilationUnit	createInvisibleCompilationUnit(String rootSourceFile, IFileSpecificationGetter fileSpecGetter, String qName) Creates an IInvisibleCompilationUnit for the specified absolute file name, specifying a qualified name.
String	getAttachedSourceDirectory(String libraryFilename) Get the Directory for the specified library.
Integer	getCompatibilityVersion() Returns the compatibility version encoded as an integer.
String	getCompatibilityVersionString() Returns the compatibility version encoded as a string.
Set<IASProject>	getDependingProjects()
List<ISWC>	getLibraries() The libraries available to compiler source in this project.
String	getSourceFileFromSourcePath(String file) Iterate through the source path list looking for the specified file.
List<File>	getSourcePath() Get the list of source paths set.
boolean	invalidateLibraries(Collection<File> swcFiles) Removes any calculated data related to a collection of libraries.
void	invalidateLibrary(ISWC swc) Removes any calculated data related to a SWC.
boolean	isSupportedSourceFileType(String fileExtension) Determines if the specified file extension ( without the dot eg: as, not .as ) corresponds to a source file type that this project can create ICompilationUnits for.
void	removeIncludeSourceFile(File file) Removes an include source file to the project.
void	removeProjectDependeny(IASProject project) Removes a project dependency from this project.
void	setDependencies(Map<IASProject,String> dependencies) Resets the set of projects that this project depends on.
void	setIncludeSources(File[] files) Sets the include sources list for the project.
void	setLibraries(List<File> libraries) The libraries used to compile source files in a project.
void	setSourcePath(List<File> path) Sets the source path for the project.

Methods inherited from interface org.apache.flex.compiler.projects.ICompilerProject

clean, createSWFTarget, delete, doubleCheckAmbiguousDefinition, getActualPackageName, getBuiltinType, getCompilationUnits, getCompilationUnits, getDirectDependencies, getDirectReverseDependencies, getIncludingCompilationUnits, getProblems, getReachableCompilationUnitsInSWFOrder, getScope, getUndefinedValue, getWorkspace, isAssetEmbeddingSupported, isCompatibleOverrideReturnType, isInliningEnabled, isValidTypeConversion, resolveQNameToCompilationUnit, resolveQNameToDefinition, setProblems, setUseParallelCodeGeneration

Method Detail

setSourcePath

void setSourcePath(List<File> path)

Sets the source path for the project. Calling this method can invalidate a significant amount of incremental compilation results.

Parameters:

path - List of directories that should be searched for source files.

getSourcePath

List<File> getSourcePath()

Get the list of source paths set.

Returns:

a list of source paths.

setIncludeSources

void setIncludeSources(File[] files)
                       throws InterruptedException

Sets the include sources list for the project. Source files in this list are unconditionally added to the symbol table. Calling this method can invalidate a significant amount of incremental compilation results.

Parameters:

files -

Throws:

InterruptedException

addIncludeSourceFile

void addIncludeSourceFile(File file)
                          throws InterruptedException

Adds a new include source file to the project. Include source file's are files that should always be compiled into the project.

Parameters:

file - File to add.

Throws:

InterruptedException

addIncludeSourceFile

void addIncludeSourceFile(File file,
                        boolean overrideSourcePath)
                          throws InterruptedException

Adds a new include source file to the project. Include source file's are files that should always be compiled into the project.

Parameters:

file - File to add.

overrideSourcePath - Set to true to add the file to the source list even if it exists on the source path.

Throws:

InterruptedException

removeIncludeSourceFile

void removeIncludeSourceFile(File file)
                             throws InterruptedException

Removes an include source file to the project.

Parameters:

file - File to remove.

Throws:

InterruptedException

See Also:

addIncludeSourceFile(File)

attachInternalLibrarySourcePath

void attachInternalLibrarySourcePath(File library,
                                   File sourceDir)

Attach the source directory to a SWC library.

Parameters:

library - SWC library

sourceDir - directory that contains the source for the SWC library

attachExternalLibrarySourcePath

void attachExternalLibrarySourcePath(File library,
                                   File sourceDir)

Attach the source directory to an external SWC library.

Parameters:

library - SWC library

sourceDir - directory that contains the source for the SWC library

getAttachedSourceDirectory

String getAttachedSourceDirectory(String libraryFilename)

Get the Directory for the specified library.

Returns:

Full path to the specified library, or null if there is no attached source directory for the specified library.

invalidateLibraries

boolean invalidateLibraries(Collection<File> swcFiles)

Removes any calculated data related to a collection of libraries. Used by incremental compilation when swc files have been modified.

Parameters:

swcFiles - Collection of SWC files to invalidate.

Returns:

true if a library referenced by this project was invalidated

invalidateLibrary

void invalidateLibrary(ISWC swc)

Removes any calculated data related to a SWC. Used by incremental compilation when library projects have changed

Parameters:

swc - ISWC to invalidate

getDependingProjects

Set<IASProject> getDependingProjects()

Returns:

Set of projects which depend on this project

addProjectDependeny

void addProjectDependeny(IASProject project,
                       String swcFilename)

Adds a new project dependency to this project.

Parameters:

project - IASProject dependency to add to this project.

swcFilename - The SWC filename the project dependency generates

removeProjectDependeny

void removeProjectDependeny(IASProject project)

Removes a project dependency from this project.

Parameters:

project - IASProject to remove from this projects dependencies.

setDependencies

void setDependencies(Map<IASProject,String> dependencies)

Resets the set of projects that this project depends on.

Parameters:

dependencies - The new map of IASProjects that this project depends on. The value to the map is the SWC filename the IASProject generates.

setLibraries

void setLibraries(List<File> libraries)

The libraries used to compile source files in a project. The order of the libraries sets the priority of class definitions when name and the timestamp of a class are equal. Libraries at the beginning of the list have a higher priority than libraries at the end of the list.

Parameters:

libraries - The libraries in priority order, may not be null.

getLibraries

List<ISWC> getLibraries()

The libraries available to compiler source in this project.

Returns:

the libraries are returned in priority order from highest to lowest. The list may not be modified.

getCompatibilityVersion

Integer getCompatibilityVersion()

Returns the compatibility version encoded as an integer.

Returns:

the compatibility version encoded as an integer. Null if compatibility version has not been set.

getCompatibilityVersionString

String getCompatibilityVersionString()

Returns the compatibility version encoded as a string.

Returns:

the compatibility version encoded as a string. Null if compatibility version has not been set.

createInvisibleCompilationUnit

IInvisibleCompilationUnit createInvisibleCompilationUnit(String absoluteFileName,
                                                       IFileSpecificationGetter fileSpecGetter)

Creates an IInvisibleCompilationUnit for the specified absolute file name.

Parameters:

absoluteFileName - The name of the file to create an IInvisibleCompilationUnit for.

fileSpecGetter - A IFileSpecificationGetter that can be used by the new IInvisibleCompilationUnit to open files.

Returns:

A new IInvisibleCompilationUnit or null if the specified. file name is not found on the current source path of this IASProject.

createInvisibleCompilationUnit

IInvisibleCompilationUnit createInvisibleCompilationUnit(String rootSourceFile,
                                                       IFileSpecificationGetter fileSpecGetter,
                                                       String qName)

Creates an IInvisibleCompilationUnit for the specified absolute file name, specifying a qualified name. This version of createInvisibleCompilationUnit() is called when creating a IInvisibleCompilationUnit for a source file which isn't contained within the source path, as the qualified name of the IInvisibleCompilationUnit to be created can't be computed automatically. This happens when creating a IInvisibleCompilationUnit for an external file.

Parameters:

rootSourceFile - The name of the file to create an IInvisibleCompilationUnit for.

fileSpecGetter - A IFileSpecificationGetter that can be used by the new IInvisibleCompilationUnit to open files.

qName - The qualified name of the IInvisibleCompilationUnit

Returns:

A new IInvisibleCompilationUnit or null if the specified. file name is not found on the current source path of this IASProject.

isSupportedSourceFileType

boolean isSupportedSourceFileType(String fileExtension)

Determines if the specified file extension ( without the dot eg: as, not .as ) corresponds to a source file type that this project can create ICompilationUnits for.

Parameters:

fileExtension - The file extension to check without a dot, for example mxml.

Returns:

true if the file type associated with the specified file extension is supported by this project, false otherwise.

getSourceFileFromSourcePath

String getSourceFileFromSourcePath(String file)

Iterate through the source path list looking for the specified file.

Parameters:

file - filename to look for

Returns:

Absolute path to the file, or null if file not found