org.apache.flex.compiler.internal.targets

Class LibrarySWFTarget

java.lang.Object

org.apache.flex.compiler.internal.targets.Target

org.apache.flex.compiler.internal.targets.SWFTarget

org.apache.flex.compiler.internal.targets.LibrarySWFTarget

All Implemented Interfaces:

ILibrarySWFTarget, ISWFTarget, ITarget

Direct Known Subclasses:

FlexLibrarySWFTarget

public class LibrarySWFTarget
extends SWFTarget
implements ILibrarySWFTarget

Class to build a library.swf for a SWC.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flex.compiler.internal.targets.SWFTarget

SWFTarget.FramesInformation, SWFTarget.SWFFrameInfo

Nested classes/interfaces inherited from class org.apache.flex.compiler.internal.targets.Target

Target.BuiltCompilationUnitSet, Target.DirectDependencies, Target.RootedCompilationUnits

Nested classes/interfaces inherited from interface org.apache.flex.compiler.targets.ITarget

ITarget.TargetType

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<ICompilationUnit>	rootedCompilationUnits

Fields inherited from class org.apache.flex.compiler.internal.targets.SWFTarget

metadataDonators

Fields inherited from class org.apache.flex.compiler.internal.targets.Target

progressMonitor, project, targetSettings

Constructor Summary

Constructors

Constructor and Description
LibrarySWFTarget(CompilerProject project, ITargetSettings targetSettings, Set<ICompilationUnit> rootedCompilationUnits)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addLinkedABCToFrame(SWFFrame targetFrame, Iterable<DoABCTag> inputABCs, ABCLinker.ABCLinkerSettings linkSettings)
protected SWFTarget.FramesInformation	computeFramesInformation() Create the SWFTarget.FramesInformation which contains the skeleton for the frames of this SWF.
protected ITargetAttributes	computeTargetAttributes() round-up user specified target attributes All derived classes must provide one, but they are free to provide "do nothing" implementations (like NilTargetAttributes)
protected void	doPostBuildWork(com.google.common.collect.ImmutableSet<ICompilationUnit> compilationUnits, Collection<ICompilerProblem> problems) Check the build and analyze the results before the SWF target is initialized.
String	getBaseClassQName() Get the qualified name of the base class of the root class.
com.google.common.collect.ImmutableSet<ICompilationUnit>	getCompilationUnits() Get the compilation units included in this SWF.
String	getRootClassName() Get the name of root class.
protected void	setKeepAS3MetadataLinkerSetting(ABCLinker.ABCLinkerSettings linkSettings)
protected boolean	shouldAddMetadataNamesToTarget(ICompilationUnit cu, boolean linkage) Test if any metadata names associated with the compilation unit should be added to the target.
protected boolean	testCompilationUnitLinkage(ICompilationUnit cu, boolean allowExternals) Test if a compilation unit should be include in this target.

Methods inherited from class org.apache.flex.compiler.internal.targets.SWFTarget

addCompilationUnitsAndDependenciesToFrame, build, buildEmptySWF, computeRootedCompilationUnits, computeTargetReport, createWithClassesAndItsDependencies, doAddMetadataNamesToTarget, getBackgroundColor, getFramesInformation, getRootedCompilationUnits, getTargetAttributes, getTargetType, initializeSWF, linkSWF, reportProblem

Methods inherited from class org.apache.flex.compiler.internal.targets.Target

addASMetadataNames, buildAllCompilationUnits, buildFinished, buildStarted, computeFatalProblems, createLinkReport, findAllCompilationUnitsToLink, getAllExternallyVisibleDefinitions, getASMetadataNames, getBuiltCompilationUnitSet, getDependentCompilationUnits, getDirectDependencies, getFatalProblems, getIncludedResourceBundlesCompilationUnits, getIncludeLibrariesCompilationUnits, getIncludesCompilationUnits, getLinkageChecker, getReachableCompilationUnits, getTargetReport, getTargetSettings, isCanceled, isLinkageExternal, setLinkageChecker, updateProgress, updateProgress, waitForCompilationUnitToFinish

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flex.compiler.targets.ISWFTarget

build

