flex2.tools.flexbuilder

Class BuilderLibrary

java.lang.Object

flex2.tools.oem.Library

flex2.tools.flexbuilder.BuilderLibrary

All Implemented Interfaces:

Builder, Cloneable

public class BuilderLibrary
extends Library

BuilderLibrary is a subclass of flex2.tools.oem.Library. It does not have new methods but it overrides Library.compile().BuilderLibrary.compile() processes the compc command-line arguments in BuilderConfiguration before calling super.compile(). The argument processing extraces the following arguments: 1. dump-config: creates a File (absolute or relative to the current working directory) - same behavior as compc. 2. compiler.debug: calls Configuration.enableDebugging(). 3. compiler.accessible: calls Configuration.enableAccessibility(). 4. compiler.strict: calls Configuration.enableStrictChecking(). 5. help: do nothing. 6. output/directory: calls Library.setOutput() if -directory=false. Calls Library.setDirectory if -directory=true. The output is absolute or relative to the current working directory) - same behavior as compc. 7. version: do nothing. 8. include-classes: calls Library.addComponent(). 9. include-file: calls Library.addArchiveFile(). The file is absolute or relative to the current working directory - same behavior as compc. 10. include-namespaces: calls Library.addComponent(). 11. include-resource-bundles: calls Library.addResourceBundle(). 12. include-sources: calls Library.addComponent(). No valid compc command-line arguments should cause this argument processing to fail. FB should expect the argument processing to be consistent with compc (including absolute and relative paths). Any inconsistencies are considered Compiler API bugs. If the behavior is the same but it's incorrect, it's considered a compc command-line parsing bug. The only two execeptions are -help and -version. -help and -version will not do anything. FB should use F1 for help and `About Flex Builder' for showing compiler version.

Field Summary

Fields inherited from class flex2.tools.oem.Library

resolver

Fields inherited from interface flex2.tools.oem.Builder

FAIL, LINK, OK, SKIP

Constructor Summary

Constructors

Constructor and Description
BuilderLibrary()

Method Summary

Methods

Modifier and Type	Method and Description
protected int	compile(boolean incremental) Compiles the Library.
Configuration	getConfiguration() Gets the compiler options for this object.
Configuration	getDefaultConfiguration() Gets the default compiler options.
void	setConfiguration(Configuration configuration) Sets the compiler options for this object.

Methods inherited from class flex2.tools.oem.Library

addArchiveFile, addArchiveFile, addComponent, addComponent, addComponent, addComponent, addResourceBundle, addStyleSheet, addStyleSheet, build, build, clean, clone, convertMessages, getApplicationCache, getBenchmark, getCompilerBenchmarks, getDirectory, getLogger, getOutput, getReport, getSwcCache, link, load, refreshLastModified, removeAllArchiveFiles, removeAllComponents, removeAllResourceBundles, removeAllStyleSheets, removeArchiveFile, removeComponent, removeComponent, removeComponent, removeComponent, removeResourceBundle, removeStyleSheet, save, setApplicationCache, setDirectory, setLogger, setOutput, setPathResolver, setProgressMeter, setSupportedFileExtensions, setSwcCache, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

BuilderLibrary

public BuilderLibrary()

Method Detail

getDefaultConfiguration

public Configuration getDefaultConfiguration()

Description copied from interface: Builder

Gets the default compiler options. The default values are specified in the flex-config.xml file. You can override the default values by using methods of the Configuration interface.

This method returns the default compiler options in new Configuration objects.

Specified by:

getDefaultConfiguration in interface Builder

Overrides:

getDefaultConfiguration in class Library

Returns:

An instance of an object that implements the Configuration interface.

See Also:

Configuration

setConfiguration

public void setConfiguration(Configuration configuration)

Description copied from interface: Builder

Sets the compiler options for this object. You use the getDefaultConfiguration() method to get a Configuration object.

Specified by:

setConfiguration in interface Builder

Overrides:

setConfiguration in class Library

Parameters:

configuration - An instance of an object that implements the Configuration interface.

See Also:

Configuration

getConfiguration

public Configuration getConfiguration()

Description copied from interface: Builder

Gets the compiler options for this object. Unlike the getDefaultConfiguration() method, this method returns null if the setConfiguration() method was not called.

Specified by:

getConfiguration in interface Builder

Overrides:

getConfiguration in class Library

Returns:

An instance of an object that implements the Configuration interface.

See Also:

Configuration

compile

protected int compile(boolean incremental)

Description copied from class: Library

Compiles the Library. This method does not link the Library.

Overrides:

compile in class Library

Parameters:

incremental - If true, build incrementally; if false, rebuild.

Returns:

Builder.OK if this method call resulted in compilation of some/all parts of the application; Builder.LINK if this method call did not compile anything in the application but advise the caller to link again; Builder.SKIP if this method call did not compile anything in the application; Builder.FAIL if this method call encountered errors during compilation.