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

java.lang.Object
- org.apache.flex.compiler.config.Configurator

All Implemented Interfaces:

Cloneable, ICompilerSettingsConstants, ICompilerSettings, IConfigurator, IWriteOnlyProjectSettings

Direct Known Subclasses:

Optimizer.OptimizerConfigurator
```
public class Configurator
extends Object
implements ICompilerSettings, IConfigurator, ICompilerSettingsConstants, Cloneable
```
A class that allows a client change compiler settings and to configure projects and targets from those settings.

Field Summary
- Fields inherited from interface org.apache.flex.compiler.internal.config.ICompilerSettings
  CONTRIBUTOR, CREATOR, DATE, DESCRIPTION, LANGUAGE, PUBLISHER, TITLE, WARN_ARRAY_TO_STRING_CHANGES, WARN_ASSIGNMENT_WITHIN_CONDITIONAL, WARN_BAD_ARRAY_CAST, WARN_BAD_BOOLEAN_ASSIGNMENT, WARN_BAD_DATE_CAST, WARN_BAD_ES3_TYPE_METHOD, WARN_BAD_ES3_TYPE_PROP, WARN_BAD_NAN_COMPARISON, WARN_BAD_NULL_ASSIGNMENT, WARN_BAD_NULL_COMPARISON, WARN_BAD_UNDEFINED_COMPARISON, WARN_BOOLEAN_CONSTRUCTOR_WITH_NO_ARGS, WARN_CHANGES_IN_RESOLVE, WARN_CLASS_IS_SEALED, WARN_CONST_NOT_INITIALIZED, WARN_CONSTRUCTOR_RETURNS_VALUE, WARN_DEPRECATED_EVENT_HANDLER_ERROR, WARN_DEPRECATED_FUNCTION_ERROR, WARN_DEPRECATED_PROPERTY_ERROR, WARN_DUPLICATE_ARGUMENT_NAMES, WARN_DUPLICATE_VARIABLE_DEF, WARN_FOR_VAR_IN_CHANGES, WARN_IMPORT_HIDES_CLASS, WARN_INSTANCEOF_CHANGES, WARN_INTERNAL_ERROR, WARN_LEVEL_NOT_SUPPORTED, WARN_MISSING_NAMESPACE_DECL, WARN_NEGATIVE_UINT_LITERAL, WARN_NO_CONSTRUCTOR, WARN_NO_EXPLICIT_SUPER_CALL_IN_CONSTRUCTOR, WARN_NO_TYPE_DECL, WARN_NUMBER_FROM_STRING_CHANGES, WARN_SCOPING_CHANGE_IN_THIS, WARN_SLOW_TEXTFIELD_ADDITION, WARN_UNLIKELY_FUNCTION_VALUE, WARN_XML_CLASS_HAS_CHANGED
- Fields inherited from interface org.apache.flex.compiler.config.ICompilerSettingsConstants
  COMPILER_ACCESSIBLE, COMPILER_ACTIONSCRIPT_FILE_ENCODING, COMPILER_ALLOW_SOURCE_PATH_OVERLAP, COMPILER_AS3, COMPILER_COMPRESS, COMPILER_COMPUTE_DIGEST, COMPILER_CONTEXT_ROOT, COMPILER_DEBUG, COMPILER_DEFAULTS_CSS_URL, COMPILER_DEFINE, COMPILER_ES, COMPILER_EXTENSIONS, COMPILER_EXTERNAL_LIBRARY_PATH, COMPILER_HEADLESS_SERVER, COMPILER_INCLUDE_LIBRARIES, COMPILER_KEEP_ALL_TYPE_SELECTORS, COMPILER_KEEP_AS3_METADATA, COMPILER_KEEP_GENERATED_ACTIONSCRIPT, COMPILER_LIBRARY_PATH, COMPILER_LOCALE, COMPILER_MOBILE, COMPILER_MXML_COMPATIBILITY, COMPILER_NAMESPACES_NAMESPACE, COMPILER_OPTIMIZE, COMPILER_SERVICES, COMPILER_SHOW_ACTIONSCRIPT_WARNINGS, COMPILER_SHOW_BINDING_WARNINGS, COMPILER_SHOW_DEPRECATION_WARNINGS, COMPILER_SHOW_MULTIPLE_DEFINITION_WARNINGS, COMPILER_SHOW_UNUSED_TYPE_SELECTOR_WARNINGS, COMPILER_SOURCE_PATH, COMPILER_STRICT, COMPILER_THEME, COMPILER_USE_RESOURCE_BUNDLE_METADATA, COMPILER_VERBOSE_STACKTRACES, COMPILER_WARN_ARRAY_TOSTRING_CHANGES, COMPILER_WARN_ASSIGNMENT_WITHIN_CONDITIONAL, COMPILER_WARN_BAD_ARRAY_CAST, COMPILER_WARN_BAD_BOOL_ASSIGNMENT, COMPILER_WARN_BAD_DATE_CAST, COMPILER_WARN_BAD_ES3_TYPE_METHOD, COMPILER_WARN_BAD_ES3_TYPE_PROP, COMPILER_WARN_BAD_NAN_COMPARISON, COMPILER_WARN_BAD_NULL_ASSIGNMENT, COMPILER_WARN_BAD_NULL_COMPARISON, COMPILER_WARN_BAD_UNDEFINED_COMPARISON, COMPILER_WARN_BOOLEAN_CONSTRUCTOR_WITH_NO_ARGS, COMPILER_WARN_CHANGES_IN_RESOLVE, COMPILER_WARN_CLASS_IS_SEALED, COMPILER_WARN_CONST_NOT_INITIALIZED, COMPILER_WARN_CONSTRUCTOR_RETURNS_VALUE, COMPILER_WARN_DEPRECATED_EVENT_HANDLER_ERROR, COMPILER_WARN_DEPRECATED_FUNCTION_ERROR, COMPILER_WARN_DEPRECATED_PROPERTY_ERROR, COMPILER_WARN_DUPLICATE_ARGUMENT_NAMES, COMPILER_WARN_DUPLICATE_VARIABLE_DEF, COMPILER_WARN_FOR_VAR_IN_CHANGES, COMPILER_WARN_IMPORT_HIDES_CLASS, COMPILER_WARN_INSTANCE_OF_CHANGES, COMPILER_WARN_INTERNAL_ERROR, COMPILER_WARN_LEVEL_NOT_SUPPORTED, COMPILER_WARN_MISSING_NAMESPACE_DECL, COMPILER_WARN_NEGATIVE_UINT_LITERAL, COMPILER_WARN_NO_CONSTRUCTOR, COMPILER_WARN_NO_EXPLICIT_SUPER_CALL_IN_CONSTRUCTOR, COMPILER_WARN_NO_TYPE_DECL, COMPILER_WARN_NUMBER_FROM_STRING_CHANGES, COMPILER_WARN_SCOPING_CHANGE_IN_THIS, COMPILER_WARN_SLOW_TEXT_FIELD_ADDITION, COMPILER_WARN_UNLIKELY_FUNCTION_VALUE, COMPILER_WARN_XML_CLASS_HAS_CHANGED, DEBUG_PASSWORD, DEFAULT_BACKGROUND_COLOR, DEFAULT_FRAME_RATE, DEFAULT_SCRIPT_LIMITS, DEFAULT_SIZE, DUMP_CONFIG_VAR, EXCLUDE_NATIVE_JS_LIBRARIES, EXTERNS, FILE_SPECS_VAR, FLEX, FRAMES_FRAME, INCLUDE_CLASSES, INCLUDE_CLASSES_VAR, INCLUDE_FILE, INCLUDE_INHERITANCE_DEPENDENCIES_ONLY, INCLUDE_LOOKUP_ONLY, INCLUDE_NAMESPACES, INCLUDE_RESOURCE_BUNDLES, INCLUDE_SOURCES, INCLUDE_STYLESHEET, INCLUDES, LICENSES_LICENSE, LINK_REPORT, LOAD_CONFIG, LOAD_EXTERNS, METADATA_CONTRIBUTOR, METADATA_CREATOR, METADATA_DATE, METADATA_LANGUAGE, METADATA_LOCALIZED_DESCRIPTION, METADATA_LOCALIZED_TITLE, METADATA_PUBLISHER, OUTPUT, OUTPUT_VAR, PROJECTOR, RAW_METADATA, REMOVE_UNUSED_RSLS, RUNTIME_SHARED_LIBRARIES, RUNTIME_SHARED_LIBRARY_PATH, RUNTIME_SHARED_LIBRARY_SETTINGS_APPLICATION_DOMAIN, RUNTIME_SHARED_LIBRARY_SETTINGS_FORCE_RSLS, SIZE_REPORT, STATIC_LINK_RUNTIME_SHARED_LIBRARIES, SWF_VERSION, TARGET_PLAYER, USE_NETWORK, VERIFY_DIGESTS

