org.apache.flex.compiler.internal.units

Class SourceCompilationUnitFactory

java.lang.Object

org.apache.flex.compiler.internal.units.SourceCompilationUnitFactory

public class SourceCompilationUnitFactory
extends Object

Factory that can create ICompilationUnit's given File's.

Constructor Summary

Constructors

Constructor and Description
SourceCompilationUnitFactory(CompilerProject project)

Method Summary

Methods

Modifier and Type	Method and Description
void	addHandler(ISourceFileHandler handler) Registers a new handler with the factory.
boolean	canCreateCompilationUnit(File file) Determines if there is a registered handler that can handle the specified File.
boolean	canCreateCompilationUnitForFileType(String fileExtensionWithoutDot) Determines if there is a registered handler for the file type associated with the specified file extension ( without the dot eg: as, not .as ).
boolean	canCreateInvisibleCompilationUnit(File file) Determines if an invisible ICompilationUnit can be created for the specified file.
ICompilationUnit	createCompilationUnit(File file, DefinitionPriority.BasePriority basePriority, int order, String qname, String locale) Constructs an ICompilationUnit that can process the specified file, if there is a registered handler that can handle the specified file.
String[]	getHandledFileExtensions() Utility method to get an array of all file extensions for which there is a handler.
boolean	needCompilationUnit(File file, String qname, String locale) Determines if a ICompilationUnit is needed for the specified file, qualified name, and locale.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SourceCompilationUnitFactory

public SourceCompilationUnitFactory(CompilerProject project)

Method Detail

addHandler

public void addHandler(ISourceFileHandler handler)

Registers a new handler with the factory.

Parameters:

handler - Handler to register.

canCreateCompilationUnitForFileType

public boolean canCreateCompilationUnitForFileType(String fileExtensionWithoutDot)

Determines if there is a registered handler for the file type associated with the specified file extension ( without the dot eg: as, not .as ).

Parameters:

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

Returns:

true if there is a registered handler for the file type associated with the specified file extension, false otherwise.

canCreateCompilationUnit

public boolean canCreateCompilationUnit(File file)

Determines if there is a registered handler that can handle the specified File.

Parameters:

file - A file.

Returns:

true if a ICompilationUnit can be constructed for the specified File.

needCompilationUnit

public boolean needCompilationUnit(File file,
                          String qname,
                          String locale)

Determines if a ICompilationUnit is needed for the specified file, qualified name, and locale.

This method will return false for resource bundles when the project does has an empty locale list.

Returns:

true if a ICompilationUnit is needed, false otherwise.

createCompilationUnit

public ICompilationUnit createCompilationUnit(File file,
                                     DefinitionPriority.BasePriority basePriority,
                                     int order,
                                     String qname,
                                     String locale)

Constructs an ICompilationUnit that can process the specified file, if there is a registered handler that can handle the specified file.

Parameters:

file - A file.

basePriority - DefinitionPriority.BasePriority used to determine if definitions defined by the new ICompilationUnit shadow definitions defined by other ICompilationUnits.

order - The index of the entry in the source path or source list that is causing this method to be called.

locale - locale of the file if the file is locale dependent or null if the file is not locale dependent.

Returns:

New ICompilationUnit or null if there is no handler that can handle the specified file or the handler decides to return null.

getHandledFileExtensions

public String[] getHandledFileExtensions()

Utility method to get an array of all file extensions for which there is a handler.

Returns:

array of handled extensions

canCreateInvisibleCompilationUnit

public boolean canCreateInvisibleCompilationUnit(File file)

Determines if an invisible ICompilationUnit can be created for the specified file.

Parameters:

file - A file.

Returns:

true if an invisible ICompilationUnit can be created for the specified file, false otherwise.