Methods inherited from interface org.apache.flex.compiler.targets.ITarget

getASMetadataNames, getIncludesCompilationUnits, getTargetReport, getTargetSettings, getTargetType

Field Detail

rootedCompilationUnits

protected final Set<ICompilationUnit> rootedCompilationUnits

Constructor Detail

LibrarySWFTarget

public LibrarySWFTarget(CompilerProject project,
                ITargetSettings targetSettings,
                Set<ICompilationUnit> rootedCompilationUnits)

Method Detail

computeTargetAttributes

protected ITargetAttributes computeTargetAttributes()
                                             throws InterruptedException

Description copied from class: SWFTarget

round-up user specified target attributes All derived classes must provide one, but they are free to provide "do nothing" implementations (like NilTargetAttributes)

Specified by:

computeTargetAttributes in class SWFTarget

Throws:

InterruptedException

computeFramesInformation

protected SWFTarget.FramesInformation computeFramesInformation()
                                                        throws InterruptedException

Description copied from class: SWFTarget

Create the SWFTarget.FramesInformation which contains the skeleton for the frames of this SWF. The actual frames will be create in doCreateFrames().

Specified by:

computeFramesInformation in class SWFTarget

Throws:

InterruptedException

getCompilationUnits

public com.google.common.collect.ImmutableSet<ICompilationUnit> getCompilationUnits()

Description copied from interface: ILibrarySWFTarget

Get the compilation units included in this SWF. This includes the rootedCompilationUnits plus their dependencies. The compilation units will be ready after a successful call to the build() method.

Specified by:

getCompilationUnits in interface ILibrarySWFTarget

Returns:

the set of compilation units included in this SWF.

getRootClassName

public String getRootClassName()

Description copied from interface: ILibrarySWFTarget

Get the name of root class.

Specified by:

getRootClassName in interface ILibrarySWFTarget

Returns:

name of the root class or null if the SWF does not have a root class.

getBaseClassQName

public String getBaseClassQName()

Description copied from interface: ILibrarySWFTarget

Get the qualified name of the base class of the root class.

Specified by:

getBaseClassQName in interface ILibrarySWFTarget

Returns:

The qualified name of the base class or null if there is no base class.

testCompilationUnitLinkage

protected boolean testCompilationUnitLinkage(ICompilationUnit cu,
                                 boolean allowExternals)
                                      throws InterruptedException

Description copied from class: SWFTarget

Test if a compilation unit should be include in this target.

Overrides:

testCompilationUnitLinkage in class SWFTarget

Returns:

True if the compilation should be included, false otherwise.

Throws:

InterruptedException

doPostBuildWork

protected void doPostBuildWork(com.google.common.collect.ImmutableSet<ICompilationUnit> compilationUnits,
                   Collection<ICompilerProblem> problems)
                        throws InterruptedException

Description copied from class: SWFTarget

Check the build and analyze the results before the SWF target is initialized.

Overrides:

doPostBuildWork in class SWFTarget

Parameters:

compilationUnits - The set of compilation units after buildAndCollectProblems() has run.

problems - A collection where discovered problems are appended.

Throws:

InterruptedException

shouldAddMetadataNamesToTarget

protected boolean shouldAddMetadataNamesToTarget(ICompilationUnit cu,
                                     boolean linkage)

Description copied from class: SWFTarget

Test if any metadata names associated with the compilation unit should be added to the target.

Overrides:

shouldAddMetadataNamesToTarget in class SWFTarget

linkage - true if the compilation unit is linked in, false if external.

Returns:

true if the metadata names should be included, false otherwise.

addLinkedABCToFrame

protected final void addLinkedABCToFrame(SWFFrame targetFrame,
                       Iterable<DoABCTag> inputABCs,
                       ABCLinker.ABCLinkerSettings linkSettings)
                                  throws Exception

Specified by:

addLinkedABCToFrame in class SWFTarget

Throws:

Exception

setKeepAS3MetadataLinkerSetting

protected void setKeepAS3MetadataLinkerSetting(ABCLinker.ABCLinkerSettings linkSettings)

Specified by:

setKeepAS3MetadataLinkerSetting in class SWFTarget