org.apache.royale.compiler.clients

Class MXMLJSCRoyale

java.lang.Object

org.apache.royale.compiler.clients.MXMLJSCRoyale

All Implemented Interfaces:

org.apache.flex.tools.FlexTool, JSCompilerEntryPoint, ProblemQueryProvider

Direct Known Subclasses:

ASDOCJSC, COMPJSCRoyale

public class MXMLJSCRoyale
extends Object
implements JSCompilerEntryPoint, ProblemQueryProvider, org.apache.flex.tools.FlexTool

Author:

Erik de Bruin, Michael Schmalle

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.royale.compiler.internal.projects.ISourceFileHandler	asFileHandler
protected JSConfiguration	config
static MXMLJSC.JSOutputType	jsOutputType
protected IJSApplication	jsTarget
protected ProblemQuery	problems
protected RoyaleJSProject	project
protected Configurator	projectConfigurator
protected ITarget	target
protected ITargetSettings	targetSettings
protected org.apache.royale.compiler.internal.workspaces.Workspace	workspace

Fields inherited from interface org.apache.flex.tools.FlexTool

FLEX_TOOL_ASDOC, FLEX_TOOL_COMPC, FLEX_TOOL_DIGEST, FLEX_TOOL_MXMLC, FLEX_TOOL_OPTIMIZER

Constructor Summary

Constructors

Constructor and Description
MXMLJSCRoyale()
MXMLJSCRoyale(IBackend backend)

Method Summary

Modifier and Type	Method and Description
protected void	buildArtifact() Build target artifact.
protected void	close() Force terminate the compilation process.
protected boolean	compile() Main body of this program.
protected boolean	configure(String[] args) Load configurations from all the sources.
protected Configurator	createConfigurator() Create a new Configurator.
int	execute(String[] args)
String	getMainSource()
String	getName()
ProblemQuery	getProblemQuery()
List<String>	getSourceList()
protected ITarget.TargetType	getTargetType()
static void	main(String[] args) Java program entry point.
int	mainNoExit(String[] args, List<ICompilerProblem> problems, Boolean printProblems)
protected boolean	setupTargetFile() Mxmlc uses target file as the main compilation unit and derive the output SWF file name from this file.
protected void	setupWatcher()
static int	staticMainNoExit(String[] args) Entry point for the <compc> Ant task.
protected void	validateTargetFile() Validate target file.
protected void	waitAndClose() Wait till the workspace to finish compilation and close.
protected void	writeCompilationUnit(ICompilationUnit cu, File outputFolder)

Methods inherited from class java.lang.Object

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

Field Detail

jsOutputType

public static MXMLJSC.JSOutputType jsOutputType

workspace

protected org.apache.royale.compiler.internal.workspaces.Workspace workspace

project

protected RoyaleJSProject project

problems

protected ProblemQuery problems

asFileHandler

protected org.apache.royale.compiler.internal.projects.ISourceFileHandler asFileHandler

config

protected JSConfiguration config

projectConfigurator

protected Configurator projectConfigurator

target

protected ITarget target

targetSettings

protected ITargetSettings targetSettings

jsTarget

protected IJSApplication jsTarget

Constructor Detail

MXMLJSCRoyale

public MXMLJSCRoyale()

MXMLJSCRoyale

public MXMLJSCRoyale(IBackend backend)

Method Detail

getProblemQuery

public ProblemQuery getProblemQuery()

Specified by:

getProblemQuery in interface ProblemQueryProvider

getName

public String getName()

Specified by:

getName in interface org.apache.flex.tools.FlexTool

execute

public int execute(String[] args)

Specified by:

execute in interface org.apache.flex.tools.FlexTool

main

public static void main(String[] args)

Java program entry point.

Parameters:

args - command line arguments

staticMainNoExit

public static int staticMainNoExit(String[] args)

Entry point for the <compc> Ant task.

Parameters:

args - Command line arguments.

Returns:

An exit code.

mainNoExit

public int mainNoExit(String[] args,
                      List<ICompilerProblem> problems,
                      Boolean printProblems)

Specified by:

mainNoExit in interface JSCompilerEntryPoint

setupWatcher

protected void setupWatcher()

compile

protected boolean compile()

Main body of this program. This method is called from the public static method's for this program.

Returns:

true if compiler succeeds

Throws:

IOException

InterruptedException

writeCompilationUnit

protected void writeCompilationUnit(ICompilationUnit cu,
                                    File outputFolder)
                             throws InterruptedException,
                                    IOException

Throws:

InterruptedException

IOException

buildArtifact

protected void buildArtifact()
                      throws InterruptedException,
                             IOException,
                             ConfigurationException

Build target artifact.

Throws:

InterruptedException - threading error

IOException - IO error

ConfigurationException

setupTargetFile

protected boolean setupTargetFile()
                           throws InterruptedException

Mxmlc uses target file as the main compilation unit and derive the output SWF file name from this file.

Returns:

true if successful, false otherwise.

Throws:

ConfigurationException.OnlyOneSource

InterruptedException

createConfigurator

protected Configurator createConfigurator()

Create a new Configurator. This method may be overridden to allow Configurator subclasses to be created that have custom configurations.

Returns:

a new instance or subclass of Configurator.

configure

protected boolean configure(String[] args)

Load configurations from all the sources.

Parameters:

args - command line arguments

Returns:

True if mxmlc should continue with compilation.

getTargetType

protected ITarget.TargetType getTargetType()

validateTargetFile

protected void validateTargetFile()
                           throws ConfigurationException

Validate target file.

Throws:

ConfigurationException.MustSpecifyTarget

ConfigurationException.IOError

ConfigurationException

waitAndClose

protected void waitAndClose()

Wait till the workspace to finish compilation and close.

close

protected void close()

Force terminate the compilation process.

getSourceList

public List<String> getSourceList()

Specified by:

getSourceList in interface JSCompilerEntryPoint

getMainSource

public String getMainSource()

Specified by:

getMainSource in interface JSCompilerEntryPoint