Constructor Summary

Constructors
Constructor and Description

Configurator()
Constructor

Configurator(Class<? extends Configuration> configurationClass)
Constructor

Constructors
Constructor and Description
`Configurator()` Constructor
`Configurator(Class<? extends Configuration> configurationClass)` Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addASMetadataNames(Collection<String> md)` Adds the list of AS3 metadata names to the existing list of AS3 metadata the compiler should keep in the SWF.
`void`	`addConfiguration(File file)` Adds a file to the existing list of configuration files.
`void`	`addExtensionLibraries(File extension, List<String> parameter)`
`void`	`addExternalLibraryPath(Collection<File> paths)` Adds to the existing list of SWC files.
`void`	`addExterns(Collection<String> definitions)` Adds a list of definitions to the existing list of definitions.
`void`	`addIncludeResourceBundles(Collection<String> bundles)` Adds a list of resource bundles to the existing list.
`void`	`addIncludes(Collection<String> definitions)` Adds a list of definitions to the existing list of definitions.
`void`	`addLibraryPath(Collection<File> paths)` Adds a list of SWC files or directories to the default library path.
`void`	`addLoadExterns(Collection<File> files)` Adds a list of files to the existing list of definitions to be omitted from linking.
`void`	`addLocales(Collection<String> locales)` Add to the existing list of locales without overriding and locales settings in configuration files.
`void`	`addNamespaceMappings(Collection<IMXMLNamespaceMapping> namespaceMappings)` Adds to the existing list of namespace mappings.
`void`	`addRuntimeSharedLibraries(List<String> libraries)` Adds a list of runtime shared library URLs to the existing list.
`void`	`addRuntimeSharedLibraryPath(List<RSLSettings> rslSettings)` A list of RSLs to load, complete with all the settings on how to load the RSLs.
`void`	`addSourcePath(Collection<File> paths)` Adds a list of path elements to the existing source path list.
`void`	`addTheme(List<File> files)` Adds a list of CSS or SWC files to the existing list of theme files.
`void`	`allowSourcePathOverlap(boolean b)` Allows some source path directories to be subdirectories of the other.
`protected void`	`applySourcePathRules(List<String> sourcePath)` Apply the follow source-path rules: 1.
`boolean`	`applyToProject(IFlexProject project)` Apply the current configuration settings to a given project.
`protected void`	`byPassConfigurationsRequiringFlexSDK()` By-pass the configurations that requires Flex SDK.
`void`	`checkActionScriptWarning(int warningCode, boolean b)` Enables checking of ActionScript warnings.
`Configurator`	`clone()`
`void`	`compress(boolean b)` Enables ZLIB compression on SWF file.
`protected Configuration`	`createConfiguration()` Create a new configuration instance.
`protected ConfigurationBuffer`	`createConfigurationBuffer(Class<? extends Configuration> configurationClass)` Create a configuration buffer.
`void`	`enableAccessibility(boolean b)` Enables accessibility in the application.
`void`	`enableDebugging(boolean b, String debugPassword)` Enables debugging in the application.
`void`	`enableDigestVerification(boolean verify)` Verifies the RSL loaded has the same digest as the RSL specified when the application was compiled.
`void`	`enableIncludeLookupOnly(boolean include)` Controls whether manifest entries with lookupOnly=true are included in the SWC catalog.
`void`	`enableStrictChecking(boolean b)` Runs the ActionScript compiler in strict error checking mode.
`void`	`enableVerboseStacktraces(boolean b)` Generates bytecodes that include line numbers.
`ICompilerProblemSettings`	`getCompilerProblemSettings()` Get the settings that control how compiler problems are reported.
`Configuration`	`getConfiguration()`
`ConfigurationBuffer`	`getConfigurationBuffer()`
`Collection<ICompilerProblem>`	`getConfigurationProblems()` Get the configuration problems.
`Map<String,List<String>>`	`getExtensions()`
`List<String>`	`getLoadedConfigurationFiles()` Get the list of configuration files that were loaded while processing compiler settings.
`List<String>`	`getMissingConfigurationFiles()` Get the list of configuration files that were specified to be loaded but not found while processing compiler settings.
`protected String[]`	`getOptions(Map<String,Object> args, Map<String,Object> more, String[] extras)`
`static List<RSLSettings>`	`getRSLSettingsFromConfiguration(Configuration configuration)`
`ITargetSettings`	`getTargetSettings(ITarget.TargetType targetType)` Get the settings that apply to a given type of target based on the current state of the configuration.
`protected void`	`initializeConfiguration()` Initialize the configuration and the configuration buffer.
`void`	`keepAllTypeSelectors(boolean b)` Disables the pruning of unused type selectors.
`boolean`	`keepConfigurationReport()`
`void`	`keepConfigurationReport(boolean b)` Instructs the compiler to keep a report of the compiler configuration settings.
`boolean`	`keepLinkReport()`
`void`	`keepLinkReport(boolean b)` Instructs the linker to keep a report of the content that is included in the application.
`boolean`	`keepSizeReport()`
`void`	`keepSizeReport(boolean b)` Instructs the linker to keep a SWF size report.
`protected boolean`	`loadConfig()` Load configuration XML file specified in `-load-config` option on command-line.
`protected boolean`	`loadConfigFromFile(ConfigurationBuffer buffer, File fileSpec, String context, String rootElement, boolean ignoreUnknownItems)` Load a configuration from file.
`protected void`	`loadDefaults(ConfigurationBuffer cfgbuf)` Load the default values into the passed in config buffer
`protected boolean`	`loadProjectConfig()` Load project specific configuration.
`void`	`optimize(boolean b)` Enables post-link optimization.
`protected void`	`overrideDefaults()` Override default values.
`protected boolean`	`processConfiguration()` Wrapper around the real processConfiguration.
`protected boolean`	`processConfiguration(String[] argsArray)` Does all the work to set the command line arguments info the configuration object.
`protected String[]`	`processExtras(String[] extraOptions)` Do special case handling of extra arguments for Flash Builder.
`void`	`removeUnusedRuntimeSharedLibraryPaths(boolean b)` Enables the removal of RSLs associated with libraries that are not used by an application.
`protected void`	`reportConfigurationException(ConfigurationException e)` Convert conifguration exceptions to problems and collect them for reporting.
`void`	`reportMissingsLibraries(boolean b)` Instructs the compiler to report missing Libraries as a configuration error.
`void`	`setActionScriptFileEncoding(String encoding)` Sets the ActionScript file encoding.
`void`	`setASMetadataNames(String[] md)` Sets the AS3 metadata the compiler should keep in the SWF.
`void`	`setCompatibilityVersion(int major, int minor, int revision)` Sets the SDK compatibility version.
`void`	`setConfiguration(File file)` Loads a file containing configuration options.
`void`	`setConfiguration(String[] args, String defaultVariable)` Sets the configuration parameters.
`void`	`setConfiguration(String[] args, String defaultVariable, boolean argsRequireDefaultVariable)` Sets the configuration parameters.
`void`	`setConfigurationPathResolver(IPathResolver pathResolver)` Set a path resolver for files used in the command line options and configuration files.
`void`	`setContextRoot(String path)` Sets the context root path so that the compiler can replace `{context.root}` tokens for service channel endpoints.
`void`	`setDefaultBackgroundColor(int color)` Sets the default background color (may be overridden by the application code).
`void`	`setDefaultCSS(File url)` Sets the location of the default CSS file.
`void`	`setDefaultFrameRate(int rate)` Sets the default frame rate to be used in the application.
`void`	`setDefaultScriptLimits(int maxRecursionDepth, int maxExecutionTime)` Sets the default script execution limits (may be overridden by root attributes).
`void`	`setDefaultSize(int width, int height)` Sets the default window size.
`void`	`setDefineDirectives(Map<String,String> defines)` Set global AS3 compiler configuration values and clear existing definitions.
`void`	`setExcludeNativeJSLibraries(boolean value)` Option to remove the Native JS libraries from external-library-path and library-path as they shouldn't be any when compiling SWFs / SWCs.
`void`	`setExtensionLibraries(Map<File,List<String>> extensions)` Configures a list of many extensions mapped to a single Extension URI.
`void`	`setExternalLibraryPath(Collection<File> paths)` Sets the list of SWC files or directories to compile against but to omit from linking.
`void`	`setExterns(Collection<String> definitions)` Sets a list of definitions to omit from linking when building an application.
`void`	`setFlex(boolean value)` Option to enable or prevent various Flex compiler behaviors.
`void`	`setFrameLabel(String label, Collection<String> classNames)` Sets a SWF frame label with a sequence of classnames that will be linked onto the frame.
`void`	`setIncludeClasses(Collection<String> classes)` Adds a class, function, variable, or namespace to the target library.
`void`	`setIncludeFiles(Map<String,File> files)` Adds a collection of files to the target library.
`void`	`setIncludeLibraries(Collection<File> libraries)` Includes a list of libraries (SWCs) to completely include in the application This is equivalent to using `mxmlc/compc --compiler.include-libraries`.
`void`	`setIncludeNamespaces(Collection<String> namespaces)` Adds a collection of namespaces to include in this target library.
`void`	`setIncludeResourceBundles(Collection<String> bundles)` Sets a list of resource bundles to include in the swf.
`void`	`setIncludes(Collection<String> definitions)` Sets a list of definitions to always link in when building an application.
`void`	`setIncludeSources(Collection<File> sources)` A collection of source files or directories to add to the target library.
`void`	`setIncludeStyleSheet(Map<String,File> styleSheets)` Specifies a map of style sheets to add to the target library.
`void`	`setLibraryPath(Collection<File> paths)` Sets a list of SWC files or directories that contain SWC files.
`void`	`setLicense(String productName, String serialNumber)` Specifies the licenses that the compiler has to validate before compiling.
`void`	`setLoadExterns(Collection<File> files)` Sets a list of definitions to omit from linking when building an application.
`void`	`setLocale(String[] locales)` Sets the locales that the compiler would use to replace `{locale}` tokens that appear in some configuration values.
`void`	`setLocales(Collection<String> locales)` Sets the locales that the compiler would use to replace `{locale}` tokens that appear in some configuration values.
`void`	`setMainDefinition(String name)` Set the class name of the main definition
`void`	`setNamespaceMappings(List<? extends IMXMLNamespaceMapping> namespaceMappings)` Sets the mappings from MXML namespace URI to manifest files, as specified by -namespace options.
`void`	`setOutput(File output)` Set the output of the target.
`void`	`setRuntimeSharedLibraries(List<String> libraries)` Sets a list of runtime shared library URLs to be loaded before the application starts.
`void`	`setRuntimeSharedLibraryPath(List<RSLSettings> rslSettings)` A list of RSLs to load, complete with all the settings on how to load the RSLs.
`void`	`setServicesXMLPath(String path, String contextRoot)` Configure this project to use a services-config.xml file.
`void`	`setSourcePath(List<File> paths)` Sets a list of path elements that form the roots of ActionScript class hierarchies.
`void`	`setStaticLinkRuntimeSharedLibraries(boolean b)` Enable or disable runtime shared libraries in the application.
`void`	`setSWFMetadata(int field, Object value)` Sets the metadata section of the application SWF.
`void`	`setSWFMetadata(String xml)` Sets the metadata section of the application SWF.
`void`	`setTargetPlayer(int major, int minor, int revision)` Sets the version of the Flash Player that is being targeted by the application.
`void`	`setTheme(List<File> files)` Sets a list of CSS or SWC files to apply as a theme.
`void`	`setToken(String name, String value)` Defines a token. mxmlc and compc support token substitutions.
`protected void`	`setupCompatibilityVersion(FlexProject project)` Setup `-compatibility-version` level.
`protected void`	`setupConfigVariables(IFlexProject project)`
`protected void`	`setupLocaleSettings(IFlexProject project)` Setups the locale related settings.
`protected void`	`setupNamespaces(IFlexProject project)`
`protected boolean`	`setupProjectLibraries(IFlexProject project)` Collect all of the different library paths and set them in the project.
`protected void`	`setupServices(FlexProject project)` Transfers configuration settings to the project.
`protected boolean`	`setupSources(IFlexProject project)` Setup the source paths.
`protected void`	`setupThemeFiles(FlexProject project)` Setup theme files.
`void`	`setWarnOnFlexOnlyOptionUsage(boolean value)` Controls if the compiler warns when "Flex only" configuration options are used in the compiler.
`void`	`showActionScriptWarnings(boolean b)` Runs the ActionScript compiler in a mode that detects legal but potentially incorrect code.
`void`	`showBindingWarnings(boolean b)` Toggles whether warnings generated from data binding code are displayed.
`void`	`showDeprecationWarnings(boolean b)` Toggles whether the use of deprecated APIs generates a warning.
`void`	`showMultipleDefinitionWarnings(boolean b)` Toggles whether warnings generated from two code files with the same name are displayed.
`void`	`showUnusedTypeSelectorWarnings(boolean b)` Toggles whether warnings generated from unused type selectors are displayed.
`static List<File>`	`toFileList(List<String> paths)` Convert file path strings to `File` objects.
`static List<File>`	`toFiles(List<String> paths)` Convert file path strings to `File` objects.
`static List<IFileSpecification>`	`toFileSpecifications(List<String> paths, Workspace workspace)` Resolve a list of normalized paths to `IFileSpecification` objects from the given `workspace`.
`static String[]`	`toPaths(File[] files)` Convert `File` objects to `String`, where each `String` is the absolute file path of the file.
`String`	`toString()`
`void`	`useNetwork(boolean b)` Toggles whether the application SWF is flagged for access to network resources.
`void`	`useResourceBundleMetaData(boolean b)` Determines whether resources bundles are included in the application.
`Collection<ICompilerProblem>`	`validateConfiguration(String[] args, ITarget.TargetType targetType)` Validates that the specified compiler options are syntactically correct.
`protected void`	`validateSWCConfiguration()` Do the validatation that the old COMPCConfiguration used to do.
`protected void`	`validateSWCInputs()` Basic validation of compc options.

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

- Constructor Detail
  - Configurator
```
public Configurator()
```
    Constructor
  - Configurator
```
public Configurator(Class<? extends Configuration> configurationClass)
```
    Constructor
- Method Detail
  - toFiles
```
public static List<File> toFiles(List<String> paths)
```
    Convert file path strings to File objects. Null values are discarded.
    
    Parameters:
    paths - List of file paths
    
    Returns:
    List of File objects. No null values will be returned.
  - toFileList
```
public static List<File> toFileList(List<String> paths)
```
    Convert file path strings to File objects. Null values are discarded.
    
    Parameters:
    paths - List of file paths
    
    Returns:
    Array of File objects. No null values will be returned.
  - toPaths
```
public static String[] toPaths(File[] files)
```
    Convert File objects to String, where each String is the absolute file path of the file. Null values are discarded.
    
    Parameters:
    files - file specifications
    
    Returns:
    Array of File objects. No null values will be returned.
  - toFileSpecifications
```
public static List<IFileSpecification> toFileSpecifications(List<String> paths,
                                            Workspace workspace)
