org.apache.flex.compiler.clients

Class ASDOC

java.lang.Object

org.apache.flex.compiler.clients.MXMLC

org.apache.flex.compiler.clients.ASDOC

All Implemented Interfaces:

org.apache.flex.tools.FlexTool

public class ASDOC
extends MXMLC
implements org.apache.flex.tools.FlexTool

Documentation compiler entry point.

This class is a quick start of component compiler. It depends on most of the functionalities developed for mxmlc.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flex.compiler.clients.MXMLC

MXMLC.ExitCode

Field Summary

Fields inherited from class org.apache.flex.compiler.clients.MXMLC

config, configBuffer, mainCU, problems, project, projectConfigurator, startTime, target, targetSettings, 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
ASDOC()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	buildArtifact() Build SWC library artifact.
boolean	configure(String[] args) Load configurations from all the sources.
protected Configurator	createConfigurator() Create a new Configurator.
int	execute(String[] args)
protected String	getConfigurationDefaultVariable() Get the default variable for this configuration.
String	getName()
protected String	getProgramName() Get my program name.
protected String	getStartMessage() Get the start up message that contains the program name with the copyright notice.
protected ITarget.TargetType	getTargetType() Virtual method that returns the type of target we are building.
protected boolean	isCompc() "compc" subclass will override this method.
static void	main(String[] args) Entry point for compc tool.
protected void	reportTargetCompletion() Reports the size and location of the target that was created.
protected boolean	setupTargetFile() Compc uses the target file as the output SWC file name.
static int	staticMainNoExit(String[] args) Entry point for the <compc> Ant task.
protected void	validateTargetFile() Compc uses the target file as the output SWC file name if provided.

Methods inherited from class org.apache.flex.compiler.clients.MXMLC

close, compile, getMainSource, getProblems, getSourceList, getSWFTarget, isFatalFailure, mainCompileOnly, mainNoExit, mainNoExit, println, setupLocaleSettings, setupThemeFiles, toFiles, toFileSpecifications, waitAndClose, writeSWF

Methods inherited from class java.lang.Object

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

Constructor Detail

ASDOC

public ASDOC()

Method Detail

main

public static void main(String[] args)

Entry point for compc tool.

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.

getName

public String getName()

Specified by:

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

Overrides:

getName in class MXMLC

execute

public int execute(String[] args)

Specified by:

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

Overrides:

execute in class MXMLC

configure

public boolean configure(String[] args)

Description copied from class: MXMLC

Load configurations from all the sources.

Overrides:

configure in class MXMLC

Parameters:

args - command line arguments

Returns:

True if mxmlc should continue with compilation.

getConfigurationDefaultVariable

protected String getConfigurationDefaultVariable()

Description copied from class: MXMLC

Get the default variable for this configuration. MXMLC has a default variable of "file-spec" and COMPC has default variable of "include-classes".

Overrides:

getConfigurationDefaultVariable in class MXMLC

Returns:

the default variable for the configuration.

createConfigurator

protected Configurator createConfigurator()

Description copied from class: MXMLC

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

Overrides:

createConfigurator in class MXMLC

Returns:

a new instance or subclass of Configurator.

getProgramName

protected String getProgramName()

Description copied from class: MXMLC

Get my program name.

Overrides:

getProgramName in class MXMLC

Returns:

always "mxmlc".

getStartMessage

protected String getStartMessage()

Description copied from class: MXMLC

Get the start up message that contains the program name with the copyright notice.

Overrides:

getStartMessage in class MXMLC

Returns:

The startup message.

buildArtifact

protected void buildArtifact()
                      throws InterruptedException,
                             IOException

Build SWC library artifact. The compilation units are already built at this point.

Overrides:

buildArtifact in class MXMLC

Throws:

InterruptedException - threading error

IOException - IO error

reportTargetCompletion

protected void reportTargetCompletion()

Description copied from class: MXMLC

Reports the size and location of the target that was created.

Overrides:

reportTargetCompletion in class MXMLC

setupTargetFile

protected boolean setupTargetFile()
                           throws InterruptedException

Compc uses the target file as the output SWC file name. Nothing needs to be done here.

Overrides:

setupTargetFile in class MXMLC

Returns:

true if successful, false otherwise.

Throws:

InterruptedException

validateTargetFile

protected void validateTargetFile()
                           throws ConfigurationException

Compc uses the target file as the output SWC file name if provided. Nothing needs to be done here.

Overrides:

validateTargetFile in class MXMLC

Throws:

ConfigurationException

isCompc

protected boolean isCompc()

Description copied from class: MXMLC

"compc" subclass will override this method.

Overrides:

isCompc in class MXMLC

Returns:

False if the client is not "compc".

getTargetType

protected ITarget.TargetType getTargetType()

Description copied from class: MXMLC

Virtual method that returns the type of target we are building. Subclasses will override this method to return different target types.

Overrides:

getTargetType in class MXMLC

Returns:

The ITarget.TargetType of the target we are building.