TargetSettings (Apache Flex - FlexJS: Compiler: Parent 0.8.0-SNAPSHOT API)

java.lang.Object
- org.apache.flex.compiler.internal.config.TargetSettings

All Implemented Interfaces:

ITargetSettings
```
public class TargetSettings
extends Object
implements ITargetSettings
```
Value object of ITargetSettings. The only way to create an instance of this object is by calling Configurator.getTargetSettings;

Constructor Summary

Constructors
Constructor and Description

TargetSettings(Configuration configuration)

Constructors
Constructor and Description
`TargetSettings(Configuration configuration)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`areDefaultScriptLimitsSet()` Returns if the default script limits have been set.
`boolean`	`areVerboseStacktracesEnabled()` Returns true if the target is capable of verbose stack traces.
`boolean`	`getAllowSubclassOverrides()`
`Collection<String>`	`getASMetadataNames()` The names of ActionScript metadata that will be preserved in the target.
`int`	`getDefaultBackgroundColor()` Returns the default background color.
`File`	`getDefaultCSS()` Returns the location of the default CSS file.
`int`	`getDefaultFrameRate()` Returns the default frame rate.
`int`	`getDefaultHeight()` Returns the default height.
`int`	`getDefaultScriptRecursionLimit()` Returns the default script recursion limit.
`int`	`getDefaultScriptTimeLimit()` Returns the default script time limit.
`List<String>`	`getDefaultsCSSFiles()`
`int`	`getDefaultWidth()` Returns the default width.
`Collection<File>`	`getExternalLibraryPath()` Returns a collection of libraries whose classes are not be linked into the target.
`Collection<String>`	`getExterns()` Returns a list of fully qualified class names that should not be linked into the target.
`String`	`getFlexMinimumSupportedVersion()` Used when creating a library.
`List<FrameInfo>`	`getFrameLabels()` A `List` of `FrameInfo` objects that describe extra frames of a SWF.
`Collection<String>`	`getIncludeClasses()` Returns a collection of fully-qualified class names that are included in the target library.
`Map<String,File>`	`getIncludeFiles()` Returns a collection of files that are included in the target library.
`Collection<File>`	`getIncludeLibraries()` Returns a collection of libraries whose classes are linked into the target.
`Collection<String>`	`getIncludeNamespaces()` Returns a collection of namespaces that are included in the target library.
`Collection<String>`	`getIncludeResourceBundles()` Returns a collection of resource bundle names that are included in the target library.
`Collection<String>`	`getIncludes()` Returns a list of fully qualified class names that should be linked into the target regardless of whether they are required by the target or not.
`Collection<File>`	`getIncludeSources()` Returns a collection of sources that are included in the target library.
`Map<String,File>`	`getIncludeStyleSheets()` Returns a map of style sheet names and files that are included in the target library.
`File`	`getLinkReport()` Returns the file that specifies where the link report should be written.
`boolean`	`getMxmlChildrenAsData()`
`String[]`	`getMxmlImplicitImports()` Gets the implicit imports for MXML.
`File`	`getOutput()` Returns the file that specifies where the target should be created.
`String`	`getPreloaderClassName()` Returns the preloader class name
`boolean`	`getRemoveDeadCode()`
`String`	`getRootClassName()` Returns the root class name for the application SWF.
`String`	`getRootSourceFileName()` Returns the absolute file name of the source file that defines the root class.
`List<String>`	`getRuntimeSharedLibraries()` A list of URLs pointing to RSLs to load.
`List<RSLSettings>`	`getRuntimeSharedLibraryPath()` A list of RSLs to load, complete with all the settings on how to load the RSLs.
`File`	`getSizeReport()` Returns the file that specifies where the size report should be written.
`String`	`getSWFMetadata()` Get the Metadata text.
`int`	`getSWFVersion()` Return the SWF version
`List<File>`	`getThemes()` Returns a list of CSS and SWC files to apply as a theme.
`boolean`	`isAccessible()` Returns true if the target file is accessible.
`boolean`	`isDebugEnabled()` Returns true if the target file has debugging instructions included.
`boolean`	`isIncludeLookupOnlyEnabled()` Returns true if only manifest entries with lookupOnly=true are included in the SWC catalog, false otherwise.
`boolean`	`isLinkageExternal(String path)` Determine is a library has external linkage.
`boolean`	`isOptimized()` Returns true if the target should be optimized.
`boolean`	`isTelemetryEnabled()` Returns true if the target file has advanced telemetry enabled.
`boolean`	`keepAllTypeSelectors()` Returns true if the compiler has disabled the pruning of unused type selectors.
`boolean`	`removeUnusedRuntimeSharedLibraryPaths()` Returns true if RSLs that have no classes used by the application are not loaded at runtime.
`boolean`	`useCompression()` Returns true if the target should be output using compression.
`boolean`	`useDirectBlit()` Returns whether the application SWF is flagged for direct blit use.
`boolean`	`useGPU()` Returns whether the application SWF is flagged for GPU use.
`boolean`	`useNetwork()` Returns whether the application SWF is flagged for access to network resources.
`boolean`	`useResourceBundleMetadata()` Returns true if resource bundle metadata should be processed.
`boolean`	`verifyDigests()` Returns the default setting for all RSLs as to whether an RSL's digest should be verified after the RSL is loaded.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TargetSettings
```
public TargetSettings(Configuration configuration)
```
- Method Detail
  - isAccessible
```
public boolean isAccessible()
```
    Description copied from interface: ITargetSettings
    
    Returns true if the target file is accessible.
    
    Specified by:
    
    isAccessible in interface ITargetSettings
    
    Returns:
    the accessible
  - isDebugEnabled
```
public boolean isDebugEnabled()
```
    Description copied from interface: ITargetSettings
    
    Returns true if the target file has debugging instructions included.
    
    Specified by:
    
    isDebugEnabled in interface ITargetSettings
    
    Returns:
    the debugEnabled
  - isTelemetryEnabled
```
public boolean isTelemetryEnabled()
```
    Description copied from interface: ITargetSettings
    
    Returns true if the target file has advanced telemetry enabled.
    
    Specified by:
    
    isTelemetryEnabled in interface ITargetSettings
    
    Returns:
    true if the target file has advanced telemetry enabled, false otherwise.
  - isOptimized
```
public boolean isOptimized()
```
    Description copied from interface: ITargetSettings
    
    Returns true if the target should be optimized.
    
    Specified by:
    
    isOptimized in interface ITargetSettings
    
    Returns:
    the optimized
  - useCompression
```
public boolean useCompression()
```
    Description copied from interface: ITargetSettings
    
    Returns true if the target should be output using compression.
    
    Specified by:
    
    useCompression in interface ITargetSettings
    
    Returns:
    the compressed
  - areVerboseStacktracesEnabled
```
public boolean areVerboseStacktracesEnabled()
```
    Description copied from interface: ITargetSettings
    
    Returns true if the target is capable of verbose stack traces.
    
    Specified by:
    
    areVerboseStacktracesEnabled in interface ITargetSettings
    
    Returns:
    the verboseStacktracesEnabled
  - keepAllTypeSelectors
```
public boolean keepAllTypeSelectors()
```
    Description copied from interface: ITargetSettings
    
    Returns true if the compiler has disabled the pruning of unused type selectors.
    
    Specified by:
    
    keepAllTypeSelectors in interface ITargetSettings
    
    Returns:
    the keepAllTypeSelectors
  - useNetwork
```
public boolean useNetwork()
```
    Description copied from interface: ITargetSettings
    
    Returns whether the application SWF is flagged for access to network resources.
    
    Specified by:
    
    useNetwork in interface ITargetSettings
    
    Returns:
    the useNetwork
  - removeUnusedRuntimeSharedLibraryPaths
```
public boolean removeUnusedRuntimeSharedLibraryPaths()
```
    Description copied from interface: ITargetSettings
    
    Returns true if RSLs that have no classes used by the application are not loaded at runtime.
    
    Specified by:
    
    removeUnusedRuntimeSharedLibraryPaths in interface ITargetSettings
    
    Returns:
    the removeUnusedRuntimeSharedLibraryPaths
  - verifyDigests
```
public boolean verifyDigests()
```
    Description copied from interface: ITargetSettings
    
    Returns the default setting for all RSLs as to whether an RSL's digest should be verified after the RSL is loaded. This setting may be overridden by setting the verify digest flag on an individual RSL. This is equivalent to using the verify-digests option in the mxmlc compiler.
    
    Specified by:
    
    verifyDigests in interface ITargetSettings
    
    Returns:
    the verifyDigests
    See Also:
    RSLSettings
  - useResourceBundleMetadata
```
public boolean useResourceBundleMetadata()
```
    Description copied from interface: ITargetSettings
    
    Returns true if resource bundle metadata should be processed.
    
    Specified by:
    
    useResourceBundleMetadata in interface ITargetSettings
    
    Returns:
    the useResourceBundleMetadata
  - isIncludeLookupOnlyEnabled
```
public boolean isIncludeLookupOnlyEnabled()
```
    Description copied from interface: ITargetSettings
    
    Returns true if only manifest entries with lookupOnly=true are included in the SWC catalog, false otherwise.
    
    Specified by:
    
    isIncludeLookupOnlyEnabled in interface ITargetSettings
    
    Returns:
    the includeLookupOnlyEnabled
  - getDefaultBackgroundColor
```
public int getDefaultBackgroundColor()
```
    Description copied from interface: ITargetSettings
    
    Returns the default background color.
    
    Specified by:
    
    getDefaultBackgroundColor in interface ITargetSettings
    
    Returns:
    the defaultBackgroundColor
  - getDefaultFrameRate
```
public int getDefaultFrameRate()
```
    Description copied from interface: ITargetSettings
    
    Returns the default frame rate.
    
    Specified by:
    
    getDefaultFrameRate in interface ITargetSettings
    
    Returns:
    the defaultFrameRate
  - areDefaultScriptLimitsSet
```
public boolean areDefaultScriptLimitsSet()
```
    Description copied from interface: ITargetSettings
    
    Returns if the default script limits have been set.
    
    Specified by:
    
    areDefaultScriptLimitsSet in interface ITargetSettings
    
    Returns:
    whether default script limits are set
  - getDefaultScriptTimeLimit
```
public int getDefaultScriptTimeLimit()
```
    Description copied from interface: ITargetSettings
    
    Returns the default script time limit.
    
    Specified by:
    
    getDefaultScriptTimeLimit in interface ITargetSettings
    
    Returns:
    the defaultScriptTimeLimit
  - getDefaultScriptRecursionLimit
```
public int getDefaultScriptRecursionLimit()
```
    Description copied from interface: ITargetSettings
    
    Returns the default script recursion limit.
    
    Specified by:
    
    getDefaultScriptRecursionLimit in interface ITargetSettings
    
    Returns:
    the defaultScriptRecursionLimit
  - getDefaultWidth
```
public int getDefaultWidth()
```
    Description copied from interface: ITargetSettings
    
    Returns the default width.
    
    Specified by:
    
    getDefaultWidth in interface ITargetSettings
    
    Returns:
    the defaultWidth
  - getDefaultHeight
```
public int getDefaultHeight()
```
    Description copied from interface: ITargetSettings
    
    Returns the default height.
    
    Specified by:
    
    getDefaultHeight in interface ITargetSettings
    
    Returns:
    the defaultHeight
  - getOutput
```
public File getOutput()
```
    Description copied from interface: ITargetSettings
    
    Returns the file that specifies where the target should be created.
    
    Specified by:
    
    getOutput in interface ITargetSettings
    
    Returns:
    the output
  - getASMetadataNames
```
public Collection<String> getASMetadataNames()
```
    Description copied from interface: ITargetSettings
    
    The names of ActionScript metadata that will be preserved in the target. If the target is a SWC, the metadata names to preserve will be recorded in the SWC's catalog. When the SWC is later linked into a target the metadata names will be appended to the list of metadata names preserved in the target.
    
    Specified by:
    
    getASMetadataNames in interface ITargetSettings
    
    Returns:
    the actionScriptMetadataNames
  - getDefaultCSS
```
public File getDefaultCSS()
```
    Description copied from interface: ITargetSettings
    
    Returns the location of the default CSS file.
    
    Specified by:
    
    getDefaultCSS in interface ITargetSettings
    
    Returns:
    the defaultCSS
  - getExterns
```
public Collection<String> getExterns()
```
    Description copied from interface: ITargetSettings
    
    Returns a list of fully qualified class names that should not be linked into the target.
    
    Specified by:
    
    getExterns in interface ITargetSettings
    
    Returns:
    the externs
  - getMxmlImplicitImports
```
public String[] getMxmlImplicitImports()
```
    Description copied from interface: ITargetSettings
    
    Gets the implicit imports for MXML.
    
    Specified by:
    
    getMxmlImplicitImports in interface ITargetSettings
    
    Returns:
    the implicitImports for MXML
  - getIncludes
```
public Collection<String> getIncludes()
```
    Description copied from interface: ITargetSettings
    
    Returns a list of fully qualified class names that should be linked into the target regardless of whether they are required by the target or not.
    
    Specified by:
    
    getIncludes in interface ITargetSettings
    
    Returns:
    the includes
  - getFrameLabels
```
public List<FrameInfo> getFrameLabels()
```
    Description copied from interface: ITargetSettings
    
    A List of FrameInfo objects that describe extra frames of a SWF. Each frame label has a list of class names that will be linked onto the frame.
    
    Specified by:
    
    getFrameLabels in interface ITargetSettings
    
    Returns:
    the frameLabels
  - getSWFMetadata
```
public String getSWFMetadata()
```
    Description copied from interface: ITargetSettings
    
    Get the Metadata text. This is a Metadata property.
    The Metadata tag is an optional tag to describe the SWF file to an external process. The tag embeds XML metadata in the SWF file so that, for example, a search engine can locate this tag, access a title for the SWF file, and display that title in search results.
    
    Specified by:
    
    getSWFMetadata in interface ITargetSettings
    
    Returns:
    the swfMetadata
  - getSWFVersion
```
public int getSWFVersion()
```
    Description copied from interface: ITargetSettings
    
    Return the SWF version
    
    Specified by:
    
    getSWFVersion in interface ITargetSettings
    
    Returns:
    the SWF version
  - getPreloaderClassName
```
public String getPreloaderClassName()
```
    Description copied from interface: ITargetSettings
    
    Returns the preloader class name
    
    Specified by:
    
    getPreloaderClassName in interface ITargetSettings
    
    Returns:
    the preloader class name
  - getRootSourceFileName
```
public String getRootSourceFileName()
```
    Description copied from interface: ITargetSettings
    
    Returns the absolute file name of the source file that defines the root class. If ITargets using this ITargetSettings do not build SWFs ( they could build SWCs instead ), then this method will return null.
    
    Specified by:
    
    getRootSourceFileName in interface ITargetSettings
    
    Returns:
    absolute file name of the source file that defines the root class, or null if this ITargetSettings is not for building SWFs.
  - getRootClassName
```
public String getRootClassName()
```
    Description copied from interface: ITargetSettings
    
    Returns the root class name for the application SWF. If ITargets using this ITargetSettings do not build SWFs ( they could build SWCs instead ), then this method will return null.
    
    Specified by:
    
    getRootClassName in interface ITargetSettings
    
    Returns:
    the rootClassName
  - getThemes
```
public List<File> getThemes()
```
    Description copied from interface: ITargetSettings
    
    Returns a list of CSS and SWC files to apply as a theme.
    
    Specified by:
    
    getThemes in interface ITargetSettings
    
    Returns:
    the themes
  - getExternalLibraryPath
```
public Collection<File> getExternalLibraryPath()
```
    Description copied from interface: ITargetSettings
    
    Returns a collection of libraries whose classes are not be linked into the target.
    
    Specified by:
    
    getExternalLibraryPath in interface ITargetSettings
    
    Returns:
    the externalLibraryPath
  - getIncludeLibraries
```
public Collection<File> getIncludeLibraries()
```
    Description copied from interface: ITargetSettings
    
    Returns a collection of libraries whose classes are linked into the target. All the of classes in each library are linked into the application regardless of whether the classes is referenced by the target.
    
    Specified by:
    
    getIncludeLibraries in interface ITargetSettings
    
    Returns:
    the includeLibraries
  - getRuntimeSharedLibraries
```
public List<String> getRuntimeSharedLibraries()
```
    Description copied from interface: ITargetSettings
    
    A list of URLs pointing to RSLs to load. The RSLs will be loaded in the order that they appear in the list. This is equivalent to using the runtime-shared-libraries option in the mxmlc compiler. These RSLs are available to support legacy applications. For the latest RSL support see getRuntimeSharedLibraryPath.
    
    Specified by:
    
    getRuntimeSharedLibraries in interface ITargetSettings
    
    Returns:
    the runtimeSharedLibraries
  - getRuntimeSharedLibraryPath
```
public List<RSLSettings> getRuntimeSharedLibraryPath()
```
    Description copied from interface: ITargetSettings
    
    A list of RSLs to load, complete with all the settings on how to load the RSLs. The RSLs will be loaded in the order that they appear in the list. This is the complete list of RSLs that could possibly be loaded. This list could be reduced if unused RSLs are being removed. This is equivalent to using the runtime-shared-library-path option in the mxmlc compiler.
    
    Specified by:
    
    getRuntimeSharedLibraryPath in interface ITargetSettings
    
    Returns:
    the runtimeSharedLibraryPath
  - getIncludeClasses
```
public Collection<String> getIncludeClasses()
```
    Description copied from interface: ITargetSettings
    
    Returns a collection of fully-qualified class names that are included in the target library.
    
    Specified by:
    
    getIncludeClasses in interface ITargetSettings
    
    Returns:
    the includeClasses
  - getIncludeSources
```
public Collection<File> getIncludeSources()
```
    Description copied from interface: ITargetSettings
    
    Returns a collection of sources that are included in the target library.
    
    Specified by:
    
    getIncludeSources in interface ITargetSettings
    
    Returns:
    the includeFiles
  - getIncludeFiles
```
public Map<String,File> getIncludeFiles()
```
    Description copied from interface: ITargetSettings
    
    Returns a collection of files that are included in the target library. Each entry in the map is a file to be included. The key is the name of the file in the target library. The value is the file to be included in the library.
    
    Specified by:
    
    getIncludeFiles in interface ITargetSettings
    
    Returns:
    the includeFiles
  - getIncludeNamespaces
```
public Collection<String> getIncludeNamespaces()
```
    Description copied from interface: ITargetSettings
    
    Returns a collection of namespaces that are included in the target library.
    
    Specified by:
    
    getIncludeNamespaces in interface ITargetSettings
    
    Returns:
    the includeNamespaces
  - getIncludeResourceBundles
```
public Collection<String> getIncludeResourceBundles()
```
    Description copied from interface: ITargetSettings
    
    Returns a collection of resource bundle names that are included in the target library.
    
    Specified by:
    
    getIncludeResourceBundles in interface ITargetSettings
    
    Returns:
    the includeResourceBundles
  - getIncludeStyleSheets
```
public Map<String,File> getIncludeStyleSheets()
```
    Description copied from interface: ITargetSettings
    
    Returns a map of style sheet names and files that are included in the target library. The map's key/value pairs are as follows: key: the name of the file in the target library value: the included style sheet.
    
    Specified by:
    
    getIncludeStyleSheets in interface ITargetSettings
    
    Returns:
    the styleSheets
  - isLinkageExternal
```
public boolean isLinkageExternal(String path)
```
    Description copied from interface: ITargetSettings
    
    Determine is a library has external linkage. A library with external linkage will have none of its classes appear in the target. Two exceptions to this rule are classes on the -include-classes option and classes that are linked into frames preceding the last frame of SWF.
    
    Specified by:
    
    isLinkageExternal in interface ITargetSettings
    
    Parameters:
    path - the absolute path of a library.
    
    Returns:
    true if the library has external linkage.
  - useDirectBlit
```
public boolean useDirectBlit()
```
    Description copied from interface: ITargetSettings
    
    Returns whether the application SWF is flagged for direct blit use.
    
    Specified by:
    
    useDirectBlit in interface ITargetSettings
    
    Returns:
    true if the application SWF should use direct blit, false otherwise.
  - useGPU
```
public boolean useGPU()
```
    Description copied from interface: ITargetSettings
    
    Returns whether the application SWF is flagged for GPU use.
    
    Specified by:
    
    useGPU in interface ITargetSettings
    
    Returns:
    true if the application SWF should use the GPU, false otherwise.
  - getDefaultsCSSFiles
```
public List<String> getDefaultsCSSFiles()
```
    Specified by:
    
    getDefaultsCSSFiles in interface ITargetSettings
    
    Returns:
    Normalized paths in defaults-css-files configuration option.
  - getLinkReport
```
public File getLinkReport()
```
    Description copied from interface: ITargetSettings
    
    Returns the file that specifies where the link report should be written.
    
    Specified by:
    
    getLinkReport in interface ITargetSettings
    
    Returns:
    the file that specifies where the link report should be written or null if the link report was not requested.
  - getSizeReport
```
public File getSizeReport()
```
    Description copied from interface: ITargetSettings
    
    Returns the file that specifies where the size report should be written.
    
    Specified by:
    
    getSizeReport in interface ITargetSettings
    
    Returns:
    the file that specifies where the size report should be written or null if the size report was not requested.
  - getFlexMinimumSupportedVersion
```
public String getFlexMinimumSupportedVersion()
```
    Description copied from interface: ITargetSettings
    
    Used when creating a library. Specifies the minimum version of Flex that is written into the catalog of the created library. Flex uses the minimum version when compiling an application to filter out libraries that have a minimum version that is greater than the specified compatibility version.
    
    Specified by:
    
    getFlexMinimumSupportedVersion in interface ITargetSettings
    
    Returns:
    the minimum supported version of Flex.
  - getMxmlChildrenAsData
```
public boolean getMxmlChildrenAsData()
```
    Specified by:
    
    getMxmlChildrenAsData in interface ITargetSettings
    
    Returns:
    true if MXML child nodes are encoded into a data stream instead of a bunch of functions.
  - getAllowSubclassOverrides
```
public boolean getAllowSubclassOverrides()
```
    Specified by:
    
    getAllowSubclassOverrides in interface ITargetSettings
    
    Returns:
    true if the return type of an override can be a subclass instead of an exact match as the base class' return type
  - getRemoveDeadCode
```
public boolean getRemoveDeadCode()
```
    Specified by:
    
    getRemoveDeadCode in interface ITargetSettings
    
    Returns:
    true if the dead code filtering optimization step is enabled.

Class TargetSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TargetSettings

Method Detail

isAccessible

isDebugEnabled

isTelemetryEnabled

isOptimized

useCompression

areVerboseStacktracesEnabled

keepAllTypeSelectors

useNetwork

removeUnusedRuntimeSharedLibraryPaths

verifyDigests

useResourceBundleMetadata

isIncludeLookupOnlyEnabled

getDefaultBackgroundColor

getDefaultFrameRate

areDefaultScriptLimitsSet

getDefaultScriptTimeLimit

getDefaultScriptRecursionLimit

getDefaultWidth

getDefaultHeight

getOutput

getASMetadataNames

getDefaultCSS

getExterns

getMxmlImplicitImports

getIncludes

getFrameLabels

getSWFMetadata

getSWFVersion

getPreloaderClassName

getRootSourceFileName

getRootClassName

getThemes

getExternalLibraryPath

getIncludeLibraries

getRuntimeSharedLibraries

getRuntimeSharedLibraryPath

getIncludeClasses

getIncludeSources

getIncludeFiles

getIncludeNamespaces

getIncludeResourceBundles

getIncludeStyleSheets

isLinkageExternal

useDirectBlit

useGPU

getDefaultsCSSFiles

getLinkReport

getSizeReport

getFlexMinimumSupportedVersion

getMxmlChildrenAsData

getAllowSubclassOverrides

getRemoveDeadCode