flex2.tools.oem.internal

Class LinkerConfiguration

java.lang.Object

flex2.compiler.common.Configuration

flex2.tools.ToolsConfiguration

flex2.tools.oem.internal.LinkerConfiguration

All Implemented Interfaces:

LinkerConfiguration, Cloneable

public class LinkerConfiguration
extends ToolsConfiguration
implements LinkerConfiguration

A configuration that extends ToolsConfiguration by adding link specific options.

Version:

2.0.1

Author:

Clement Wong

Nested Class Summary

Nested classes/interfaces inherited from class flex2.tools.ToolsConfiguration

ToolsConfiguration.BadAS3ESCombination, ToolsConfiguration.BadESStrictCombination, ToolsConfiguration.DeprecatedConfigurationOption

Nested classes/interfaces inherited from class flex2.compiler.common.Configuration

Configuration.RslPathInfo

Field Summary

Fields inherited from class flex2.tools.ToolsConfiguration

output

Fields inherited from class flex2.compiler.common.Configuration

configResolver, generateFrameLoader

Constructor Summary

Constructors

Constructor and Description
LinkerConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
int	backgroundColor()
boolean	debug() Generate SWFs for debugging.
String	debugPassword() The password to include in debuggable swfs.
int	defaultHeight()
int	defaultWidth()
boolean	generateLinkReport()
boolean	generateSizeReport()
static Map<String,String>	getAliases()
int	getCompatibilityVersion()
String	getCompatibilityVersionString() The compatibility version specified in the configuration.
boolean	getComputeDigest()
Set<String>	getExterns()
List<FramesConfiguration.FrameInfo>	getFrameList()
int	getFrameRate()
Set<String>	getIncludes()
String	getLinkReportFileName()
String	getMainDefinition()
String	getMetadata()
String[]	getMetadataToKeep() Includes user specified metadata and extra metadata added by the linker.
String	getOutput()
String	getRBListFileName()
SortedSet<String>	getResourceBundles()
String	getRootClassName()
int	getScriptRecursionLimit()
int	getScriptTimeLimit()
int	getSwfVersion()
String	getTargetFile()
int	getTargetPlayerMajorVersion()
int	getTargetPlayerMinorVersion()
int	getTargetPlayerRevision()
Set<String>	getUnresolved()
String	height() SWF height
String	heightPercent() SWF height percentage
void	keepLinkReport(boolean b)
void	keepSizeReport(boolean b)
boolean	lazyInit()
boolean	optimize()
String	pageTitle() browser page title
boolean	scriptLimitsSet()
void	setMainDefinition(String mainDefinition)
void	setOriginalConfiguration(LinkerConfiguration original, Set args, Set<String> includes, Set<String> excludes)
void	setRootClassName(String rootClassName)
boolean	useNetwork()
void	validate(ConfigurationBuffer cfgbuf)
boolean	verboseStacktraces()
String	width() SWF width
String	widthPercent() SWF width percentage

Methods inherited from class flex2.tools.ToolsConfiguration

cfgDumpConfig, cfgWarnings, getDumpConfig, getDumpConfigInfo, getLicenseFile, getWarnings, getWarningsInfo

Methods inherited from class flex2.compiler.common.Configuration