```
    Resolve a list of normalized paths to IFileSpecification objects from the given workspace.
    
    Parameters:
    paths - A list of normalized paths.
    workspace - Workspace.
    
    Returns:
    A list of file specifications.
  - getLoadedConfigurationFiles
```
public List<String> getLoadedConfigurationFiles()
```
    Description copied from interface: IConfigurator
    
    Get the list of configuration files that were loaded while processing compiler settings.
    
    Specified by:
    
    getLoadedConfigurationFiles in interface IConfigurator
    
    Returns:
    The file names of loaded configuration files.
  - getMissingConfigurationFiles
```
public List<String> getMissingConfigurationFiles()
```
    Description copied from interface: IConfigurator
    
    Get the list of configuration files that were specified to be loaded but not found while processing compiler settings.
    
    Specified by:
    
    getMissingConfigurationFiles in interface IConfigurator
    
    Returns:
    The file names of missing configuration files.
  - applyToProject
```
public boolean applyToProject(IFlexProject project)
```
    Description copied from interface: IConfigurator
    
    Apply the current configuration settings to a given project. If any configuration problems have a severity of CompilerProblemSeverity.ERROR, then the project will be setup with the existing configuration but the project may not be correct. Call IConfigurator.getConfigurationProblems() to get a list of problems encountered while processing the configuration.
    
    Specified by:
    
    applyToProject in interface IConfigurator
    
    Parameters:
    project - The project to apply the configuration settings to.
    
    Returns:
    true if the configuration contains no errors and the project was successfully configured, false if the configuration contains errors.
  - getTargetSettings
```
public ITargetSettings getTargetSettings(ITarget.TargetType targetType)
```
    Description copied from interface: IConfigurator
    
    Get the settings that apply to a given type of target based on the current state of the configuration. If any of the problems have a severity of CompilerProblemSeverity.ERROR, then null will be returned instead of the target settings. Call IConfigurator.getConfigurationProblems() to get a list of problems encountered while processing the configuration.
    
    Specified by:
    
    getTargetSettings in interface IConfigurator
    
    Returns:
    The configuration settings that are applicable to the target type, null if the configuration contains errors.
  - getCompilerProblemSettings
```
public ICompilerProblemSettings getCompilerProblemSettings()
```
    Description copied from interface: IConfigurator
    
    Get the settings that control how compiler problems are reported. These settings control what warnings are reported and how problems are classified into errors and warnings.
    
    Specified by:
    
    getCompilerProblemSettings in interface IConfigurator
    
    Returns:
    The configuration settings that affect problem reporting.
  - validateConfiguration
```
public Collection<ICompilerProblem> validateConfiguration(String[] args,
                                                 ITarget.TargetType targetType)
