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

Interface Progress

All Known Subinterfaces:
TaskStatus
All Known Implementing Classes:
TaskStatusImpl
public interface Progress
This interface allow to set the progress of a task.
Since:
2.0
Author:
Laurent Jourdren

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getProgress()
    Get the progress of the context processing.
    String
    getProgressMessage()
    Get the progress message.
    void
    setProgress(double progress)
    Set the progress of the processing.
    void
    setProgress(int min, int max, int value)
    Set the progress of the processing.
    void
    setProgressMessage(String message)
    Set the progress message.

  • Method Details

    • getProgressMessage

      String getProgressMessage()
      Get the progress message.
      Returns:
      the message for the context

    • getProgress

      double getProgress()
      Get the progress of the context processing.
      Returns:
      the progress of the processing of the sample as percent (between 0.0 and 1.0)

    • setProgressMessage

      void setProgressMessage(String message)
      Set the progress message.
      Parameters:
      message - the message to set

    • setProgress

      void setProgress(int min, int max, int value)
      Set the progress of the processing.
      Parameters:
      min - minimal value of the progress
      max - maximal value of the progress
      value - current value of the progress

    • setProgress

      void setProgress(double progress)
      Set the progress of the processing.
      Parameters:
      progress - value of the progress. This value must be greater or equals to 0 and lower or equals to 1.0