Package fr.ens.biologie.genomique.eoulsan.core

Interface TaskStatus

All Superinterfaces:
Progress
All Known Implementing Classes:
TaskStatusImpl
public interface TaskStatus extends Progress
This interface define a step status.
Since:
2.0
Author:
Laurent Jourdren

  • Method Details

    • getCounters

      Map<String,Long> getCounters()
      Get the sample counters.
      Returns:
      the sample counters as a map

    • getDescription

      String getDescription()
      Get the context description.
      Returns:
      a String with the context description

    • setDescription

      void setDescription(String description)
      Set the context description.
      Parameters:
      description - the description to set

    • getCommandLine

      String getCommandLine()
      Get the context command line.
      Returns:
      a String with the context command line

    • setCommandLine

      void setCommandLine(String commandLine)
      Set the context command line.
      Parameters:
      commandLine - the command line to set

    • getDockerImage

      String getDockerImage()
      Get the context docker image.
      Returns:
      a String with the context docker image

    • setDockerImage

      void setDockerImage(String dockerImage)
      Set the context docker image.
      Parameters:
      dockerImage - the command line to set

    • setCounters

      void setCounters(fr.ens.biologie.genomique.kenetre.util.Reporter reporter, String counterGroup)
      Set the context counters.
      Parameters:
      reporter - the reporter
      counterGroup - counter group to use with the reporter

    • createTaskResult

      TaskResult createTaskResult()
      Create a TaskResult object for a successful result.
      Returns:
      a TaskResult object

    • createTaskResult

      TaskResult createTaskResult(boolean success)
      Create a TaskResult object.
      Parameters:
      success - true if the task is successful
      Returns:
      a TaskResult object

    • createTaskResult

      TaskResult createTaskResult(Throwable exception, String exceptionMessage)
      Create a TaskResult object.
      Parameters:
      exception - exception of the error
      exceptionMessage - Error message
      Returns:
      a TaskResult object

    • createTaskResult

      TaskResult createTaskResult(Throwable exception)
      Create a TaskResult object.
      Parameters:
      exception - exception of the error
      Returns:
      a TaskResult object