```
    Description copied from interface: IConfigurator
    
    Validates that the specified compiler options are syntactically correct. The options are specified in the same format as the user specifies configuration options to the command line tools.
    
    Specified by:
    
    validateConfiguration in interface IConfigurator
    
    Parameters:
    args - An array of compiler options. May not be null.
    targetType - the target for which the configuration will be applied.
    
    Returns:
    a list of problems found in the configuration arguments. If no problems are found an empty list is returned.
  - getConfigurationProblems
```
public Collection<ICompilerProblem> getConfigurationProblems()
```
    Description copied from interface: IConfigurator
    
    Get the configuration problems. This method should only be called after the configuration has been processed, which means after either applyToProject() or getTargetSettings() has been called.
    The problems in this list contain both errors and warnings.
    
    Specified by:
    
    getConfigurationProblems in interface IConfigurator
    
    Returns:
    a collection of non-fatal configuration problems.
  - setConfigurationPathResolver
```
public void setConfigurationPathResolver(IPathResolver pathResolver)
```
    Description copied from interface: IConfigurator
    
    Set a path resolver for files used in the command line options and configuration files.
    
    Specified by:
    
    setConfigurationPathResolver in interface IConfigurator
    
    Parameters:
    pathResolver - a path resolver for configuration files.
  - getConfiguration
```
public Configuration getConfiguration()
```
  - getConfigurationBuffer
```
public ConfigurationBuffer getConfigurationBuffer()
```
  - createConfiguration
```
protected Configuration createConfiguration()
```
    Create a new configuration instance. The Configurator will need to create a new configuration for each new configuration. For example, creating a new Configurator and getting the target settings will create a new configuration. If later on, the configuration is modified by calling any of the setter methods on the Configurator, then a new configuration will be created the next time applyToProject() or getTargetSettings() is called. The method may be overriden to allow for greater control when creating a custom configuration that extends the built-in configuration.
    
    Returns:
    a new configuration instance. If the custom configuration class cannot be created, the default configuration class will be created instead.
  - initializeConfiguration
```
protected void initializeConfiguration()
```
    Initialize the configuration and the configuration buffer.
  - createConfigurationBuffer
```
protected ConfigurationBuffer createConfigurationBuffer(Class<? extends Configuration> configurationClass)
```
    Create a configuration buffer.
    
    Parameters:
    configurationClass - The Configuration object
    
    Returns:
    the configuration buffer to use
  - setupThemeFiles
```
protected void setupThemeFiles(FlexProject project)
```
    Setup theme files.
  - setupProjectLibraries
```
protected boolean setupProjectLibraries(IFlexProject project)
```
    Collect all of the different library paths and set them in the project. The libraries are ordered with RSL and external libraries having the highest priority.
    Libraries are ordered highest to lowest priority:
    1. External Library Path
    2. RSL Library Path
    3. Include Library Path
    4. Library Path
    Parameters:
    project -
    
    Returns:
    true if successful, false if there is an error.
  - setupCompatibilityVersion
```
protected void setupCompatibilityVersion(FlexProject project)
```
    Setup -compatibility-version level. Falcon only support Flex 3+.
    
    Parameters:
    project -
  - setupServices
```
protected void setupServices(FlexProject project)
```
    Transfers configuration settings to the project. Handles: -services -context-root
  - setupSources
```
protected boolean setupSources(IFlexProject project)
```
    Setup the source paths.
    
    Returns:
    true if successful, false otherwise.
  - applySourcePathRules
```
protected void applySourcePathRules(List<String> sourcePath)
```
    Apply the follow source-path rules: 1. If source-path is empty, the target file's directory will be added to source-path. 2. If source-path is not empty and if the target file's directory is a sub-directory of one of the directories in source-path, source-path remains unchanged. 3. If source-path is not empty and if the target file's directory is not a sub-directory of any one of the directories in source-path, the target file's directory is prepended to source-path.
    
    Parameters:
    sourcePath - the source path to apply the rules to.
  - setupConfigVariables
```
protected void setupConfigVariables(IFlexProject project)
```
  - setupNamespaces
```
protected void setupNamespaces(IFlexProject project)
```
  - setupLocaleSettings
```
protected void setupLocaleSettings(IFlexProject project)
```
    Setups the locale related settings.
  - getRSLSettingsFromConfiguration
```
public static List<RSLSettings> getRSLSettingsFromConfiguration(Configuration configuration)
```
  - processConfiguration
```
protected boolean processConfiguration()
```
    Wrapper around the real processConfiguration.
    
    Returns:
    true if success, false otherwise.
  - processConfiguration
```
protected boolean processConfiguration(String[] argsArray)
```
    Does all the work to set the command line arguments info the configuration object.
    
    Parameters:
    argsArray - - command line arguments
    
    Returns:
    true if successful, false otherwise.
  - loadDefaults
```
protected void loadDefaults(ConfigurationBuffer cfgbuf)
                     throws ConfigurationException
```
    Load the default values into the passed in config buffer
    
    Parameters:
    cfgbuf - the config buffer to set the default values in
    
    Throws:
    
    ConfigurationException
  - validateSWCConfiguration
```
protected void validateSWCConfiguration()
                                 throws ConfigurationException
```
    Do the validatation that the old COMPCConfiguration used to do.
    
    Throws:
    
    ConfigurationException
  - validateSWCInputs
```
protected void validateSWCInputs()
                          throws ConfigurationException
```
    Basic validation of compc options. This code used to be in the old compiler's CompcConfiguration.
    
    Throws:
    
    ConfigurationException
  - byPassConfigurationsRequiringFlexSDK
```
protected void byPassConfigurationsRequiringFlexSDK()
                                             throws ConfigurationException
```
    By-pass the configurations that requires Flex SDK.
    
    Throws:
    
    ConfigurationException
  - overrideDefaults
```
protected void overrideDefaults()
                         throws ConfigurationException
```
    Override default values.
    
    Throws:
    
    ConfigurationException
  - loadConfig
```
protected boolean loadConfig()
```
    Load configuration XML file specified in -load-config option on command-line.
    
    Returns:
    true if successful, false otherwise.
  - loadConfigFromFile
```
protected final boolean loadConfigFromFile(ConfigurationBuffer buffer,
                         File fileSpec,
                         String context,
                         String rootElement,
                         boolean ignoreUnknownItems)
```
    Load a configuration from file. FileConfigurator.load() is wrapped in this method because we want to print a message after loading using MXMLC.println(String).
    
    Returns:
    true if successful, false otherwise.
  - reportConfigurationException
```
protected void reportConfigurationException(ConfigurationException e)
```
    Convert conifguration exceptions to problems and collect them for reporting.
    
    Parameters:
    e -
  - loadProjectConfig
```
protected boolean loadProjectConfig()
```
    Load project specific configuration. The configuration XML file is at the project root with naming convention of [project name]-config.xml.
    
    Returns:
    true if successful, false otherwise.
  - getOptions
```
protected String[] getOptions(Map<String,Object> args,
                  Map<String,Object> more,
                  String[] extras)
```
  - processExtras
```
protected String[] processExtras(String[] extraOptions)
                          throws ConfigurationException
```
    Do special case handling of extra arguments for Flash Builder. FB needs special handling for some arguments because it sets them using the Configurator API and they can also be entered by a user in "additional compiler arguments". When both are entered the "additional" arguments win. This code isn't pretty but it mimics the behavior of the old compiler.
    
    Parameters:
    extraOptions -
    
    Returns:
    new array of extra arguments to use. Returns null if extraOptions is null.
    
    Throws:
    
    ConfigurationException
  - enableAccessibility
```
public void enableAccessibility(boolean b)
```
    Enables accessibility in the application. This is equivalent to using mxmlc/compc --compiler.accessible.
    By default, this is disabled.
    
    Specified by:
    
    enableAccessibility in interface ICompilerSettings
    
    Parameters:
    b - boolean value
  - setActionScriptFileEncoding
```
public void setActionScriptFileEncoding(String encoding)
```
    Sets the ActionScript file encoding. The compiler will use this encoding to read the ActionScript source files. This is equivalent to using mxmlc/compc --compiler.actionscript-file-encoding.
    By default, the encoding is UTF-8.
    
    Specified by:
    
    setActionScriptFileEncoding in interface IWriteOnlyProjectSettings
    
    Parameters:
    encoding - charactere encoding, e.g. UTF-8, Big5
  - allowSourcePathOverlap
```
public void allowSourcePathOverlap(boolean b)
```
    Allows some source path directories to be subdirectories of the other. This is equivalent to using mxmlc/compc --compiler.allow-source-path-overlap.
    By default, this is disabled.
    In some J2EE settings, directory overlapping should be allowed. For example,
```
 wwwroot/MyAppRoot
 wwwroot/WEB-INF/flex/source_path1
 
