org.apache.flex.compiler.internal.units

Class ResourceBundleCompilationUnit

java.lang.Object

org.apache.flex.compiler.internal.units.CompilationUnitBase

org.apache.flex.compiler.internal.units.ResourceBundleCompilationUnit

All Implemented Interfaces:

ICompilationUnit

public class ResourceBundleCompilationUnit
extends CompilationUnitBase

This is a compilation unit that handles .properties file compilation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flex.compiler.units.ICompilationUnit

ICompilationUnit.Operation, ICompilationUnit.UnitType

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOCALE Parent folder name for properties files in a swc.

Fields inherited from class org.apache.flex.compiler.internal.units.CompilationUnitBase

abc, DEFAULT_DO_ABC_TAG_NAME, fileScopeRequest, problems, syntaxTreeRequest

Constructor Summary

Constructors

Constructor and Description
ResourceBundleCompilationUnit(CompilerProject project, ISWCFileEntry fileEntry, String qname, String locale) Constructor.
ResourceBundleCompilationUnit(CompilerProject project, String path, DefinitionPriority.BasePriority basePriority, String qname, String locale) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	getBundleNameInColonSyntax() Returns the name of the bundle processed by this compilation unit.
ICompilationUnit.UnitType	getCompilationUnitType()
byte[]	getFileContent(Collection<ICompilerProblem> problems) Returns the content of the file processed by this compilation unit.
long	getFileLastModified() Get the time-stamp of the properties file processed by this compilation unit.
String	getLocale() Returns the locale of the properties file associated with this compilation unit depends on or null if the file is not locale dependent.
protected IABCBytesRequestResult	handleABCBytesRequest() Builds a IABCBytesRequestResult.
protected IFileScopeRequestResult	handleFileScopeRequest() Builds a IFileScopeRequestResult.
protected IOutgoingDependenciesRequestResult	handleOutgoingDependenciesRequest() Builds a IOutgoingDependenciesRequestResult.
protected ISWFTagsRequestResult	handleSWFTagsRequest() Builds a ISWFTagsRequestResult.
protected ISyntaxTreeRequestResult	handleSyntaxTreeRequest() Builds a ISyntaxTreeRequestResult.
void	startBuildAsync(ITarget.TargetType targetType) This method starts to build the compilation unit asynchronously.
void	waitForBuildFinish(Collection<ICompilerProblem> problems, ITarget.TargetType targetType) Wait till the compilation unit finishes building, and collect compiler problems.

Methods inherited from class org.apache.flex.compiler.internal.units.CompilationUnitBase

addScopeToProjectScope, clean, clearIncludedFilesFromWorkspace, clearProject, getABCBytesRequest, getAbsoluteFilename, getDefinitionPriority, getDefinitionPromises, getEmbeddedFilenames, getEncodedDebugFiles, getFilenameNoPath, getFileScopeRequest, getFileSpecificationGetter, getName, getOutgoingDependenciesRequest, getProject, getQualifiedNames, getRootFileSpecification, getShortNames, getSWFTagsRequest, getSyntaxTreeRequest, handleClean, isInvisible, makeInvisible, operationsCompleted, removeAST, setFileSpecificationGetter, startParsingImports, startProfile, stopProfile, toString, updateEmbedCompilationUnitDependencies, updateStyleCompilationUnitDependencies, verifyAST

Methods inherited from class java.lang.Object

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

Field Detail

LOCALE

public static final String LOCALE

Parent folder name for properties files in a swc. We read properties files off of this folder while reading a swc and copy them into this folder while writing a swc.

See Also:

Constant Field Values

Constructor Detail

ResourceBundleCompilationUnit

public ResourceBundleCompilationUnit(CompilerProject project,
                             String path,
                             DefinitionPriority.BasePriority basePriority,
                             String qname,
                             String locale)

Constructor.

Parameters:

project - project this compilation unit is associated with

path - path of the properties file

basePriority - base priority

qname - qualified name for the properties file that will be processed by this comp unit

locale - the locale this compilation unit depends on or null if the compilation unit is not locale dependent

ResourceBundleCompilationUnit

public ResourceBundleCompilationUnit(CompilerProject project,
                             ISWCFileEntry fileEntry,
                             String qname,
                             String locale)

Constructor. This constructor should be used for properties files that come from a swc.

Parameters:

project - project this compilation unit is associated with

fileEntry - swc entry for the properties file that will be processed by this compilation unit

qname - qualified name for the properties file that will be processed by this comp unit

locale - the locale this compilation unit depends on or null if the compilation unit is not locale dependent

Method Detail

getCompilationUnitType

public ICompilationUnit.UnitType getCompilationUnitType()

Returns:

the compilation unit type

getBundleNameInColonSyntax

public String getBundleNameInColonSyntax()

Returns the name of the bundle processed by this compilation unit. Bundle name is the qualified name that is used when referencing this bundle in action script. For qualified names, "colon syntax" is used such as foo.bar:xyz for "../foo/bar/xyz.properties" file.

