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

  • Field Details

    • 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

    • debugPort

      protected Integer debugPort

    • setBeans

      protected boolean setBeans

    • fine

      protected boolean fine

    • moduleImplementationClass

      protected String moduleImplementationClass
      Provide a specific module class implementation at runtime
      Since:
      1.6

  • Constructor Details

    • ExecutableModuleTask

      public ExecutableModuleTask()

  • Method Details

    • 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:

    • 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

    • getDebugPort

      public Integer getDebugPort()
      If we're using a host that supports remote debugging, returns the port to be used.

    • setDebugPort

      public void setDebugPort(Integer debugPort)
      Changes the port to listen at, if we're using a host that supports remote debugging.