org.apache.flex.compiler.ant

Class FlexTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.Java

org.apache.flex.compiler.ant.FlexTask

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

COMPCTask, MXMLCTask

public abstract class FlexTask
extends org.apache.tools.ant.taskdefs.Java

This class contains common data and logic used by all the Flex Ant tasks.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.tools.ant.types.Commandline	cmdline The commandline used in execute()
protected ConfigVariable[]	configVariables An array of ConfigVariabes that are set by setDynamicAttribute().
protected boolean	fork fork attribute
protected List<IOptionSource>	nestedAttribs
protected static OptionSpec	RUNTIME_SHARED_LIBRARY_PATH

Fields inherited from class org.apache.tools.ant.taskdefs.Java

redirector, redirectorElement

Fields inherited from class org.apache.tools.ant.Task

target, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FlexTask(String taskName, ConfigVariable[] configVariables, String toolJARFileName, String toolClassName, String toolMethodName, String toolFailureMethodName) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Object	createDynamicElement(String elementName)
protected NestedAttributeElement	createElem(String[] attribs, OptionSpec spec)
protected NestedAttributeElement	createElem(String attrib, OptionSpec spec)
protected NestedAttributeElement	createElemAllowAppend(String[] attribs, OptionSpec spec)
void	execute() Execute the task
protected abstract void	prepareCommandline() Called by execute after the set ConfigVariables in vars has been added to the commandline.
void	setDynamicAttribute(String attributeName, String value) Set the named attribute to the given value.
void	setFork(boolean f) Sets whether to run the task in a separate VM.

Methods inherited from class org.apache.tools.ant.taskdefs.Java

addAssertions, addConfiguredRedirector, addEnv, addSysproperty, addSyspropertyset, clearArgs, createArg, createBootclasspath, createClasspath, createJvmarg, createPermissions, createWatchdog, executeJava, getCommandLine, getSysProperties, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, maybeSetResultPropertyValue, run, setAppend, setArgs, setClassname, setClasspath, setClasspathRef, setCloneVm, setDir, setError, setErrorProperty, setFailonerror, setInput, setInputString, setJar, setJvm, setJvmargs, setJVMVersion, setLogError, setMaxmemory, setNewenvironment, setOutput, setOutputproperty, setResultProperty, setSpawn, setTimeout, setupRedirector

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Field Detail

RUNTIME_SHARED_LIBRARY_PATH

protected static OptionSpec RUNTIME_SHARED_LIBRARY_PATH

configVariables

protected final ConfigVariable[] configVariables

An array of ConfigVariabes that are set by setDynamicAttribute().

cmdline

protected final org.apache.tools.ant.types.Commandline cmdline

The commandline used in execute()

nestedAttribs

protected List<IOptionSource> nestedAttribs

fork

protected boolean fork

fork attribute

Constructor Detail

FlexTask

protected FlexTask(String taskName,
        ConfigVariable[] configVariables,
        String toolJARFileName,
        String toolClassName,
        String toolMethodName,
        String toolFailureMethodName)

Constructor.

Parameters:

taskName - The name of the Ant task.

configVariables - An array of ConfigVariables that will be set by attributes of the task.

toolJARFileName - The build tool's jar file.

toolClassName - The build tool's class name.

toolMethodName - The build tool's method name.

toolFailureMethodName - The build tool's method to determine whether an exit code means failure.

Method Detail

createElem

protected NestedAttributeElement createElem(String attrib,
                                OptionSpec spec)

createElem

protected NestedAttributeElement createElem(String[] attribs,
                                OptionSpec spec)

createElemAllowAppend

protected NestedAttributeElement createElemAllowAppend(String[] attribs,
                                           OptionSpec spec)

setFork

public void setFork(boolean f)

Sets whether to run the task in a separate VM.

Overrides:

setFork in class org.apache.tools.ant.taskdefs.Java

Parameters:

f - if true then run in a separate VM.

setDynamicAttribute

public void setDynamicAttribute(String attributeName,
                       String value)

Set the named attribute to the given value.

Parameters:

attributeName - The name of the attribute to set

value - The value to set the named attribute to

createDynamicElement

public Object createDynamicElement(String elementName)

prepareCommandline

protected abstract void prepareCommandline()
                                    throws org.apache.tools.ant.BuildException

Called by execute after the set ConfigVariables in vars has been added to the commandline. This function is responsible for adding all tool-specific options to the commandline as well as setting the default options of a build tool.

Throws:

org.apache.tools.ant.BuildException

execute

public final void execute()
                   throws org.apache.tools.ant.BuildException

Execute the task

Overrides:

execute in class org.apache.tools.ant.taskdefs.Java

Throws:

org.apache.tools.ant.BuildException - If running build tool failed