Returns:

the name of the bundle processed by this compilation unit

getLocale

public String getLocale()

Returns the locale of the properties file associated with this compilation unit depends on or null if the file is not locale dependent.

Returns:

the locale this compilation unit depends on or null if the compilation unit is not locale dependent.

handleSyntaxTreeRequest

protected ISyntaxTreeRequestResult handleSyntaxTreeRequest()
                                                    throws InterruptedException

Description copied from class: CompilationUnitBase

Builds a ISyntaxTreeRequestResult. In many cases the ISyntaxTreeRequestResult is built by parsing a source file into a syntax tree.

Called by this class from potentially any thread. This class guarantees that this method will only be entered from one thread at a time for a given instance of this class, so implementations do not need to make this a synchronized method.

Specified by:

handleSyntaxTreeRequest in class CompilationUnitBase

Returns:

The ISyntaxTreeRequestResult for this compilation unit.

Throws:

InterruptedException

handleFileScopeRequest

protected IFileScopeRequestResult handleFileScopeRequest()
                                                  throws InterruptedException

Description copied from class: CompilationUnitBase

Builds a IFileScopeRequestResult. In many cases the IFileScopeRequestResult is built by walking an AST produced by a parser.

Called by this class from potentially any thread. This class guarantees that this method will only be entered from one thread at a time for a given instance of this class, so implementations do not need to make this a synchronized method.

Specified by:

handleFileScopeRequest in class CompilationUnitBase

Returns:

The IFileScopeRequestResult for this compilation unit.

Throws:

InterruptedException

handleABCBytesRequest

protected IABCBytesRequestResult handleABCBytesRequest()
                                                throws InterruptedException

Description copied from class: CompilationUnitBase

Builds a IABCBytesRequestResult. In many cases the IABCBytesRequestResult is built running a code generator over an AST produced by a parser.

Called by this class from potentially any thread. This class guarantees that this method will only be entered from one thread at a time for a given instance of this class, so implementations do not need to make this a synchronized method.

Specified by:

handleABCBytesRequest in class CompilationUnitBase

Returns:

The IABCBytesRequestResult for this compilation unit.

Throws:

InterruptedException

handleSWFTagsRequest

protected ISWFTagsRequestResult handleSWFTagsRequest()
                                              throws InterruptedException

Description copied from class: CompilationUnitBase

Builds a ISWFTagsRequestResult. In many cases the ISWFTagsRequestResult is built getting the IABCBytesRequestResult and wrapping its abc bytes in a DoABCTag.

Called by this class from potentially any thread. This class guarantees that this method will only be entered from one thread at a time for a given instance of this class, so implementations do not need to make this a synchronized method.

Specified by:

handleSWFTagsRequest in class CompilationUnitBase

Returns:

The ISWFTagsRequestResult for this compilation unit.

Throws:

InterruptedException

handleOutgoingDependenciesRequest

protected IOutgoingDependenciesRequestResult handleOutgoingDependenciesRequest()
                                                                        throws InterruptedException

Description copied from class: CompilationUnitBase

Builds a IOutgoingDependenciesRequestResult. In many cases the IOutgoingDependenciesRequestResult is built getting the walking an AST.

Called by this class from potentially any thread. This class guarantees that this method will only be entered from one thread at a time for a given instance of this class, so implementations do not need to make this a synchronized method.

Specified by:

handleOutgoingDependenciesRequest in class CompilationUnitBase

Returns:

The IOutgoingDependenciesRequestResult for this compilation unit.

Throws:

InterruptedException

waitForBuildFinish

public void waitForBuildFinish(Collection<ICompilerProblem> problems,
                      ITarget.TargetType targetType)
                        throws InterruptedException

Description copied from interface: ICompilationUnit

Wait till the compilation unit finishes building, and collect compiler problems. After calling this method, this compilation unit will be in a fully compiled state.

Specified by:

waitForBuildFinish in interface ICompilationUnit

Overrides:

waitForBuildFinish in class CompilationUnitBase

Parameters:

problems - Problems from executing the requests.

targetType - type of the active Target

Throws:

InterruptedException - Concurrency error.

See Also:

ICompilationUnit.startBuildAsync(org.apache.flex.compiler.targets.ITarget.TargetType)

startBuildAsync

public void startBuildAsync(ITarget.TargetType targetType)

Description copied from interface: ICompilationUnit

This method starts to build the compilation unit asynchronously. It kicks off all the request methods on the compilation unit.

Specified by:

startBuildAsync in interface ICompilationUnit

Overrides:

startBuildAsync in class CompilationUnitBase

Parameters:

targetType - type of the active Target

getFileLastModified

public long getFileLastModified()

Get the time-stamp of the properties file processed by this compilation unit.

Returns:

time stamp in milliseconds from epoch time.

getFileContent

public byte[] getFileContent(Collection<ICompilerProblem> problems)

Returns the content of the file processed by this compilation unit.

Returns:

byte array that represents the content or null if any problem occurs.