addCSSArchiveFiles, addExterns, addExterns, addIncludes, addL10nArchiveFiles, benchmark, cfgBenchmark, cfgBenchmarkCompilerDetails, cfgBenchmarkTimeFilter, cfgDebugPassword, cfgDefaultBackgroundColor, cfgDefaultFrameRate, cfgDefaultScriptLimits, cfgDefaultSize, cfgExterns, cfgFramework, cfgGenerateFrameLoader, cfgIncludeInheritanceDependenciesOnly, cfgIncludes, cfgLazyInit, cfgLinkReport, cfgLoadExterns, cfgRawMetadata, cfgRemoveUnusedRsls, cfgResourceBundleList, cfgRuntimeSharedLibraries, cfgRuntimeSharedLibraryPath, cfgSizeReport, cfgStaticLinkRuntimeSharedLibraries, cfgSwcChecksum, cfgSwfVersion, cfgTargetPlayer, cfgUseDirectBlit, cfgUseGpu, cfgUseNetwork, cfgVerifyDigests, clone, generateRBList, getAdvancedTelemetry, getAllExcludedLibraries, getBenchmarkCompilerDetails, getBenchmarkCompilerDetailsInfo, getBenchmarkInfo, getBenchmarkTimeFilter, getBenchmarkTimeFilterInfo, getCompilerConfiguration, getCSSArchiveFiles, getDebugPasswordInfo, getDefaultBackgroundColorInfo, getDefaultFrameRateInfo, getDefaultScriptLimitsInfo, getDefaultSizeInfo, getExternsInfo, getFramesConfiguration, getFramework, getGenerateFrameLoaderInfo, getIncludeInheritanceDependenciesOnly, getIncludeInheritanceDependenciesOnlyInfo, getIncludesInfo, getL10NArchiveFiles, getLazyInitInfo, getLicensesConfiguration, getLinkReportInfo, getLoadExternsInfo, getMetadataConfiguration, getMinimumSupportedVersion, getMinimumSupportedVersionString, getOutputPath, getQualifiedTypeSelectors, getRawMetadataInfo, getRemoveUnusedRsls, getRemoveUnusedRslsInfo, getResourceBundleListInfo, getRslExcludedLibraries, getRslPathInfo, getRuntimeSharedLibraries, getRuntimeSharedLibrariesInfo, getRuntimeSharedLibraryPathInfo, getRuntimeSharedLibrarySettingsConfiguration, getSizeReportFileName, getSizeReportInfo, getStaticLinkRsl, getSwcChecksumInfo, getTargetPlayerInfo, getTargetPlayerRequiredUseNamespaces, getTargetPlayerRequiredUseNamespaces, getTargetPlayerTargetAVM, getTargetPlayerTargetAVM, getUseDirectBlit, getUseGpu, getVerifyDigests, getVerifyDigestsInfo, isSwcChecksumEnabled, removeExterns, setAdvancedTelemetry, setBackgroundColor, setConfigPathResolver, setDebug, setDebugPassword, setFrameRate, setHeight, setHeightPercent, setOptimize, setOverrideStaticLinkRsl, setPageTitle, setScriptRecursionLimit, setScriptTimeLimit, setSwfVersion, setUseDirectBlit, setUseGpu, setWidth, setWidthPercent, toQNameString

Methods inherited from class java.lang.Object

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

Methods inherited from interface flex2.linker.LinkerConfiguration

generateRBList, getAdvancedTelemetry, getIncludeInheritanceDependenciesOnly, getMinimumSupportedVersion, getMinimumSupportedVersionString, getSizeReportFileName, getUseDirectBlit, getUseGpu

Constructor Detail

LinkerConfiguration

public LinkerConfiguration()

Method Detail

getAliases

public static Map<String,String> getAliases()

validate

public void validate(ConfigurationBuffer cfgbuf)
              throws ConfigurationException

Overrides:

validate in class ToolsConfiguration

Throws:

ConfigurationException

setOriginalConfiguration

public void setOriginalConfiguration(LinkerConfiguration original,
                            Set args,
                            Set<String> includes,
                            Set<String> excludes)

backgroundColor

public int backgroundColor()

Specified by:

backgroundColor in interface LinkerConfiguration

Overrides:

backgroundColor in class Configuration

debugPassword

public String debugPassword()

Description copied from class: Configuration

The password to include in debuggable swfs.

Specified by:

debugPassword in interface LinkerConfiguration

Overrides:

debugPassword in class Configuration

defaultHeight

public int defaultHeight()

Specified by:

defaultHeight in interface LinkerConfiguration

Overrides:

defaultHeight in class Configuration

defaultWidth

