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

Class ShellModule

java.lang.Object
fr.ens.biologie.genomique.eoulsan.modules.AbstractModule
fr.ens.biologie.genomique.eoulsan.modules.ShellModule
All Implemented Interfaces:
Module
public class ShellModule extends AbstractModule
This class define a module that execute a shell command. It use the user shell to execute the command. The launched command is : $SHELL -c "command"
Author:
Laurent Jourdren

  • Constructor Details

    • ShellModule

      public ShellModule()

  • Method Details

    • getName

      public String getName()
      Description copied from interface: Module
      Get the name of the module.
      Returns:
      the name of the module

    • getDescription

      public String getDescription()
      Description copied from interface: Module
      Get the description of the module
      Specified by:
      getDescription in interface Module
      Overrides:
      getDescription in class AbstractModule
      Returns:
      the description 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) throws EoulsanException
      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
      Throws:
      EoulsanException - if a parameter is invalid

    • 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