Class NullProgressMonitor

java.lang.Object
org.eclipse.emf.mwe.core.monitor.NullProgressMonitor
All Implemented Interfaces:
ProgressMonitor

public class NullProgressMonitor extends Object implements ProgressMonitor
Empty implementation of ProgressMonitor.
Since:
4.0
Author:
Sven Efftinge (http://www.efftinge.de)
  • Field Summary

    Fields inherited from interface org.eclipse.emf.mwe.core.monitor.ProgressMonitor

    UNKNOWN
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    beginTask(String name, int totalWork)
    Notifies that the main task is beginning.
    void
    Notifies that the work is done; that is, either the main task is completed or the user canceled it.
    void
    finished(Object element, Object context)
    Notifies that overall process was finished.
    void
    internalWorked(double work)
    Internal method to handle scaling correctly.
    boolean
    Returns whether cancelation of current operation has been requested.
    void
    postTask(Object element, Object context)
    Notifies that a task was finished.
    void
    preTask(Object element, Object context)
    Notifies that a task will be started.
    void
    setCanceled(boolean value)
    Sets the cancel state to the given value.
    void
    Sets the task name to the given value.
    void
    started(Object element, Object context)
    Notifies that overall process was started.
    void
    Notifies that a subtask of the main task is beginning.
    void
    worked(int work)
    Notifies that a given number of work unit of the main task has been completed.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • NullProgressMonitor

      public NullProgressMonitor()
  • Method Details

    • beginTask

      public void beginTask(String name, int totalWork)
      Description copied from interface: ProgressMonitor
      Notifies that the main task is beginning. This must only be called once on a given progress monitor instance.
      Specified by:
      beginTask in interface ProgressMonitor
      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 implemenation is free to indicate progress in a way which doesn't require the total number of work units in advance.
      See Also:
    • done

      public void done()
      Description copied from interface: ProgressMonitor
      Notifies that the work is done; that is, either the main task is completed or the user canceled it. This method may be called more than once (implementations should be prepared to handle this case).
      Specified by:
      done in interface ProgressMonitor
      See Also:
    • internalWorked

      public void internalWorked(double work)
      Description copied from interface: ProgressMonitor
      Internal method to handle scaling correctly. This method must not be called by a client. Clients should always use the method worked(int).
      Specified by:
      internalWorked in interface ProgressMonitor
      Parameters:
      work - the amount of work done
      See Also:
    • isCanceled

      public boolean isCanceled()
      Description copied from interface: ProgressMonitor
      Returns whether cancelation of current operation has been requested. Long-running operations should poll to see if cancelation has been requested.
      Specified by:
      isCanceled in interface ProgressMonitor
      Returns:
      true if cancellation has been requested, and false otherwise
      See Also:
    • setCanceled

      public void setCanceled(boolean value)
      Description copied from interface: ProgressMonitor
      Sets the cancel state to the given value.
      Specified by:
      setCanceled in interface ProgressMonitor
      Parameters:
      value - true indicates that cancelation has been requested (but not necessarily acknowledged); false clears this flag
      See Also:
    • setTaskName

      public void setTaskName(String name)
      Description copied from interface: ProgressMonitor
      Sets the task name to the given value. This method is used to restore the task label after a nested operation was executed. Normally there is no need for clients to call this method.
      Specified by:
      setTaskName in interface ProgressMonitor
      Parameters:
      name - the name (or description) of the main task
      See Also:
    • subTask

      public void subTask(String name)
      Description copied from interface: ProgressMonitor
      Notifies that a subtask of the main task is beginning. Subtasks are optional; the main task might not have subtasks.
      Specified by:
      subTask in interface ProgressMonitor
      Parameters:
      name - the name (or description) of the subtask
      See Also:
    • worked

      public void worked(int work)
      Description copied from interface: ProgressMonitor
      Notifies that a given number of work unit of the main task has been completed. Note that this amount represents an installment, as opposed to a cumulative amount of work done to date.
      Specified by:
      worked in interface ProgressMonitor
      Parameters:
      work - the number of work units just completed
      See Also:
    • started

      public void started(Object element, Object context)
      Description copied from interface: ProgressMonitor
      Notifies that overall process was started.
      Specified by:
      started in interface ProgressMonitor
      Parameters:
      element - The element that fired that notification
      context - the context of execution
      See Also:
    • finished

      public void finished(Object element, Object context)
      Description copied from interface: ProgressMonitor
      Notifies that overall process was finished.
      Specified by:
      finished in interface ProgressMonitor
      Parameters:
      element - The element that fired that notification
      context - the context of execution
      See Also:
    • postTask

      public void postTask(Object element, Object context)
      Description copied from interface: ProgressMonitor
      Notifies that a task was finished. Must be paired together with one preTask() call.
      Specified by:
      postTask in interface ProgressMonitor
      Parameters:
      element - The element that fired that notification
      context - the context of execution
      See Also:
    • preTask

      public void preTask(Object element, Object context)
      Description copied from interface: ProgressMonitor
      Notifies that a task will be started. Must be paired together with one postTask() call.
      Specified by:
      preTask in interface ProgressMonitor
      Parameters:
      element - The element that fired that notification
      context - the context of execution