flex2.tools.oem

Interface Builder

All Known Implementing Classes:

Application, BuilderApplication, BuilderLibrary, Library

public interface Builder

The Builder interface lists the common configuration and build-cycle methods. The Application and Library classes both implement this interface.

Version:

2.0.1

Author:

Clement Wong

See Also:

Application, Library

Field Summary

Fields

Modifier and Type	Field and Description
static int	FAIL Application.compile() or Library.compile() failed to compile.
static int	LINK Application.compile() or Library.compile() did not compile but advise the caller to link again.
static int	OK Application.compile() or Library.compile() compiled successfully.
static int	SKIP Application.compile() or Library.compile() did not compile anything.

Method Summary

Methods

Modifier and Type	Method and Description
long	build(boolean incremental) Builds the object.
long	build(OutputStream out, boolean incremental) Builds the object.
void	clean() If you called the setOutput() method, this method deletes the Application or Library file.
Benchmark	getBenchmark() Gets the overall performance data for the last build.
Map<String,PerformanceData[]>	getCompilerBenchmarks() Gets the performance data for each compiler phase for the last build.
Configuration	getConfiguration() Gets the compiler options for this object.
Configuration	getDefaultConfiguration() Gets the default compiler options.
Logger	getLogger() Gets the logger for this object.
File	getOutput()
Report	getReport() Reports information about the current compilation.
void	load(InputStream in) Loads compilation data from a previous compilation.
long	save(OutputStream out) Saves the current compilation data.
void	setApplicationCache(ApplicationCache applicationCache) Sets the application cache to be shared by all the applications and libraries in the current workspace.
void	setConfiguration(Configuration configuration) Sets the compiler options for this object.
void	setLogger(Logger logger) Sets the logger for this object.
void	setPathResolver(PathResolver resolver) Sets the path resolver for this object.
void	setProgressMeter(ProgressMeter meter) Sets the progress meter for this object.
void	setSupportedFileExtensions(String mimeType, String[] extensions) Sets the custom file extensions for this object.
void	setSwcCache(LibraryCache libraryCache) Sets the library cache to be shared by all the applications and libraries in the current project.
void	stop() Stops the compilation.

Field Detail

SKIP

static final int SKIP

Application.compile() or Library.compile() did not compile anything.

See Also:

Constant Field Values

LINK

static final int LINK

Application.compile() or Library.compile() did not compile but advise the caller to link again.

See Also:

Constant Field Values

OK

static final int OK

Application.compile() or Library.compile() compiled successfully.

See Also:

Constant Field Values

FAIL

static final int FAIL

Application.compile() or Library.compile() failed to compile.

See Also:

Constant Field Values

Method Detail

setConfiguration

void setConfiguration(Configuration configuration)

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

Parameters:

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

See Also:

Configuration

getDefaultConfiguration

Configuration getDefaultConfiguration()

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.

Returns:

An instance of an object that implements the Configuration interface.

See Also:

Configuration

getConfiguration

Configuration getConfiguration()

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

Returns:

An instance of an object that implements the Configuration interface.

See Also:

Configuration

getCompilerBenchmarks

Map<String,PerformanceData[]> getCompilerBenchmarks()

Gets the performance data for each compiler phase for the last build.

Returns:

A map of compiler phase to PerformanceData.

getBenchmark

Benchmark getBenchmark()

Gets the overall performance data for the last build.

Returns:

a Benchmark object.

setLogger

void setLogger(Logger logger)

Sets the logger for this object. The compiler uses the logger to notify clients of events that occurred during the compilation.

Parameters:

logger - An object that implements the Logger interface.

See Also:

Logger

getLogger

Logger getLogger()

Gets the logger for this object. This method returns null if the setLogger() method was not called.

Returns:

An object that implements the Logger interface.

See Also:

Logger

setSupportedFileExtensions

void setSupportedFileExtensions(String mimeType,
                              String[] extensions)

Sets the custom file extensions for this object. For example:

 setSupportedFileExtensions(flex2.compiler.util.MimeMappings.MXML, new String[] {".foo"});
 

This example instructs the compiler to treat files with the *.foo extension as MXML documents. The supported MIME types are specified in the flex2.compiler.util.MimeMappings class as constants.

Parameters:

mimeType - MIME type.

extensions - An array of file extensions.

setProgressMeter

void setProgressMeter(ProgressMeter meter)

Sets the progress meter for this object. This method is optional. You can set a progress meter so that it receives periodic updates during the compilation.

Parameters:

meter - An object that implements the ProgressMeter interface.

See Also:

ProgressMeter

setPathResolver

void setPathResolver(PathResolver resolver)

Sets the path resolver for this object. This method is optional.

Parameters:

resolver - A path resolver

See Also:

PathResolver

setApplicationCache

void setApplicationCache(ApplicationCache applicationCache)

Sets the application cache to be shared by all the applications and libraries in the current workspace.

Parameters:

applicationCache - The cache.

setSwcCache

void setSwcCache(LibraryCache libraryCache)

Sets the library cache to be shared by all the applications and libraries in the current project.

Parameters:

libraryCache - The cache.

build

long build(boolean incremental)
           throws IOException

Builds the object. If the incremental input argument is false, this method recompiles all parts of the object. If the incremental input argument is true, this method compiles only the parts of the object that have changed since the last compilation.

You must call the setOutput() method before calling this method. The result is saved to the location specified by the getOutput() method. If there is no output destination specified, this method does nothing and returns 0.

Parameters:

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

Returns:

The number of bytes written out.

Throws:

IOException - Thrown when an I/O error occurs during compilation.

See Also:

Application, Library

build

long build(OutputStream out,
         boolean incremental)
           throws IOException

Builds the object. If the incremental input argument is false, this method recompiles all parts of the object. If the incremental input argument is true, this method compiles only the parts of the object that have changed since the last compilation.

This method only outputs to the specified OutputStream. For better performance, the OutputStream should be buffered. This method does not output to the destination specified by the setOutput() method.

Parameters:

out - The OutputStream.

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

Returns:

The number of bytes written out. This method returns 0 if the object fails to compile.

Throws:

IOException - Thrown when an I/O error occurs during compilation.

stop

void stop()

Stops the compilation. If the client runs the compiler in a background thread, it can use this method to stop the compilation. The compiler does not stop immediately, but stops the compilation when it reaches a stable state.

clean

void clean()

If you called the setOutput() method, this method deletes the Application or Library file. Calls to the build() method trigger a full recompilation.

The clean() method does not remove compiler options or reset the output location.

load

void load(InputStream in)
          throws IOException

Loads compilation data from a previous compilation. This method is usually called before the build() method.

Parameters:

in - The InputStream.

Throws:

IOException - Thrown when an I/O error occurs while loading the compilation data.

save

long save(OutputStream out)
          throws IOException

Saves the current compilation data. This method is usually called after the build() method.

Do not use this to create a SWF or SWC file. Use the build() method instead.

Parameters:

out - The OutputStream.

Returns:

The number of bytes written out.

Throws:

IOException - Thrown when an I/O error occurs while saving the compilation data.

getReport

Report getReport()

Reports information about the current compilation. This method returns null if you have not yet called the build(boolean), build(OutputStream, boolean), or compile(boolean) methods.

The Report object includes the following information:

1. Number of source files used in the compilation.
2. The location of the source files.
3. Number of asset files that are embedded in the Application or Library.
4. The location of the asset files.
5. The dependencies of the source files.

You must call the getReport() method to get a new report after each call to the build() method.

Returns:

An object that implements the Report interface.

getOutput

File getOutput()