Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.eclipse.core.runtime
Class NullProgressMonitor  view NullProgressMonitor download NullProgressMonitor.java

java.lang.Object
  extended byorg.eclipse.core.runtime.NullProgressMonitor
All Implemented Interfaces:
IProgressMonitor

public class NullProgressMonitor
extends java.lang.Object
implements IProgressMonitor

A default progress monitor implementation suitable for subclassing.

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


Field Summary
private  boolean cancelled
          Indicates whether cancel has been requested.
 
Fields inherited from interface org.eclipse.core.runtime.IProgressMonitor
UNKNOWN
 
Constructor Summary
NullProgressMonitor()
          Constructs a new progress monitor.
 
Method Summary
 void beginTask(java.lang.String name, int totalWork)
          This implementation does nothing.
 void done()
          This implementation does nothing.
 void internalWorked(double work)
          This implementation does nothing.
 boolean isCanceled()
          This implementation returns the value of the internal state variable set by setCanceled.
 void setCanceled(boolean cancelled)
          This implementation sets the value of an internal state variable.
 void setTaskName(java.lang.String name)
          This implementation does nothing.
 void subTask(java.lang.String name)
          This implementation does nothing.
 void worked(int work)
          This implementation does nothing.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

cancelled

private boolean cancelled
Indicates whether cancel has been requested.

Constructor Detail

NullProgressMonitor

public NullProgressMonitor()
Constructs a new progress monitor.

Method Detail

beginTask

public void beginTask(java.lang.String name,
                      int totalWork)
This implementation does nothing. Subclasses may override this method to do interesting processing when a task begins.

Specified by:
beginTask in interface IProgressMonitor

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 IProgressMonitor

internalWorked

public void internalWorked(double work)
This implementation does nothing. Subclasses may override this method.

Specified by:
internalWorked in interface IProgressMonitor

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 IProgressMonitor

setCanceled

public void setCanceled(boolean cancelled)
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 IProgressMonitor

setTaskName

public void setTaskName(java.lang.String name)
This implementation does nothing. Subclasses may override this method to do something with the name of the task.

Specified by:
setTaskName in interface IProgressMonitor

subTask

public void subTask(java.lang.String name)
This implementation does nothing. Subclasses may override this method to do interesting processing when a subtask begins.

Specified by:
subTask in interface IProgressMonitor

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 IProgressMonitor