org.apache.royale.linter.config

Class Configurator

java.lang.Object

org.apache.royale.linter.config.Configurator

All Implemented Interfaces:

Cloneable

public class Configurator
extends Object
implements Cloneable

A class that allows a client change compiler settings and to configure projects and targets from those settings.

Field Summary

Fields

Modifier and Type	Field and Description
protected Configuration	configuration
protected Collection<org.apache.royale.compiler.problems.ICompilerProblem>	configurationProblems

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Configurator	clone()
protected Configuration	createConfiguration() Create a new configuration instance.
protected ConfigurationBuffer	createConfigurationBuffer(Class<? extends Configuration> configurationClass) Create a configuration buffer.
Configuration	getConfiguration()
ConfigurationBuffer	getConfigurationBuffer()
Collection<org.apache.royale.compiler.problems.ICompilerProblem>	getConfigurationProblems()
List<String>	getLoadedConfigurationFiles()
List<String>	getMissingConfigurationFiles()
protected String[]	getOptions(Map<String,Object> args, Map<String,Object> more, String[] extras)
protected void	initializeConfiguration() Initialize the configuration and the configuration buffer.
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 boolean	loadLocalConfig() Load project specific configuration.
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)
protected void	reportConfigurationException(org.apache.royale.compiler.exceptions.ConfigurationException e) Convert conifguration exceptions to problems and collect them for reporting.
void	setConfiguration(String[] args, String defaultVariable) Sets the configuration parameters.
void	setConfigurationPathResolver(org.apache.royale.compiler.common.IPathResolver pathResolver)
void	setToken(String name, String value) Defines a token.
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 String[]	toPaths(File[] files) Convert File objects to String, where each String is the absolute file path of the file.
String	toString()
Collection<org.apache.royale.compiler.problems.ICompilerProblem>	validateConfiguration(String[] args)

Methods inherited from class java.lang.Object

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

Field Detail

configuration

protected Configuration configuration

configurationProblems

protected Collection<org.apache.royale.compiler.problems.ICompilerProblem> configurationProblems

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.

getLoadedConfigurationFiles

public List<String> getLoadedConfigurationFiles()

getMissingConfigurationFiles

public List<String> getMissingConfigurationFiles()

validateConfiguration

public Collection<org.apache.royale.compiler.problems.ICompilerProblem> validateConfiguration(String[] args)

getConfigurationProblems

public Collection<org.apache.royale.compiler.problems.ICompilerProblem> getConfigurationProblems()

setConfigurationPathResolver

public void setConfigurationPathResolver(org.apache.royale.compiler.common.IPathResolver pathResolver)

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

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.

overrideDefaults

protected void overrideDefaults()
                         throws org.apache.royale.compiler.exceptions.ConfigurationException

Override default values.

Throws:

org.apache.royale.compiler.exceptions.ConfigurationException

loadConfig

protected boolean loadConfig()

Load configuration XML file specified in -load-config option on command-line.

Returns:

true if successful, false otherwise.

loadLocalConfig

protected boolean loadLocalConfig()

Load project specific configuration. The configuration XML file is at the project root with naming convention of aslint-config.xml.

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(org.apache.royale.compiler.exceptions.ConfigurationException e)

Convert conifguration exceptions to problems and collect them for reporting.

Parameters:

e -

getOptions

protected String[] getOptions(Map<String,Object> args,
                              Map<String,Object> more,
                              String[] extras)

processExtras

protected String[] processExtras(String[] extraOptions)
                          throws org.apache.royale.compiler.exceptions.ConfigurationException

Throws:

org.apache.royale.compiler.exceptions.ConfigurationException

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.

setToken

public void setToken(String name,
                     String value)

Defines a token. mxmlc and compc support token substitutions. For example,

 mxmlc +royalelib=path1 +foo=bar --var=${foo}
 

var=bar after the substitution of ${foo}.

Parameters:

name - The name of the token.

value - The value of the token.

toString

public String toString()

Overrides:

toString in class Object

clone

public Configurator clone()

Overrides:

clone in class Object