Package org.itsallcode.whiterabbit.api.features

Interface ProgressMonitor

public interface ProgressMonitor
A progress monitor passed to a PluginFeature that allows reporting the progress of process.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    beginTask(String name, int totalWork)
    Notifies that the main task is beginning.
    boolean
    isCanceled()
    Call this method repeatedly to check, if the user wants to cancel the process.
    void
    setTaskName(String name)
    Set the name of the current task shown to the user.
    void
    worked(int work)
    Notifies that a given number of work unit of the main task has been completed.

  • Method Details

    • isCanceled

      boolean isCanceled()
      Call this method repeatedly to check, if the user wants to cancel the process. Abort the process if this returns true.
      Returns:
      true if the user has cancelled the process.

    • beginTask

      void beginTask(String name, int totalWork)
      Notifies that the main task is beginning.
      Parameters:
      name - the name of the current task shown to the user.
      totalWork - the total number of work units that will be done by the task.

    • setTaskName

      void setTaskName(String name)
      Set the name of the current task shown to the user.
      Parameters:
      name - the name of the current task shown to the user.

    • worked

      void worked(int work)
      Notifies that a given number of work unit of the main task has been completed.
      Parameters:
      work - the number of work units just completed.