Package org.eclipse.emf.common.util

Interface Monitor

All Known Implementing Classes:
BasicMonitor, BasicMonitor.Delegating, BasicMonitor.EclipseSubProgress, BasicMonitor.Printing
public interface Monitor
An task monitor that provides control and feedback.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    UNKNOWN
    Represents an unknown amount or work.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    beginTask(String name, int totalWork)
    Called once per instance to indicate the name of the task and its expected duration.
    void
    clearBlocked()
    Clears the reason for the activity being blocked.
    void
    done()
    Called to indicate the task is complete.
    void
    internalWorked(double work)
    Called by subprogress monitors to do fractional work.
    boolean
    isCanceled()
    Returns whether the activity has been canceled.
    void
    setBlocked(Diagnostic reason)
    Sets the reason for the activity being blocked.
    void
    setCanceled(boolean value)
    Sets whether the active should be canceled.
    void
    setTaskName(String name)
    Update the task name.
    void
    subTask(String name)
    Sets the current subtask of the overall task.
    void
    worked(int work)
    Called to indicate the amount or progress on the task.

  • Field Details

    • UNKNOWN

      static final int UNKNOWN
      Represents an unknown amount or work.
      See Also:

  • Method Details

    • isCanceled

      boolean isCanceled()
      Returns whether the activity has been canceled.

    • setCanceled

      void setCanceled(boolean value)
      Sets whether the active should be canceled.

    • setBlocked

      void setBlocked(Diagnostic reason)
      Sets the reason for the activity being blocked.

    • clearBlocked

      void clearBlocked()
      Clears the reason for the activity being blocked.

    • beginTask

      void beginTask(String name, int totalWork)
      Called once per instance to indicate the name of the task and its expected duration.

    • setTaskName

      void setTaskName(String name)
      Update the task name.

    • subTask

      void subTask(String name)
      Sets the current subtask of the overall task.

    • worked

      void worked(int work)
      Called to indicate the amount or progress on the task.

    • internalWorked

      void internalWorked(double work)
      Called by subprogress monitors to do fractional work.

    • done

      void done()
      Called to indicate the task is complete.