MXMLC (Apache Flex - FlexJS: Compiler: Parent 0.8.0-SNAPSHOT API)

java.lang.Object
- org.apache.flex.compiler.clients.MXMLC

All Implemented Interfaces:

org.apache.flex.tools.FlexTool

Direct Known Subclasses:

ASDOC, COMPC
```
public class MXMLC
extends Object
implements org.apache.flex.tools.FlexTool
```
The entry-point class for mxmlc.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MXMLC.ExitCode
Exit code enumerations.

Nested Classes
Modifier and Type	Class and Description
`static class`	`MXMLC.ExitCode` Exit code enumerations.

Field Summary

Fields
Modifier and Type	Field and Description
`Configuration`	`config`
`ConfigurationBuffer`	`configBuffer`
`protected ICompilationUnit`	`mainCU`
`ProblemQuery`	`problems`
`protected FlexProject`	`project`
`protected Configurator`	`projectConfigurator`
`protected long`	`startTime`
`protected SWFTarget`	`target`
`protected ITargetSettings`	`targetSettings`
`protected 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

MXMLC()

Constructors
Constructor and Description
`MXMLC()`

Method Summary

Methods
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.
`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`	`getMainSource()`
`String`	`getName()`
`ProblemQuery`	`getProblems()`
`protected String`	`getProgramName()` Get my program name.
`List<String>`	`getSourceList()`
`protected String`	`getStartMessage()` Get the start up message that contains the program name with the copyright notice.
`ISWF`	`getSWFTarget()`
`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 boolean`	`isFatalFailure(int code)` Determines whether an exit code should be considered a fatal failure, such as for an Ant task.
`static void`	`main(String[] args)` Entry point for the `mxmlc` tool.
`int`	`mainCompileOnly(String[] args, OutputStream err)` Entry point for when you already have an MXML instance and just want to compile and not link.
`int`	`mainNoExit(String[] args)` Entry point for when you already have an MXMLC instance.
`int`	`mainNoExit(String[] args, OutputStream err)` Entry point for when you already have an MXML instance and want to redirect `System.err`.
`void`	`println(String msg)` Print a message.
`protected void`	`reportTargetCompletion()` Reports the size and location of the target that was created.
`protected void`	`setupLocaleSettings()` Setups the locale related settings.
`protected boolean`	`setupTargetFile()` MXMLC uses target file as the main compilation unit and derive the output SWF file name from this file.
`protected void`	`setupThemeFiles()` Setup theme files.
`static int`	`staticMainNoExit(String[] args)` Entry point for the `<mxmlc>` Ant task.
`static List<File>`	`toFiles(List<String> paths)` Convert file path strings to `File` objects.
`static List<IFileSpecification>`	`toFileSpecifications(List<String> paths, Workspace workspace)` Resolve a list of normalized paths to `IFileSpecification` objects from the given `workspace`.
`protected void`	`validateTargetFile()` Validate target file.
`protected void`	`waitAndClose()` Wait till the workspace to finish compilation and close.
`int`	`writeSWF(OutputStream outputStream)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - workspace
```
protected Workspace workspace
```
  - project
```
protected FlexProject project
```
  - config
```
public Configuration config
```
  - problems
```
public ProblemQuery problems
```
  - configBuffer
```
public ConfigurationBuffer configBuffer
```
  - projectConfigurator
```
protected Configurator projectConfigurator
```
  - mainCU
```
protected ICompilationUnit mainCU
```
  - target
```
protected SWFTarget target
```
  - startTime
```
protected long startTime
```
  - targetSettings
```
protected ITargetSettings targetSettings
```
- Constructor Detail
  - MXMLC
```
public MXMLC()
```
- Method Detail
  - main
```
public static void main(String[] args)
```
    Entry point for the mxmlc tool.
    
    Parameters:
    args - Command line arguments.
  - staticMainNoExit
```
public static int staticMainNoExit(String[] args)
```
    Entry point for the <mxmlc> Ant task.
    
    Parameters:
    args - Command line arguments.
    
    Returns:
    An exit code.
  - isFatalFailure
```
public static boolean isFatalFailure(int code)
```
    Determines whether an exit code should be considered a fatal failure, such as for an Ant task.
    
    Parameters:
    code - A numeric exit code.
    
    Returns:
    true if the Ant task failed.
  - 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
  - mainNoExit
```
public int mainNoExit(String[] args)
```
    Entry point for when you already have an MXMLC instance. This is for unit testing.
    
    Parameters:
    args - Command line arguments.
    
    Returns:
    An exit code.
  - mainNoExit