public int defaultWidth()

Specified by:

defaultWidth in interface LinkerConfiguration

Overrides:

defaultWidth in class Configuration

debug

public boolean debug()

Description copied from interface: LinkerConfiguration

Generate SWFs for debugging.

Specified by:

debug in interface LinkerConfiguration

Overrides:

debug in class Configuration

getExterns

public Set<String> getExterns()

Specified by:

getExterns in interface LinkerConfiguration

Overrides:

getExterns in class Configuration

Returns:

set of configured external symbols

getFrameList

public List<FramesConfiguration.FrameInfo> getFrameList()

Specified by:

getFrameList in interface LinkerConfiguration

Overrides:

getFrameList in class Configuration

Returns:

list of frame classes

getFrameRate

public int getFrameRate()

Specified by:

getFrameRate in interface LinkerConfiguration

Overrides:

getFrameRate in class Configuration

getIncludes

public Set<String> getIncludes()

Specified by:

getIncludes in interface LinkerConfiguration

Overrides:

getIncludes in class Configuration

Returns:

set of symbols to always include

getLinkReportFileName

public String getLinkReportFileName()

Specified by:

getLinkReportFileName in interface LinkerConfiguration

Overrides:

getLinkReportFileName in class Configuration

Returns:

name of compile report file, null if none

getMainDefinition

public String getMainDefinition()

Specified by:

getMainDefinition in interface LinkerConfiguration

Overrides:

getMainDefinition in class Configuration

getMetadata

public String getMetadata()

Specified by:

getMetadata in interface LinkerConfiguration

Overrides:

getMetadata in class Configuration

getRBListFileName

public String getRBListFileName()

Specified by:

getRBListFileName in interface LinkerConfiguration

Overrides:

getRBListFileName in class Configuration

Returns:

name of resource bundle list file, null if none

getResourceBundles

public SortedSet<String> getResourceBundles()

Specified by:

getResourceBundles in interface LinkerConfiguration

Overrides:

getResourceBundles in class Configuration

Returns:

set of resource bundles for resource bundle list

getRootClassName

public String getRootClassName()

Specified by:

getRootClassName in interface LinkerConfiguration

Overrides:

getRootClassName in class Configuration

Returns:

the name of the root SWF class

getScriptRecursionLimit

public int getScriptRecursionLimit()

Specified by:

getScriptRecursionLimit in interface LinkerConfiguration

Overrides:

getScriptRecursionLimit in class Configuration

getScriptTimeLimit

public int getScriptTimeLimit()

Specified by:

getScriptTimeLimit in interface LinkerConfiguration

Overrides:

getScriptTimeLimit in class Configuration

getUnresolved

public Set<String> getUnresolved()

Specified by:

getUnresolved in interface LinkerConfiguration

Overrides:

getUnresolved in class Configuration

Returns:

set of symbols that were not resolved (includes any referenced externs)

height

public String height()

Description copied from interface: LinkerConfiguration

SWF height

Specified by:

height in interface LinkerConfiguration

Overrides:

height in class Configuration

heightPercent

public String heightPercent()

Description copied from interface: LinkerConfiguration

SWF height percentage

Specified by:

heightPercent in interface LinkerConfiguration

Overrides:

heightPercent in class Configuration

verboseStacktraces

public boolean verboseStacktraces()

Specified by:

verboseStacktraces in interface LinkerConfiguration

Overrides:

verboseStacktraces in class Configuration

lazyInit

public boolean lazyInit()

Specified by:

lazyInit in interface LinkerConfiguration

Overrides:

lazyInit in class Configuration

optimize

public boolean optimize()

Specified by:

optimize in interface LinkerConfiguration

Overrides:

optimize in class Configuration

pageTitle

public String pageTitle()

Description copied from interface: LinkerConfiguration

browser page title

Specified by:

pageTitle in interface LinkerConfiguration

Overrides:

pageTitle in class Configuration

scriptLimitsSet

public boolean scriptLimitsSet()

