org.apache.flex.compiler.internal.config

Interface IConfigurator

All Known Implementing Classes:

Configurator, Optimizer.OptimizerConfigurator

public interface IConfigurator

An interface to configure projects and targets. This interface is implemented by an object that stores both project and target settings.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	applyToProject(IFlexProject project) Apply the current configuration settings to a given project.
ICompilerProblemSettings	getCompilerProblemSettings() Get the settings that control how compiler problems are reported.
Collection<ICompilerProblem>	getConfigurationProblems() Get the configuration problems.
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.
ITargetSettings	getTargetSettings(ITarget.TargetType targetType) Get the settings that apply to a given type of target based on the current state of the configuration.
void	setConfigurationPathResolver(IPathResolver pathResolver) Set a path resolver for files used in the command line options and configuration files.
Collection<ICompilerProblem>	validateConfiguration(String[] args, ITarget.TargetType targetType) Validates that the specified compiler options are syntactically correct.

Method Detail

applyToProject

boolean applyToProject(IFlexProject project)

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 getConfigurationProblems() to get a list of problems encountered while processing the configuration.

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

ITargetSettings getTargetSettings(ITarget.TargetType targetType)

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 getConfigurationProblems() to get a list of problems encountered while processing the configuration.

Parameters:

targetType -

Returns:

The configuration settings that are applicable to the target type, null if the configuration contains errors.

getCompilerProblemSettings

ICompilerProblemSettings getCompilerProblemSettings()

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.

Returns:

The configuration settings that affect problem reporting.

getLoadedConfigurationFiles

List<String> getLoadedConfigurationFiles()

Get the list of configuration files that were loaded while processing compiler settings.

Returns:

The file names of loaded configuration files.

getMissingConfigurationFiles

List<String> getMissingConfigurationFiles()

Get the list of configuration files that were specified to be loaded but not found while processing compiler settings.

Returns:

The file names of missing configuration files.

validateConfiguration

Collection<ICompilerProblem> validateConfiguration(String[] args,
                                                 ITarget.TargetType targetType)

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.

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.

Throws:

NullPointerException - if args is null.

getConfigurationProblems

Collection<ICompilerProblem> getConfigurationProblems()

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.

Returns:

a collection of non-fatal configuration problems.

setConfigurationPathResolver

void setConfigurationPathResolver(IPathResolver pathResolver)

Set a path resolver for files used in the command line options and configuration files.

Parameters:

pathResolver - a path resolver for configuration files.