Package fr.ens.biologie.genomique.eoulsan.modules

Class TerminalModule

java.lang.Object

fr.ens.biologie.genomique.eoulsan.modules.AbstractModule

fr.ens.biologie.genomique.eoulsan.modules.TerminalModule

All Implemented Interfaces:

Module

public class TerminalModule
extends AbstractModule

This class define a terminal task that do nothing. After this execution the workflow will stop.

Since:

1.0

Author:

Laurent Jourdren

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MODULE_NAME

Constructor Summary

Constructors

Constructor	Description
TerminalModule()

Method Summary

Modifier and Type	Method	Description
TaskResult	execute(TaskContext context, TaskStatus status)	Execute a task step.
String	getName()	Get the name of the module.
fr.ens.biologie.genomique.kenetre.util.Version	getVersion()	Get version of the Module.

Methods inherited from class fr.ens.biologie.genomique.eoulsan.modules.AbstractModule

configure, getChecker, getDescription, getInputPorts, getOutputPorts, getParallelizationMode, getRequiredEoulsanVersion, getRequirements

Methods inherited from class java.lang.Object

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

Field Details

MODULE_NAME

public static final String MODULE_NAME

See Also:

• Constant Field Values

Constructor Details

TerminalModule

public TerminalModule()

Method Details

getName

public String getName()

Description copied from interface: Module

Get the name of the module.

Returns:

the name of the module

getVersion

public fr.ens.biologie.genomique.kenetre.util.Version getVersion()

Description copied from interface: Module

Get version of the Module.

Returns:

a Version object with the version of the Module

execute

public TaskResult execute(TaskContext context,
 TaskStatus status)

Description copied from interface: Module

Execute a task step.

Parameters:

context - Execution context

status - of the task

Returns:

a TaskResult object