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

Class FakeModule

java.lang.Object

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

fr.ens.biologie.genomique.eoulsan.modules.FakeModule

All Implemented Interfaces:

Module

public class FakeModule
extends AbstractModule

This module is a fake module.

Since:

1.0

Author:

Laurent Jourdren

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MODULE_NAME

Constructor Summary

Constructors

Constructor	Description
FakeModule()

Method Summary

Modifier and Type	Method	Description
void	configure(StepConfigurationContext context, Set<Parameter> stepParameters)	Set the parameters of the step to configure the module.
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

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

FakeModule

public FakeModule()

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

configure

public void configure(StepConfigurationContext context,
 Set<Parameter> stepParameters)

Description copied from interface: Module

Set the parameters of the step to configure the module.

Specified by:

configure in interface Module

Overrides:

configure in class AbstractModule

Parameters:

context - configuration context. The context can be null for generator steps

stepParameters - parameters of the step

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