```
public int mainNoExit(String[] args,
             OutputStream err)
```
    Entry point for when you already have an MXML instance and want to redirect System.err. This is for unit testing.
    
    Parameters:
    args - Command line arguments.
    err - An OutputStream to use instead of System.err.
    
    Returns:
    An exit code.
  - mainCompileOnly
```
public int mainCompileOnly(String[] args,
                  OutputStream err)
```
    Entry point for when you already have an MXML instance and just want to compile and not link. This is for FB integration, but other IDEs could use this too.
    
    Parameters:
    args - Command line arguments.
    err - An OutputStream to use instead of System.err.
    
    Returns:
    An exit code.
  - println
```
public void println(String msg)
```
    Print a message.
    
    Parameters:
    msg - Message text.
  - waitAndClose
```
protected void waitAndClose()
```
    Wait till the workspace to finish compilation and close.
  - close
```
protected void close()
```
    Force terminate the compilation process.
  - 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
```
public boolean configure(String[] args)
```
    Load configurations from all the sources.
    
    Parameters:
    args - command line arguments
    
    Returns:
    True if mxmlc should continue with compilation.
  - getConfigurationDefaultVariable
```
protected String getConfigurationDefaultVariable()
```
    Get the default variable for this configuration. MXMLC has a default variable of "file-spec" and COMPC has default variable of "include-classes".
    
    Returns:
    the default variable for the configuration.
  - validateTargetFile
```
protected void validateTargetFile()
                           throws ConfigurationException
```
    Validate target file.
    
    Throws:
    
    ConfigurationException
  - 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
  - setupThemeFiles
```
protected void setupThemeFiles()
```
    Setup theme files.
  - reportTargetCompletion
```
protected void reportTargetCompletion()
                               throws InterruptedException
```
    Reports the size and location of the target that was created.
    
    Throws:
    
    InterruptedException
  - buildArtifact
```
protected void buildArtifact()
                      throws InterruptedException,
                             IOException
```
    Build target artifact.
    
    Throws:
    
    InterruptedException - threading error
    
    IOException - IO error
  - getTargetType
```
protected ITarget.TargetType getTargetType()
```
    Virtual method that returns the type of target we are building. Subclasses will override this method to return different target types.
    
    Returns:
    The ITarget.TargetType of the target we are building.
  - 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:
    
    InterruptedException
  - setupLocaleSettings
```
protected void setupLocaleSettings()
```
    Setups the locale related settings.
  - toFiles
```
public static List<File> toFiles(List<String> paths)
```
    Convert file path strings to File objects. Null values are discarded.
    
    Parameters:
    paths - list of paths.
    
    Returns:
    List of File objects. No null values will be returned.
  - toFileSpecifications
```
public static List<IFileSpecification> toFileSpecifications(List<String> paths,
                                            Workspace workspace)
```
    Resolve a list of normalized paths to IFileSpecification objects from the given workspace.
    
    Parameters:
    paths - A list of normalized paths.
    workspace - Workspace.
    
    Returns:
    A list of file specifications.
  - getProgramName
```
protected String getProgramName()
```
    Get my program name.
    
    Returns:
    always "mxmlc".
  - getStartMessage
```
protected String getStartMessage()
```
    Get the start up message that contains the program name with the copyright notice.
    
    Returns:
    The startup message.
  - isCompc
```
protected boolean isCompc()
```
    "compc" subclass will override this method.
    
    Returns:
    False if the client is not "compc".
  - getProblems
```
public ProblemQuery getProblems()
```
  - getSourceList
```
public List<String> getSourceList()
```
  - getMainSource
```
public String getMainSource()
```
  - getSWFTarget
```
public ISWF getSWFTarget()
```
  - writeSWF
```
public int writeSWF(OutputStream outputStream)
```

Class MXMLC

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

workspace

project

config

problems

configBuffer

projectConfigurator

mainCU

target

startTime

targetSettings

Constructor Detail

MXMLC

Method Detail

main

staticMainNoExit

isFatalFailure

getName

execute

mainNoExit

mainNoExit

mainCompileOnly

println

waitAndClose

close

createConfigurator

configure

getConfigurationDefaultVariable

validateTargetFile

compile

setupThemeFiles

reportTargetCompletion

buildArtifact

getTargetType

setupTargetFile

setupLocaleSettings

toFiles

toFileSpecifications

getProgramName

getStartMessage

isCompc

getProblems

getSourceList

getMainSource

getSWFTarget

writeSWF