Package org.topbraid.jenax.progress

Interface ProgressMonitor

All Known Implementing Classes:
NullProgressMonitor, SimpleProgressMonitor
public interface ProgressMonitor
Inspired by the Eclipse IProgressMonitor, this interface supports monitoring long-running processes with intermediate status messages and the ability to cancel.
Author:
Holger Knublauch

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    beginTask(String label, int totalWork)
    Informs the progress monitor that a new task has been started, with a given number of expected steps.
    void
    done()
    Informs the progress monitor that all is completed.
    boolean
    isCanceled()
    Typically used by the (long-running) process to determine whether the user has requested cancellation.
    void
    setCanceled(boolean value)
    Typically called from a parallel thread triggered by the user, this informs the progress monitor that it needs to return true for isCanceled.
    void
    setTaskName(String value)
    Changes the name or label of the current task.
    void
    subTask(String label)
    Sets the label that serves as sub-task, typically printed under the main task name.
    void
    worked(int amount)
    Informs the progress monitor that one or more steps have been completed towards the current task (see beginTask).

  • Method Details

    • isCanceled

      boolean isCanceled()
      Typically used by the (long-running) process to determine whether the user has requested cancellation. The process should then find a suitable, clean termination.
      Returns:
      true if cancel was requested

    • beginTask

      void beginTask(String label, int totalWork)
      Informs the progress monitor that a new task has been started, with a given number of expected steps. A UI connected to the ProgressMonitor would typically display something like a progress bar and the task name.
      Parameters:
      label - the name of the task
      totalWork - the number of steps (see worked) that is expected to be needed to complete the task

    • done

      void done()
      Informs the progress monitor that all is completed.

    • setCanceled

      void setCanceled(boolean value)
      Typically called from a parallel thread triggered by the user, this informs the progress monitor that it needs to return true for isCanceled. Once a process has been canceled, it should not be un-canceled.
      Parameters:
      value - true if canceled

    • setTaskName

      void setTaskName(String value)
      Changes the name or label of the current task.
      Parameters:
      value -

    • subTask

      void subTask(String label)
      Sets the label that serves as sub-task, typically printed under the main task name.
      Parameters:
      label - the subtask label

    • worked

      void worked(int amount)
      Informs the progress monitor that one or more steps have been completed towards the current task (see beginTask).
      Parameters:
      amount - the number of steps completed