org.apache.royale.compiler.internal.config

Interface IWriteOnlyProjectSettings

All Known Subinterfaces:

ICompilerSettings

All Known Implementing Classes:

Configurator

public interface IWriteOnlyProjectSettings

Setters for Project settings that can come from command line compiler options. This interface is implemented by Configurator and IRoyaleProject to keep the common setters for these interfaces in sync.

Method Summary

Modifier and Type	Method and Description
void	setActionScriptFileEncoding(String encoding) Sets the ActionScript file encoding.
void	setCompatibilityVersion(int major, int minor, int revision) Sets the SDK compatibility version.
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	setIncludeSources(Collection<File> sources) A collection of source files or directories to add to the target library.
void	setLocales(Collection<String> locales) Sets the locales that the compiler would use to replace {locale} tokens that appear in some configuration values.
void	setNamespaceMappings(List<? extends IMXMLNamespaceMapping> namespaceMappings) Sets the mappings from MXML namespace URI to manifest files, as specified by -namespace options.
void	setRoyale(boolean value) Option to enable or prevent various Royale compiler behaviors.
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.

Method Detail

setSourcePath

void setSourcePath(List<File> paths)

Sets a list of path elements that form the roots of ActionScript class hierarchies. Calling this method can invalidate a significant amount of incremental compilation results. This is equivalent to using mxmlc/compc --compiler.source-path.

Parameters:

paths - List of directories that should be searched for source files.

setLocales

void setLocales(Collection<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, The locale/en_US directory will be added to the source path.

setActionScriptFileEncoding

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.

Parameters:

encoding - charactere encoding, e.g. UTF-8, Big5

setDefineDirectives

void setDefineDirectives(Map<String,String> defines)

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.

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.

setCompatibilityVersion

void setCompatibilityVersion(int major,
                             int minor,
                             int revision)

Sets the SDK compatibility version.

Parameters:

major - The major version.

minor - The minor version.

revision - The revision component of the version.

setNamespaceMappings

void setNamespaceMappings(List<? extends IMXMLNamespaceMapping> namespaceMappings)

Sets the mappings from MXML namespace URI to manifest files, as specified by -namespace options.

Parameters:

namespaceMappings - An array of MXMLNamespaceMapping objects.

setExtensionLibraries

void setExtensionLibraries(Map<File,List<String>> extensions)

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.

Parameters:

extensions - a map of extension element files to extension paths.

setServicesXMLPath

void setServicesXMLPath(String path,
                        String contextRoot)

Configure this project to use a services-config.xml file. The services-config.xml file is used to configure a Royale client to talk to a BlazeDS server. This is equivalent to using mxmlc/compc --services and --context-root.

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.

setIncludeSources

void setIncludeSources(Collection<File> sources)
                throws InterruptedException

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.

Parameters:

sources - A collection of source files or directories.

Throws:

InterruptedException

setRoyale

void setRoyale(boolean value)

Option to enable or prevent various Royale compiler behaviors. This is currently used to enable/disable the generation of a root class for library swfs and generation of Royale specific code for application swfs.

Parameters:

value - true to turn on Royale behaviors, false otherwise.

setExcludeNativeJSLibraries

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.

Parameters:

value - true to turn on the behaviors, false otherwise.