Package com.bc.ceres.core

Class NullProgressMonitor

java.lang.Object
com.bc.ceres.core.NullProgressMonitor
All Implemented Interfaces:
ProgressMonitor
public class NullProgressMonitor extends Object implements ProgressMonitor
A default progress monitor implementation suitable for subclassing.

This implementation supports cancellation. The default implementations of the other methods do nothing.

This class has been more or less directly taken over from the Eclipse Core API.

  • Constructor Details

    • NullProgressMonitor

      public NullProgressMonitor()
      Constructs a new progress monitor.

  • Method Details

    • beginTask

      public void beginTask(String taskName, int totalWork)
      This implementation does nothing. Subclasses may override this method to do interesting processing when a task begins.
      Specified by:
      beginTask in interface ProgressMonitor
      Parameters:
      taskName - 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.

    • done

      public void done()
      This implementation does nothing. Subclasses may override this method to do interesting processing when a task is done.
      Specified by:
      done in interface ProgressMonitor

    • internalWorked

      public void internalWorked(double work)
      This implementation does nothing. Subclasses may override this method.
      Specified by:
      internalWorked in interface ProgressMonitor
      Parameters:
      work - the amount of work done

    • isCanceled

      public boolean isCanceled()
      This implementation returns the value of the internal state variable set by setCanceled. Subclasses which override this method should override setCanceled as well.
      Specified by:
      isCanceled in interface ProgressMonitor
      Returns:
      true if cancellation has been requested, and false otherwise
      See Also:

    • setCanceled

      public void setCanceled(boolean canceled)
      This implementation sets the value of an internal state variable. Subclasses which override this method should override isCanceled as well.
      Specified by:
      setCanceled in interface ProgressMonitor
      Parameters:
      canceled - true indicates that cancelation has been requested (but not necessarily acknowledged); false clears this flag
      See Also:

    • setTaskName

      public void setTaskName(String taskName)
      This implementation does nothing. Subclasses may override this method to do something with the name of the task.
      Specified by:
      setTaskName in interface ProgressMonitor
      Parameters:
      taskName - the name (or description) of the main task
      See Also:

    • setSubTaskName

      public void setSubTaskName(String subTaskName)
      This implementation does nothing. Subclasses may override this method to do interesting processing when a subtask begins.
      Specified by:
      setSubTaskName in interface ProgressMonitor
      Parameters:
      subTaskName - the name (or description) of the subtask

    • worked

      public void worked(int work)
      This implementation does nothing. Subclasses may override this method to do interesting processing when some work has been completed.
      Specified by:
      worked in interface ProgressMonitor
      Parameters:
      work - the number of work units just completed