com.sodius.mdw.core.util.progress
Class NullProgressMonitor

java.lang.Object
  extended by com.sodius.mdw.core.util.progress.NullProgressMonitor
All Implemented Interfaces:
ProgressMonitor

public class NullProgressMonitor
extends Object
implements ProgressMonitor

A default progress monitor implementation suitable for subclassing.

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

Clients may instantiate or subclass this class.


Field Summary
 
Fields inherited from interface com.sodius.mdw.core.util.progress.ProgressMonitor
UNKNOWN
 
Constructor Summary
NullProgressMonitor()
           
 
Method Summary
 void beginTask(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(String name)
          This implementation does nothing.
 void subTask(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
 

Constructor Detail

NullProgressMonitor

public NullProgressMonitor()
Method Detail

beginTask

public void beginTask(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 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 implementation is free to indicate progress in a way which doesn't require the total number of work units in advance.
See Also:
ProgressMonitor.beginTask(String, int)

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
See Also:
ProgressMonitor.done()

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
See Also:
ProgressMonitor.internalWorked(double)

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:
ProgressMonitor.isCanceled(), ProgressMonitor.setCanceled(boolean)

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 ProgressMonitor
Parameters:
cancelled - true indicates that cancelation has been requested (but not necessarily acknowledged); false clears this flag
See Also:
ProgressMonitor.isCanceled(), ProgressMonitor.setCanceled(boolean)

setTaskName

public void setTaskName(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 ProgressMonitor
Parameters:
name - the name (or description) of the main task
See Also:
ProgressMonitor.setTaskName(String)

subTask

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

Specified by:
subTask in interface ProgressMonitor
Parameters:
name - the name (or description) of the subtask
See Also:
ProgressMonitor.subTask(String)

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
See Also:
ProgressMonitor.worked(int)