Package org.eclipse.core.runtime

Class ProgressMonitorWrapper

java.lang.Object
org.eclipse.core.runtime.ProgressMonitorWrapper
All Implemented Interfaces:
IProgressMonitor, IProgressMonitorWithBlocking
Direct Known Subclasses:
SubProgressMonitor
public abstract class ProgressMonitorWrapper extends Object implements IProgressMonitor, IProgressMonitorWithBlocking
An abstract wrapper around a progress monitor which, unless overridden, forwards IProgressMonitor and IProgressMonitorWithBlocking methods to the wrapped progress monitor.

This class can be used without OSGi running.

Clients may subclass.

  • Field Summary

    Fields inherited from interface org.eclipse.core.runtime.IProgressMonitor

    UNKNOWN

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    ProgressMonitorWrapper(IProgressMonitor monitor)
    Creates a new wrapper around the given monitor.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    beginTask(String name, int totalWork)
    This implementation of a IProgressMonitor method forwards to the wrapped progress monitor.
    void
    clearBlocked()
    This implementation of a IProgressMonitorWithBlocking method forwards to the wrapped progress monitor.
    void
    done()
    This implementation of a IProgressMonitor method forwards to the wrapped progress monitor.
    IProgressMonitor
    getWrappedProgressMonitor()
    Returns the wrapped progress monitor.
    void
    internalWorked(double work)
    This implementation of a IProgressMonitor method forwards to the wrapped progress monitor.
    boolean
    isCanceled()
    This implementation of a IProgressMonitor method forwards to the wrapped progress monitor.
    void
    setBlocked(IStatus reason)
    This implementation of a IProgressMonitorWithBlocking method forwards to the wrapped progress monitor.
    void
    setCanceled(boolean b)
    This implementation of a IProgressMonitor method forwards to the wrapped progress monitor.
    void
    setTaskName(String name)
    This implementation of a IProgressMonitor method forwards to the wrapped progress monitor.
    void
    subTask(String name)
    This implementation of a IProgressMonitor method forwards to the wrapped progress monitor.
    void
    worked(int work)
    This implementation of a IProgressMonitor method forwards to the wrapped progress monitor.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.eclipse.core.runtime.IProgressMonitor

    slice

  • Constructor Details

    • ProgressMonitorWrapper

      protected ProgressMonitorWrapper(IProgressMonitor monitor)
      Creates a new wrapper around the given monitor.
      Parameters:
      monitor - the progress monitor to forward to

  • Method Details

    • beginTask

      public void beginTask(String name, int totalWork)
      This implementation of a IProgressMonitor method forwards to the wrapped progress monitor. Clients may override this method to do additional processing.
      Specified by:
      beginTask in interface IProgressMonitor
      Parameters:
      name - the name (or description) of the main task
      totalWork - the total number of work units into which the main task is been subdivided. If the value is UNKNOWN the implementation is free to indicate progress in a way which doesn't require the total number of work units in advance.
      See Also:

    • clearBlocked

      public void clearBlocked()
      This implementation of a IProgressMonitorWithBlocking method forwards to the wrapped progress monitor. Clients may override this method to do additional processing.
      Specified by:
      clearBlocked in interface IProgressMonitor
      Since:
      3.0
      See Also:

    • done

      public void done()
      This implementation of a IProgressMonitor method forwards to the wrapped progress monitor. Clients may override this method to do additional processing.
      Specified by:
      done in interface IProgressMonitor
      See Also:

    • getWrappedProgressMonitor

      public IProgressMonitor getWrappedProgressMonitor()
      Returns the wrapped progress monitor.
      Returns:
      the wrapped progress monitor

    • internalWorked

      public void internalWorked(double work)
      This implementation of a IProgressMonitor method forwards to the wrapped progress monitor. Clients may override this method to do additional processing.
      Specified by:
      internalWorked in interface IProgressMonitor
      Parameters:
      work - the amount of work done
      See Also:

    • isCanceled

      public boolean isCanceled()
      This implementation of a IProgressMonitor method forwards to the wrapped progress monitor. Clients may override this method to do additional processing.
      Specified by:
      isCanceled in interface IProgressMonitor
      Returns:
      true if cancellation has been requested, and false otherwise
      See Also:

    • setBlocked

      public void setBlocked(IStatus reason)
      This implementation of a IProgressMonitorWithBlocking method forwards to the wrapped progress monitor. Clients may override this method to do additional processing.
      Specified by:
      setBlocked in interface IProgressMonitor
      Parameters:
      reason - an optional status object whose message describes the reason why this operation is blocked, or null if this information is not available.
      Since:
      3.0
      See Also:

    • setCanceled

      public void setCanceled(boolean b)
      This implementation of a IProgressMonitor method forwards to the wrapped progress monitor. Clients may override this method to do additional processing.
      Specified by:
      setCanceled in interface IProgressMonitor
      Parameters:
      b - true indicates that cancelation has been requested (but not necessarily acknowledged); false clears this flag
      See Also:

    • setTaskName

      public void setTaskName(String name)
      This implementation of a IProgressMonitor method forwards to the wrapped progress monitor. Clients may override this method to do additional processing.
      Specified by:
      setTaskName in interface IProgressMonitor
      Parameters:
      name - the name (or description) of the main task
      See Also:

    • subTask

      public void subTask(String name)
      This implementation of a IProgressMonitor method forwards to the wrapped progress monitor. Clients may override this method to do additional processing.
      Specified by:
      subTask in interface IProgressMonitor
      Parameters:
      name - the name (or description) of the subtask
      See Also:

    • worked

      public void worked(int work)
      This implementation of a IProgressMonitor method forwards to the wrapped progress monitor. Clients may override this method to do additional processing.
      Specified by:
      worked in interface IProgressMonitor
      Parameters:
      work - a non-negative number of work units just completed
      See Also: