sbrt.kernel.utilities
Class DiscreteProgressMonitor

java.lang.Object
  extended by sbrt.kernel.utilities.AbstractProgressMonitor
      extended by sbrt.kernel.utilities.DiscreteProgressMonitor
All Implemented Interfaces:
MutableProgressMonitor, ProgressMonitor

public class DiscreteProgressMonitor
extends AbstractProgressMonitor

This class is used to monitor the progress of a process that occurs in discrete events.

Author:
This class was written and documented by Jeremiah Wright while in the Wagner lab.

Constructor Summary
DiscreteProgressMonitor()
          Constructs a new discrete progress monitor.
 
Method Summary
 ProgressMonitor asUnmodifiable()
          Returns this progress monitor as an immutable object.
 java.lang.Integer getProgress()
          Returns an integer value indicating a progress.
 
Methods inherited from class sbrt.kernel.utilities.AbstractProgressMonitor
getCount, getDuration, increment, resetCount, start, started, stop, stopped
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DiscreteProgressMonitor

public DiscreteProgressMonitor()
Constructs a new discrete progress monitor.

Method Detail

getProgress

public java.lang.Integer getProgress()
Returns an integer value indicating a progress.

Returns:
an integer value indicating a progress.

asUnmodifiable

public ProgressMonitor asUnmodifiable()
Returns this progress monitor as an immutable object. This allows the contents of this progress monitor to be queried without the possibility of modification.

Returns:
this progress monitor as an immutable object.