```
    Specified by:
    
    allowSourcePathOverlap in interface ICompilerSettings
    
    Parameters:
    b - boolean value
  - setContextRoot
```
public void setContextRoot(String path)
```
    Sets the context root path so that the compiler can replace {context.root} tokens for service channel endpoints. This is equivalent to using the compiler.context-root option for the mxmlc or compc compilers.
    By default, this value is undefined.
    
    Specified by:
    
    setContextRoot in interface ICompilerSettings
    
    Parameters:
    path - An instance of String.
  - enableDebugging
```
public void enableDebugging(boolean b,
                   String debugPassword)
```
    Enables debugging in the application. This is equivalent to using mxmlc/compc --compiler.debug and --debug-password.
    By default, debug is false and the debug password is "".
    
    Specified by:
    
    enableDebugging in interface ICompilerSettings
    
    Parameters:
    b - boolean value
    debugPassword - a password that is embedded in the application.
  - setStaticLinkRuntimeSharedLibraries
```
public void setStaticLinkRuntimeSharedLibraries(boolean b)
```
    Enable or disable runtime shared libraries in the application. This is equivalent to using mxmlc --static-link-runtime-shared-libraries.
    
    Parameters:
    b - boolean value
  - setDefaultCSS
```
public void setDefaultCSS(File url)
```
    Sets the location of the default CSS file. This is equivalent to using mxmlc/compc --compiler.defaults-css-url.
    
    Parameters:
    url - an instance of java.io.File.
  - setExternalLibraryPath
```
public void setExternalLibraryPath(Collection<File> paths)
```
    Sets the list of SWC files or directories to compile against but to omit from linking. This is equivalent to using mxmlc/compc --compiler.external-library-path.
    
    Specified by:
    
    setExternalLibraryPath in interface ICompilerSettings
    
    Parameters:
    paths - File.isDirectory() should return true or File instances should represent SWC files.
  - addExternalLibraryPath
```
public void addExternalLibraryPath(Collection<File> paths)
```
    Adds to the existing list of SWC files.
    
    Specified by:
    
    addExternalLibraryPath in interface ICompilerSettings
    
    Parameters:
    paths - File.isDirectory() should return true or File instances should represent SWC files.
    See Also:
    setExternalLibraryPath(java.util.Collection<java.io.File>)
  - setASMetadataNames
```
public void setASMetadataNames(String[] md)
```
    Sets the AS3 metadata the compiler should keep in the SWF. This is equivalent to using mxmlc --compiler.keep-as3-metadata.
    The default value is {Bindable, Managed, ChangeEvent, NonCommittingChangeEvent, Transient}.
    
    Parameters:
    md - an array of AS3 metadata names
  - addASMetadataNames
```
public void addASMetadataNames(Collection<String> md)
```
    Adds the list of AS3 metadata names to the existing list of AS3 metadata the compiler should keep in the SWF.
    
    Parameters:
    md - an array of AS3 metadata names
  - keepAllTypeSelectors
```
public void keepAllTypeSelectors(boolean b)
```
    Disables the pruning of unused type selectors. This is equivalent to using mxmlc/compc --compiler.keep-all-type-selectors. By default, it is set to false.
    
    Parameters:
    b - boolean value
  - keepLinkReport
```
public void keepLinkReport(boolean b)
```
    Instructs the linker to keep a report of the content that is included in the application. Callers may use Report.writeLinkReport() to retrieve the linker report.
    
    Parameters:
    b - boolean value
  - keepLinkReport
```
public boolean keepLinkReport()
```
  - keepSizeReport
```
public void keepSizeReport(boolean b)
```
    Instructs the linker to keep a SWF size report. Callers may use Report.writeSizeReport() to retrieve the size report.
    
    Parameters:
    b - boolean value
  - keepSizeReport
```
public boolean keepSizeReport()
```
  - keepConfigurationReport
```
public void keepConfigurationReport(boolean b)
```
    Instructs the compiler to keep a report of the compiler configuration settings. Callers may use Report.writeConfigurationReport() to retrieve the configuration report.
    
    Parameters:
    b - boolean value
  - keepConfigurationReport
```
public boolean keepConfigurationReport()
```
  - reportMissingsLibraries
```
public void reportMissingsLibraries(boolean b)
```
    Instructs the compiler to report missing Libraries as a configuration error.
    
    Parameters:
    b - boolean value
  - setWarnOnFlexOnlyOptionUsage
```
public void setWarnOnFlexOnlyOptionUsage(boolean value)
```
    Controls if the compiler warns when "Flex only" configuration options are used in the compiler.
    
    Parameters:
    value - True to enable warnings, false to disable warnings. The default is to not warn.
  - setIncludeLibraries
```
public void setIncludeLibraries(Collection<File> libraries)
```
    Includes a list of libraries (SWCs) to completely include in the application This is equivalent to using mxmlc/compc --compiler.include-libraries.
    
    Specified by:
    
    setIncludeLibraries in interface ICompilerSettings
    
    Parameters:
    libraries - a collection of java.io.File (File.isDirectory() should return true or instances must represent SWC files).
  - setIncludeResourceBundles
```
public void setIncludeResourceBundles(Collection<String> bundles)
```
    Sets a list of resource bundles to include in the swf. This is equivalent to using mxmlc/compc --include-resource-bundle.
    
    Specified by:
    
    setIncludeResourceBundles in interface ICompilerSettings
    
    Parameters:
    bundles - an array of java.lang.String
  - addIncludeResourceBundles
```
public void addIncludeResourceBundles(Collection<String> bundles)
```
    Adds a list of resource bundles to the existing list.
    
    Parameters:
    bundles - an array of java.lang.String
    See Also:
    setIncludeResourceBundles(java.util.Collection<java.lang.String>)
  - setLibraryPath
```
public void setLibraryPath(Collection<File> paths)
```
    Sets a list of SWC files or directories that contain SWC files. This is equivalent to using mxmlc/compc --compiler.library-path.
    
    Specified by:
    
    setLibraryPath in interface ICompilerSettings
    
    Parameters:
    paths - an array of File. File.isDirectory() should return true or instances must represent SWC files.
  - addLibraryPath
```
public void addLibraryPath(Collection<File> paths)
```
    Adds a list of SWC files or directories to the default library path.
    
    Parameters:
    paths - an array of File. File.isDirectory() should return true or instances must represent SWC files.
    See Also:
    setLibraryPath(java.util.Collection<java.io.File>)
  - setLocale
```
public void setLocale(String[] locales)
```
    Sets the locales that the compiler would use to replace {locale} tokens that appear in some configuration values. This is equivalent to using mxmlc/compc --compiler.locale. For example,
```
 addSourcePath(new File[] { "locale/{locale}" });
 addLocale(new String[] { "en_US" });
 
```
    The locale/en_US directory will be added to the source path.
    Since:
    
    3.0
  - setNamespaceMappings
```
public void setNamespaceMappings(List<? extends IMXMLNamespaceMapping> namespaceMappings)
```
    Description copied from interface: IWriteOnlyProjectSettings
    
    Sets the mappings from MXML namespace URI to manifest files, as specified by -namespace options.
    
    Specified by:
    
    setNamespaceMappings in interface IWriteOnlyProjectSettings
    
    Parameters:
    namespaceMappings - An array of MXMLNamespaceMapping objects.
  - addNamespaceMappings
```
public void addNamespaceMappings(Collection<IMXMLNamespaceMapping> namespaceMappings)
```
    Description copied from interface: ICompilerSettings
    
    Adds to the existing list of namespace mappings.
    
    Specified by:
    
    addNamespaceMappings in interface ICompilerSettings
  - optimize
```
public void optimize(boolean b)
```
    Enables post-link optimization. This is equivalent to using mxmlc/compc --compiler.optimize. Application sizes are usually smaller with this option enabled. By default, it is set to true.
    
    Specified by:
    
    optimize in interface ICompilerSettings
    
    Parameters:
    b - boolean value
  - compress
```
public void compress(boolean b)
```
    Description copied from interface: ICompilerSettings
    
    Enables ZLIB compression on SWF file. This is equivalent to using the compiler.compress option of the mxmlc or compc compilers. Application sizes are usually smaller with this option enabled.
    
    Specified by:
    
    compress in interface ICompilerSettings
    
    Parameters:
    b - Boolean value.
  - setServicesXMLPath
```
public void setServicesXMLPath(String path,
                      String contextRoot)