Specified by:

scriptLimitsSet in interface LinkerConfiguration

Overrides:

scriptLimitsSet in class Configuration

getSwfVersion

public int getSwfVersion()

Specified by:

getSwfVersion in interface LinkerConfiguration

Overrides:

getSwfVersion in class Configuration

Returns:

The version of the generated SWF file.

setMainDefinition

public void setMainDefinition(String mainDefinition)

Specified by:

setMainDefinition in interface LinkerConfiguration

Overrides:

setMainDefinition in class Configuration

Parameters:

mainDefinition - the name of the app class to instantiate

setRootClassName

public void setRootClassName(String rootClassName)

Specified by:

setRootClassName in interface LinkerConfiguration

Overrides:

setRootClassName in class Configuration

Parameters:

rootClassName - the name of the root SWF class

useNetwork

public boolean useNetwork()

Specified by:

useNetwork in interface LinkerConfiguration

Overrides:

useNetwork in class Configuration

width

public String width()

Description copied from interface: LinkerConfiguration

SWF width

Specified by:

width in interface LinkerConfiguration

Overrides:

width in class Configuration

widthPercent

public String widthPercent()

Description copied from interface: LinkerConfiguration

SWF width percentage

Specified by:

widthPercent in interface LinkerConfiguration

Overrides:

widthPercent in class Configuration

keepLinkReport

public void keepLinkReport(boolean b)

generateLinkReport

public boolean generateLinkReport()

Specified by:

generateLinkReport in interface LinkerConfiguration

Overrides:

generateLinkReport in class Configuration

keepSizeReport

public void keepSizeReport(boolean b)

generateSizeReport

public boolean generateSizeReport()

Specified by:

generateSizeReport in interface LinkerConfiguration

Overrides:

generateSizeReport in class Configuration

getMetadataToKeep

public String[] getMetadataToKeep()

Description copied from class: Configuration

Includes user specified metadata and extra metadata added by the linker.

Specified by:

getMetadataToKeep in interface LinkerConfiguration

Overrides:

getMetadataToKeep in class Configuration

Returns:

the as3 metadata to keep

getComputeDigest

public boolean getComputeDigest()

Specified by:

getComputeDigest in interface LinkerConfiguration

Overrides:

getComputeDigest in class Configuration

Returns:

true if the digest should be computed, false otherwise.

getCompatibilityVersionString

public String getCompatibilityVersionString()

Description copied from class: Configuration

The compatibility version specified in the configuration.

Specified by:

getCompatibilityVersionString in interface LinkerConfiguration

Overrides:

getCompatibilityVersionString in class Configuration

getCompatibilityVersion

public int getCompatibilityVersion()

Specified by:

getCompatibilityVersion in interface LinkerConfiguration

Overrides:

getCompatibilityVersion in class Configuration

getOutput

public String getOutput()

Overrides:

getOutput in class ToolsConfiguration

getTargetFile

public String getTargetFile()

Specified by:

getTargetFile in class ToolsConfiguration

getTargetPlayerMajorVersion

public int getTargetPlayerMajorVersion()

Specified by:

getTargetPlayerMajorVersion in interface LinkerConfiguration

Overrides:

getTargetPlayerMajorVersion in class Configuration

Returns:

The major version of the player targeted by this application. The returned value will be greater to or equal to 9.

getTargetPlayerMinorVersion

public int getTargetPlayerMinorVersion()

Specified by:

getTargetPlayerMinorVersion in interface LinkerConfiguration

Overrides:

getTargetPlayerMinorVersion in class Configuration

Returns:

The minor version of the player targeted by this application. The returned value will be greater to or equal to 0.

getTargetPlayerRevision

public int getTargetPlayerRevision()

Specified by:

getTargetPlayerRevision in interface LinkerConfiguration

Overrides:

getTargetPlayerRevision in class Configuration

Returns:

The revision of the player targeted by this application. The returned value will be greater to or equal to 0.