Package org.eclipse.epsilon.workflow.tasks

Class ExecutableModuleTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.eclipse.epsilon.workflow.tasks.EpsilonTask

org.eclipse.epsilon.workflow.tasks.ExecutableModuleTask

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

EclTask, EmlTask, EolTask, EplTask, EUnitTask, ExportableModuleTask, FlockTask, PinsetTask

public abstract class ExecutableModuleTask
extends EpsilonTask

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ExecutableModuleTask.ModuleProperty	Allow Epsilon Tasks to have arbitrary nested property settings

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	assertions
protected String	code
protected List<VariableNestedElement>	exportsVariableNestedElements
protected boolean	fine
protected List<ModelNestedElement>	modelNestedElements
protected IEolModule	module
protected String	moduleImplementationClass	Provide a specific module class implementation at runtime
protected List<ParameterNestedElement>	parameterNestedElements
protected Object	result
protected boolean	setBeans
protected File	src
protected String	uri
protected List<VariableNestedElement>	usesVariableNestedElements

Fields inherited from class org.eclipse.epsilon.workflow.tasks.EpsilonTask

failOnErrors, failOnWarnings, profile

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

target, taskName, taskType, wrapper

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

description, location, project

Constructor Summary

Constructors

Constructor	Description
ExecutableModuleTask()

Method Summary

Modifier and Type	Method	Description
void	addText(String msg)
protected void	addVariables(IEolContext context, Map<String,?>... variableMaps)
protected void	configureModule()
protected IEolModule	createAlternativeModule()	Create an alternative module instance from the provided qualified name of the module class
protected abstract IEolModule	createDefaultModule()
VariableNestedElement	createExports()
ModelNestedElement	createModel()
protected IEolModule	createModule()
ExecutableModuleTask.ModuleProperty	createModuleProperty()	Ant constructor for nested elements
ParameterNestedElement	createParameter()
VariableNestedElement	createUses()
protected abstract void	examine()
void	executeImpl()
protected void	exportVariable(String var, String as, boolean optional, boolean ant)
String	getModuleImplementation()
File	getSrc()
String	getTaskName()
String	getUri()
protected abstract void	initialize()
boolean	isAssertions()
boolean	isDebug()	Returns whether the debugger will be used (true) or not (false).
boolean	isFine()
boolean	isGUI()	Returns whether Epsilon's graphical user input facilities should be enabled or not.
boolean	isSetBeans()
protected void	populateModelRepository(Boolean mustReload)
void	setAssertions(boolean assertions)
void	setDebug(boolean isDebug)	Changes whether the debugger should be used (true) or not (false) for this module.
void	setFine(boolean fine)
void	setGUI(boolean gui)	Changes whether Epsilon's graphical user input facilities should be enabled or not.
void	setModuleImplementation(String moduleImplementation)
void	setSetBeans(boolean setBeans)
void	setSrc(File src)
void	setUri(String uri)
protected void	useResults()
protected void	useVariable(String var, String as, boolean optional, boolean ant)

Methods inherited from class org.eclipse.epsilon.workflow.tasks.EpsilonTask

execute, fail, getActiveTransactions, getBaseDir, getExtendedProperties, getModelRepository, getProjectRepository, getProjectStackFrame, isFailOnErrors, isFailOnWarnings, isProfile, setFailOnErrors, setFailOnWarnings, setProfile, setProjectRepository, usesSharedModelRepository, warn

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

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, 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

modelNestedElements

protected List<ModelNestedElement> modelNestedElements

usesVariableNestedElements

protected List<VariableNestedElement> usesVariableNestedElements

exportsVariableNestedElements

protected List<VariableNestedElement> exportsVariableNestedElements

parameterNestedElements

protected List<ParameterNestedElement> parameterNestedElements

src

protected File src

code

protected String code

module

protected IEolModule module

assertions

protected boolean assertions

uri

protected String uri

result

protected Object result

setBeans

protected boolean setBeans

fine

protected boolean fine

moduleImplementationClass

protected String moduleImplementationClass

Provide a specific module class implementation at runtime

Since:

1.6

Constructor Detail

ExecutableModuleTask

public ExecutableModuleTask()

Method Detail

createModel

public ModelNestedElement createModel()

createUses

public VariableNestedElement createUses()

createExports

public VariableNestedElement createExports()

createParameter

public ParameterNestedElement createParameter()

configureModule

protected void configureModule()
                        throws EolModelNotFoundException,
                               org.apache.tools.ant.BuildException,
                               EolModelLoadingException

Throws:

EolModelNotFoundException

org.apache.tools.ant.BuildException

EolModelLoadingException

addVariables

protected void addVariables(IEolContext context,
                            Map<String,?>... variableMaps)

useResults

protected void useResults()
                   throws Exception

Throws:

Exception

populateModelRepository

protected void populateModelRepository(Boolean mustReload)
                                throws EolModelNotFoundException,
                                       EolModelLoadingException

Throws:

EolModelNotFoundException

EolModelLoadingException

getTaskName

public String getTaskName()

Overrides:

getTaskName in class org.apache.tools.ant.Task

executeImpl

public void executeImpl()
                 throws org.apache.tools.ant.BuildException

Specified by:

executeImpl in class EpsilonTask

Throws:

org.apache.tools.ant.BuildException

addText

public void addText(String msg)

getSrc

public File getSrc()

setSrc

public void setSrc(File src)

setUri

public void setUri(String uri)

getUri

public String getUri()

isAssertions

public boolean isAssertions()

setAssertions

public void setAssertions(boolean assertions)

setGUI

public void setGUI(boolean gui)

Changes whether Epsilon's graphical user input facilities should be enabled or not. By default, they are enabled for all tasks except for the EUnit Ant task, in which they are disabled.

isGUI

public boolean isGUI()

Returns whether Epsilon's graphical user input facilities should be enabled or not.

See Also:

setGUI(boolean)

setDebug

public void setDebug(boolean isDebug)

Changes whether the debugger should be used (true) or not (false) for this module. By default, it is not used.

isDebug

public boolean isDebug()

Returns whether the debugger will be used (true) or not (false).

useVariable

protected void useVariable(String var,
                           String as,
                           boolean optional,
                           boolean ant)

exportVariable

protected void exportVariable(String var,
                              String as,
                              boolean optional,
                              boolean ant)

setSetBeans

public void setSetBeans(boolean setBeans)

isSetBeans

public boolean isSetBeans()

isFine

public boolean isFine()

setFine

public void setFine(boolean fine)

initialize

protected abstract void initialize()
                            throws Exception

Throws:

Exception

examine

protected abstract void examine()
                         throws Exception

Throws:

Exception

createDefaultModule

protected abstract IEolModule createDefaultModule()
                                           throws Exception

Throws:

Exception

createModule

protected IEolModule createModule()
                           throws Exception

Throws:

Exception

getModuleImplementation

public String getModuleImplementation()

setModuleImplementation

public void setModuleImplementation(String moduleImplementation)

createModuleProperty

public ExecutableModuleTask.ModuleProperty createModuleProperty()

Ant constructor for nested elements

createAlternativeModule

protected IEolModule createAlternativeModule()
                                      throws Exception

Create an alternative module instance from the provided qualified name of the module class

Returns:

The instantiated and configured IEolModule.

Throws:

Exception - If there is an error instantiating the module class and/or configuring the module

Since:

1.6