```
    Description copied from interface: IWriteOnlyProjectSettings
    
    Configure this project to use a services-config.xml file. The services-config.xml file is used to configure a Flex client to talk to a BlazeDS server. This is equivalent to using mxmlc/compc --services and --context-root.
    Specified by: setServicesXMLPath in interface IWriteOnlyProjectSettings Parameters: path - an absolute path to the services-config.xml file. contextRoot - sets the value of the {context.root} token, which is often used in channel definitions in the services-config.xml file.
  showActionScriptWarnings public void showActionScriptWarnings(boolean b) Runs the ActionScript compiler in a mode that detects legal but potentially incorrect code. This is equivalent to using mxmlc/compc --compiler.show-actionscript-warnings. By default, it is set to true. Specified by: showActionScriptWarnings in interface ICompilerSettings Parameters: b - boolean value See Also: checkActionScriptWarning(int, boolean) showBindingWarnings public void showBindingWarnings(boolean b) Toggles whether warnings generated from data binding code are displayed. This is equivalent to using mxmlc/compc --compiler.show-binding-warnings. By default, it is set to true. Specified by: showBindingWarnings in interface ICompilerSettings Parameters: b - boolean value showDeprecationWarnings public void showDeprecationWarnings(boolean b) Toggles whether the use of deprecated APIs generates a warning. This is equivalent to using mxmlc/compc --compiler.show-deprecation-warnings. By default, it is set to true. Specified by: showDeprecationWarnings in interface ICompilerSettings Parameters: b - boolean value showUnusedTypeSelectorWarnings public void showUnusedTypeSelectorWarnings(boolean b) Toggles whether warnings generated from unused type selectors are displayed. This is equivalent to using mxmlc/compc --compiler.show-unused-type-selector-warnings. By default, it is set to true. Specified by: showUnusedTypeSelectorWarnings in interface ICompilerSettings Parameters: b - boolean value showMultipleDefinitionWarnings public void showMultipleDefinitionWarnings(boolean b) Description copied from interface: ICompilerSettings Toggles whether warnings generated from two code files with the same name are displayed. This is equivalent to using the compiler.show-multiple-definition-warnings option of the mxmlc or compc compilers. The default value is true. Specified by: showMultipleDefinitionWarnings in interface ICompilerSettings Parameters: b - Boolean value. setSourcePath public void setSourcePath(List<File> paths) Sets a list of path elements that form the roots of ActionScript class hierarchies. This is equivalent to using mxmlc/compc --compiler.source-path. Specified by: setSourcePath in interface IWriteOnlyProjectSettings Parameters: paths - an array of java.io.File (File.isDirectory() must return true). addSourcePath public void addSourcePath(Collection<File> paths) Adds a list of path elements to the existing source path list. Specified by: addSourcePath in interface ICompilerSettings Parameters: paths - an array of java.io.File (File.isDirectory() must return true). See Also: setSourcePath(java.util.List<java.io.File>) enableStrictChecking public void enableStrictChecking(boolean b) Runs the ActionScript compiler in strict error checking mode. This is equivalent to using mxmlc/compc --compiler.strict. By default, it is set to true. Specified by: enableStrictChecking in interface ICompilerSettings Parameters: b - boolean value setTheme public void setTheme(List<File> files) Sets a list of CSS or SWC files to apply as a theme. This is equivalent to using mxmlc/compc --compiler.theme. Specified by: setTheme in interface ICompilerSettings Parameters: files - an array of java.io.File addTheme public void addTheme(List<File> files) Adds a list of CSS or SWC files to the existing list of theme files. Specified by: addTheme in interface ICompilerSettings Parameters: files - an array of java.io.File See Also: setTheme(java.util.List<java.io.File>) useResourceBundleMetaData public void useResourceBundleMetaData(boolean b) Determines whether resources bundles are included in the application. This is equivalent to using mxmlc/compc --compiler.use-resource-bundle-metadata. By default, it is set to true. Specified by: useResourceBundleMetaData in interface ICompilerSettings Parameters: b - boolean value enableVerboseStacktraces public void enableVerboseStacktraces(boolean b) Generates bytecodes that include line numbers. When a run-time error occurs, the stacktrace shows these line numbers. Enabling this option generates larger SWF files. This is equivalent to using mxmlc/compc --compiler.verbose-stacktraces. By default, it is set to false. Parameters: b - boolean value removeUnusedRuntimeSharedLibraryPaths public void removeUnusedRuntimeSharedLibraryPaths(boolean b) Enables the removal of RSLs associated with libraries that are not used by an application. This is equivalent to using the remove-unused-rsls option of the mxmlc compiler. The default value is false. Specified by: removeUnusedRuntimeSharedLibraryPaths in interface ICompilerSettings Parameters: b - Boolean value that enables or disables the removal. Since: 4.5 checkActionScriptWarning public void checkActionScriptWarning(int warningCode, boolean b) Enables checking of ActionScript warnings. They are: --compiler.warn-array-tostring-changes --compiler.warn-assignment-within-conditional --compiler.warn-bad-array-cast --compiler.warn-bad-bool-assignment --compiler.warn-bad-date-cast --compiler.warn-bad-es3-type-method --compiler.warn-bad-es3-type-prop --compiler.warn-bad-nan-comparison --compiler.warn-bad-null-assignment --compiler.warn-bad-null-comparison --compiler.warn-bad-undefined-comparison --compiler.warn-boolean-constructor-with-no-args --compiler.warn-changes-in-resolve --compiler.warn-class-is-sealed --compiler.warn-const-not-initialized --compiler.warn-constructor-returns-value --compiler.warn-deprecated-event-handler-error --compiler.warn-deprecated-function-error --compiler.warn-deprecated-property-error --compiler.warn-duplicate-argument-names --compiler.warn-duplicate-variable-def --compiler.warn-for-var-in-changes --compiler.warn-import-hides-class --compiler.warn-instance-of-changes --compiler.warn-internal-error --compiler.warn-level-not-supported --compiler.warn-missing-namespace-decl --compiler.warn-negative-uint-literal --compiler.warn-no-constructor --compiler.warn-no-explicit-super-call-in-constructor --compiler.warn-no-type-decl --compiler.warn-number-from-string-changes --compiler.warn-scoping-change-in-this --compiler.warn-slow-text-field-addition --compiler.warn-unlikely-function-value --compiler.warn-xml-class-has-changed Specified by: checkActionScriptWarning in interface ICompilerSettings Parameters: warningCode - warning code b - boolean value See Also: ICompilerSettings.WARN_ARRAY_TO_STRING_CHANGES, ICompilerSettings.WARN_ASSIGNMENT_WITHIN_CONDITIONAL, ICompilerSettings.WARN_BAD_ARRAY_CAST, ICompilerSettings.WARN_BAD_BOOLEAN_ASSIGNMENT, ICompilerSettings.WARN_BAD_DATE_CAST, ICompilerSettings.WARN_BAD_ES3_TYPE_METHOD, ICompilerSettings.WARN_BAD_ES3_TYPE_PROP, ICompilerSettings.WARN_BAD_NAN_COMPARISON, ICompilerSettings.WARN_BAD_NULL_ASSIGNMENT, ICompilerSettings.WARN_BAD_NULL_COMPARISON, ICompilerSettings.WARN_BAD_UNDEFINED_COMPARISON, ICompilerSettings.WARN_BOOLEAN_CONSTRUCTOR_WITH_NO_ARGS, ICompilerSettings.WARN_CHANGES_IN_RESOLVE, ICompilerSettings.WARN_CLASS_IS_SEALED, ICompilerSettings.WARN_CONST_NOT_INITIALIZED, ICompilerSettings.WARN_CONSTRUCTOR_RETURNS_VALUE, ICompilerSettings.WARN_DEPRECATED_EVENT_HANDLER_ERROR, ICompilerSettings.WARN_DEPRECATED_FUNCTION_ERROR, ICompilerSettings.WARN_DEPRECATED_PROPERTY_ERROR, ICompilerSettings.WARN_DUPLICATE_ARGUMENT_NAMES, ICompilerSettings.WARN_DUPLICATE_VARIABLE_DEF, ICompilerSettings.WARN_FOR_VAR_IN_CHANGES, ICompilerSettings.WARN_IMPORT_HIDES_CLASS, ICompilerSettings.WARN_INSTANCEOF_CHANGES, ICompilerSettings.WARN_INTERNAL_ERROR, ICompilerSettings.WARN_LEVEL_NOT_SUPPORTED, ICompilerSettings.WARN_MISSING_NAMESPACE_DECL, ICompilerSettings.WARN_NEGATIVE_UINT_LITERAL, ICompilerSettings.WARN_NO_CONSTRUCTOR, ICompilerSettings.WARN_NO_EXPLICIT_SUPER_CALL_IN_CONSTRUCTOR, ICompilerSettings.WARN_NO_TYPE_DECL, ICompilerSettings.WARN_NUMBER_FROM_STRING_CHANGES, ICompilerSettings.WARN_SCOPING_CHANGE_IN_THIS, ICompilerSettings.WARN_SLOW_TEXTFIELD_ADDITION, ICompilerSettings.WARN_UNLIKELY_FUNCTION_VALUE, ICompilerSettings.WARN_XML_CLASS_HAS_CHANGED setDefaultBackgroundColor public void setDefaultBackgroundColor(int color) Sets the default background color (may be overridden by the application code). This is equivalent to using mxmlc/compc --default-background-color. The default value is 0x869CA7. Parameters: color - RGB value setDefaultFrameRate public void setDefaultFrameRate(int rate) Sets the default frame rate to be used in the application. This is equivalent to using mxmlc/compc --default-frame-rate. The default value is 24. Parameters: rate - frames per second setDefaultScriptLimits public void setDefaultScriptLimits(int maxRecursionDepth, int maxExecutionTime) Sets the default script execution limits (may be overridden by root attributes). This is equivalent to using mxmlc/compc --default-script-limits. The default maximum recursion depth is 1000. The default maximum execution time is 60. Parameters: maxRecursionDepth - recursion depth maxExecutionTime - execution time in seconds. setDefaultSize public void setDefaultSize(int width, int height) Sets the default window size. This is equivalent to using mxmlc/compc --default-size. The default width is 500. The default height is 375. Parameters: width - width in pixels height - height in pixels setExterns public void setExterns(Collection<String> definitions) Sets a list of definitions to omit from linking when building an application. This is equivalent to using mxmlc/compc --externs. Specified by: setExterns in interface ICompilerSettings Parameters: definitions - An array of definitions (e.g. classes, functions, variables, namespaces, etc.) addExterns public void addExterns(Collection<String> definitions) Adds a list of definitions to the existing list of definitions. Parameters: definitions - an array of definitions (e.g. classes, functions, variables, namespaces, etc.) See Also: setExterns(java.util.Collection<java.lang.String>) setConfiguration public void setConfiguration(File file) Loads a file containing configuration options. The file format follows the format of flex-config.xml. This is equivalent to using mxmlc/compc --load-config. Parameters: file - an instance of java.io.File addConfiguration public void addConfiguration(File file) Adds a file to the existing list of configuration files. Parameters: file - a configuration file See Also: setConfiguration(File) setConfiguration public void setConfiguration(String[] args, String defaultVariable) Sets the configuration parameters. The input should be valid mxmlc/compc command-line arguments. Parameters: args - mxmlc/compc command-line arguments defaultVariable - the default variable of the configuration. setConfiguration public void setConfiguration(String[] args, String defaultVariable, boolean argsRequireDefaultVariable) Sets the configuration parameters. The input should be valid mxmlc/compc command-line arguments. Parameters: args - mxmlc/compc command-line arguments defaultVariable - the default variable of the configuration. argsRequireDefaultVariable - true if the default variable must be set in order to parse the args, false otherwise. setLoadExterns public void setLoadExterns(Collection<File> files) Sets a list of definitions to omit from linking when building an application. This is equivalent to using mxmlc/compc --load-externs. This option is similar to setExterns(String[]). The following is an example of the file format: <script>  <def id="mx.skins:ProgrammaticSkin"/> <pre id="mx.core:IFlexDisplayObject"/> <dep id="String"/> </script> Parameters: files - an array of java.io.File addLoadExterns public void addLoadExterns(Collection<File> files) Adds a list of files to the existing list of definitions to be omitted from linking. Parameters: files - an array of java.io.File. See Also: setLoadExterns(java.util.Collection<java.io.File>), setExterns(java.util.Collection<java.lang.String>) setFrameLabel public void setFrameLabel(String label, Collection<String> classNames) Sets a SWF frame label with a sequence of classnames that will be linked onto the frame. This is equivalent to using mxmlc/compc --frames.frame. Parameters: label - A string classNames - a collection of class names setIncludes public void setIncludes(Collection<String> definitions) Sets a list of definitions to always link in when building an application. This is equivalent to using mxmlc/compc --includes. Parameters: definitions - an array of definitions (e.g. classes, functions, variables, namespaces, etc). addIncludes public void addIncludes(Collection<String> definitions) Adds a list of definitions to the existing list of definitions. Parameters: definitions - an array of definitions (e.g. classes, functions, variables, namespaces, etc.) See Also: setIncludes(java.util.Collection<java.lang.String>) setLicense public void setLicense(String productName, String serialNumber) Specifies the licenses that the compiler has to validate before compiling. This is equivalent to using mxmlc/compc --licenses.license Parameters: productName - a string serialNumber - a serial number setSWFMetadata public void setSWFMetadata(int field, Object value) Sets the metadata section of the application SWF. This option is equivalent to using the following mxmlc/compc command-line options: --metadata.contributor --metadata.creator --metadata.date --metadata.description --metadata.language --metadata.localized-description --metadata.localized-title --metadata.publisher --metadata.title The valid fields and types of value are specified below: CONTRIBUTOR java.lang.String CREATOR java.lang.String DATE java.util.Date DESCRIPTION java.util.Map TITLE java.util.Map LANGUAGE java.lang.String PUBLISHER java.lang.String For example, Map titles = new HashMap(); titles.put("EN", "Apache Flex 4.8.0 Application"); Map descriptions = new HashMap(); descriptions.put("EN", "http://www.adobe.com/products/flex"); setSWFMetaData(Configuration.LANGUAGE, "EN"); setSWFMetaData(Configuration.TITLE, titles); setSWFMetaData(Configuration.DESCRIPTION, descriptions); Specified by: setSWFMetadata in interface ICompilerSettings Parameters: field - CONTRIBUTOR, CREATOR, DATE, DESCRIPTION, TITLE, LANGUAGE, PUBLISHER value - String, Date or Map See Also: ICompilerSettings.CONTRIBUTOR, ICompilerSettings.CREATOR, ICompilerSettings.DATE, ICompilerSettings.DESCRIPTION, ICompilerSettings.TITLE, ICompilerSettings.LANGUAGE, ICompilerSettings.PUBLISHER setSWFMetadata public void setSWFMetadata(String xml) Sets the metadata section of the application SWF. This is equivalent to using mxmlc/compc --raw-metadata. This option overrides everything set by the setSWFMetaData method. Specified by: setSWFMetadata in interface ICompilerSettings Parameters: xml - a well-formed XML fragment See Also: setSWFMetadata(int, Object) setRuntimeSharedLibraries public void setRuntimeSharedLibraries(List<String> libraries) Sets a list of runtime shared library URLs to be loaded before the application starts. This is equivalent to using mxmlc/compc --runtime-shared-libraries. Specified by: setRuntimeSharedLibraries in interface ICompilerSettings Parameters: libraries - an array of java.lang.String. addRuntimeSharedLibraries public void addRuntimeSharedLibraries(List<String> libraries) Adds a list of runtime shared library URLs to the existing list. Parameters: libraries - an array of java.lang.String See Also: setRuntimeSharedLibraries(java.util.List<java.lang.String>) useNetwork public void useNetwork(boolean b) Toggles whether the application SWF is flagged for access to network resources. This is equivalent to using mxmlc/compc --use-network. By default, it is set to true. Parameters: b - boolean value setToken public void setToken(String name, String value) Defines a token. mxmlc and compc support token substitutions. For example, mxmlc +flexlib=path1 +foo=bar --var=${foo} var=bar after the substitution of ${foo}. Specified by: setToken in interface ICompilerSettings Parameters: name - The name of the token. value - The value of the token. setMainDefinition public void setMainDefinition(String name) Set the class name of the main definition Parameters: name - of the main definition toString public String toString() Overrides: toString in class Object setTargetPlayer public void setTargetPlayer(int major, int minor, int revision) Description copied from interface: ICompilerSettings Sets the version of the Flash Player that is being targeted by the application. Features requiring a later version of the Player will not be compiled into the application. Specified by: setTargetPlayer in interface ICompilerSettings Parameters: major - The major version. Must be greater than or equal to nine. minor - The minor version. Must be greater than or equal to zero. revision - The revsion must be greater than or equal to zero. setCompatibilityVersion public void setCompatibilityVersion(int major, int minor, int revision) Description copied from interface: IWriteOnlyProjectSettings Sets the SDK compatibility version. Specified by: setCompatibilityVersion in interface IWriteOnlyProjectSettings Parameters: major - The major version. minor - The minor version. revision - The revision component of the version. enableDigestVerification public void enableDigestVerification(boolean verify) Description copied from interface: ICompilerSettings Verifies the RSL loaded has the same digest as the RSL specified when the application was compiled. This is equivalent to using the verify-digests option in the mxmlc compiler. The default value is true Specified by: enableDigestVerification in interface ICompilerSettings Parameters: verify - set to true to verify the digest of the loaded RSL matches the digest of the expected RSL. Set to false to disable the checks during the development process but it is highly recommend that production applications be compiled with verify set to true. setDefineDirectives public void setDefineDirectives(Map<String,String> defines) Description copied from interface: IWriteOnlyProjectSettings Set global AS3 compiler configuration values and clear existing definitions. This is equivalent to using the mxmlc/compc --define option once for each definition in the map. Specified by: setDefineDirectives in interface IWriteOnlyProjectSettings Parameters: defines - A map of qualified names/configuration constants, e.g. "CONFIG::debugging" or "APP::version", to value constants, e.g. "true" or "!CONFIG::release" or "3.0". Null clears the existing definitions. getExtensions public Map<String,List<String>> getExtensions() addExtensionLibraries public void addExtensionLibraries(File extension, List<String> parameter) setExtensionLibraries public void setExtensionLibraries(Map<File,List<String>> extensions) Description copied from interface: IWriteOnlyProjectSettings Configures a list of many extensions mapped to a single Extension URI. something-extension.jar version=1.1,content=1.2 The extensions run at the end of a compilation. Specified by: setExtensionLibraries in interface IWriteOnlyProjectSettings Parameters: extensions - a map of extension element files to extension paths. clone public Configurator clone() Overrides: clone in class Object setRuntimeSharedLibraryPath public void setRuntimeSharedLibraryPath(List<RSLSettings> rslSettings) Description copied from interface: ICompilerSettings 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. These RSL settings override any settings in configuration files. Set an empty list to disable the use of RSLs. This is equivalent to using the following command line options in the mxmlc compiler: runtime-shared-library-path application-domain force-rsls If rslSettings is null, then all existing RSL settings are removed. It will have the effect of removing the RSL related options from the command line which will allow settings from configuration files to be applied to the configuration. Specified by: setRuntimeSharedLibraryPath in interface ICompilerSettings Parameters: rslSettings - A list of RSLSettings. addRuntimeSharedLibraryPath public void addRuntimeSharedLibraryPath(List<RSLSettings> rslSettings) Description copied from interface: ICompilerSettings 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. The RSL provided to this method append to list of RSLs specified in any configuration files. This is equivalent to using the following command line options in the mxmlc compiler: runtime-shared-library-path+= application-domain+= force-rsls+= Specified by: addRuntimeSharedLibraryPath in interface ICompilerSettings Parameters: rslSettings - A list of RSLSettings. May not be null. setLocales public void setLocales(Collection<String> locales) Description copied from interface: IWriteOnlyProjectSettings Sets the locales that the compiler would use to replace {locale} tokens that appear in some configuration values. This is equivalent to using mxmlc/compc --compiler.locale. For example, The locale/en_US directory will be added to the source path. Specified by: setLocales in interface IWriteOnlyProjectSettings addLocales public void addLocales(Collection<String> locales) Description copied from interface: ICompilerSettings Add to the existing list of locales without overriding and locales settings in configuration files. The locale/en_US directory will be added to the source path. Specified by: addLocales in interface ICompilerSettings setOutput public void setOutput(File output) Description copied from interface: ICompilerSettings Set the output of the target. Specified by: setOutput in interface ICompilerSettings Parameters: output - File that specifies the where the target should be created. setIncludeClasses public void setIncludeClasses(Collection<String> classes) Description copied from interface: ICompilerSettings Adds a class, function, variable, or namespace to the target library. This is the equilvalent of the include-classes option of the compc compiler. Specified by: setIncludeClasses in interface ICompilerSettings Parameters: classes - a collection of fully-qualified class names. setIncludeFiles public void setIncludeFiles(Map<String,File> files) Description copied from interface: ICompilerSettings Adds a collection of files to the target library. This is equivalent to the include-file option of the compc compiler. Each entry in the map represents a file to include in the target library. The key is the name of the file in the target library and the value is the file that will be added to the library. Specified by: setIncludeFiles in interface ICompilerSettings Parameters: files - The collection of files to be added. setIncludeNamespaces public void setIncludeNamespaces(Collection<String> namespaces) Description copied from interface: ICompilerSettings Adds a collection of namespaces to include in this target library. This is equivalent to the include-namespaces option of the compc compiler. Specified by: setIncludeNamespaces in interface ICompilerSettings Parameters: namespaces - A collection of Strings where each String is a namespace URI. setIncludeSources public void setIncludeSources(Collection<File> sources) Description copied from interface: IWriteOnlyProjectSettings A collection of source files or directories to add to the target library. This is equivalent to the include-sources option of the compc compiler. Specified by: setIncludeSources in interface IWriteOnlyProjectSettings Parameters: sources - A collection of source files or directories. setIncludeStyleSheet public void setIncludeStyleSheet(Map<String,File> styleSheets) Description copied from interface: ICompilerSettings Specifies a map of style sheets to add to the target library. The map's key/value pairs are as follows: key: the name of the file in the target library value: the File to include. Specified by: setIncludeStyleSheet in interface ICompilerSettings Parameters: styleSheets - a map of names to Files to include in the target library. enableIncludeLookupOnly public void enableIncludeLookupOnly(boolean include) Description copied from interface: ICompilerSettings Controls whether manifest entries with lookupOnly=true are included in the SWC catalog. Specified by: enableIncludeLookupOnly in interface ICompilerSettings Parameters: include - true only manifest entries with lookupOnly=true are included in the SWC catalog, false otherwise. setFlex public void setFlex(boolean value) Description copied from interface: IWriteOnlyProjectSettings Option to enable or prevent various Flex compiler behaviors. This is currently used to enable/disable the generation of a root class for library swfs and generation of Flex specific code for application swfs. Specified by: setFlex in interface IWriteOnlyProjectSettings Parameters: value - true to turn on Flex behaviors, false otherwise. setExcludeNativeJSLibraries public void setExcludeNativeJSLibraries(boolean value) Description copied from interface: IWriteOnlyProjectSettings Option to remove the Native JS libraries from external-library-path and library-path as they shouldn't be any when compiling SWFs / SWCs. Specified by: setExcludeNativeJSLibraries in interface IWriteOnlyProjectSettings Parameters: value - true to turn on the behaviors, false otherwise.

Class Configurator

Field Summary

Fields inherited from interface org.apache.flex.compiler.internal.config.ICompilerSettings

Fields inherited from interface org.apache.flex.compiler.config.ICompilerSettingsConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Configurator

Configurator

Method Detail

toFiles

toFileList

toPaths

toFileSpecifications

getLoadedConfigurationFiles

getMissingConfigurationFiles

applyToProject

getTargetSettings

getCompilerProblemSettings

validateConfiguration

getConfigurationProblems

setConfigurationPathResolver

getConfiguration

getConfigurationBuffer

createConfiguration

initializeConfiguration

createConfigurationBuffer

setupThemeFiles

setupProjectLibraries

setupCompatibilityVersion

setupServices

setupSources

applySourcePathRules

setupConfigVariables

setupNamespaces

setupLocaleSettings

getRSLSettingsFromConfiguration

processConfiguration

processConfiguration

loadDefaults

validateSWCConfiguration

validateSWCInputs

byPassConfigurationsRequiringFlexSDK

overrideDefaults

loadConfig

loadConfigFromFile

reportConfigurationException

loadProjectConfig

getOptions

processExtras

enableAccessibility

setActionScriptFileEncoding

allowSourcePathOverlap

setContextRoot

enableDebugging

setStaticLinkRuntimeSharedLibraries

setDefaultCSS

setExternalLibraryPath

addExternalLibraryPath

setASMetadataNames

addASMetadataNames

keepAllTypeSelectors

keepLinkReport

keepLinkReport

keepSizeReport

keepSizeReport

keepConfigurationReport

keepConfigurationReport

reportMissingsLibraries

setWarnOnFlexOnlyOptionUsage

setIncludeLibraries

setIncludeResourceBundles

addIncludeResourceBundles

setLibraryPath

addLibraryPath

setLocale

setNamespaceMappings

addNamespaceMappings

optimize