sbrt.kernel.utilities
Interface MutableProgressMonitor

All Superinterfaces:
ProgressMonitor
All Known Implementing Classes:
AbstractProgressMonitor, DiscreteProgressMonitor, PercentProgressMonitor

public interface MutableProgressMonitor
extends ProgressMonitor

This interface is used to represent mutable progress montiors.

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

Method Summary
 ProgressMonitor asUnmodifiable()
          Returns this progress monitor as an immutable object.
 void increment()
          Causes this progress monitor to increment an internal counter.
 void resetCount()
          Causes this progress monitor to reset its internal counter to 0.
 void start()
          Causes this progress monitor to start monitoring a duration of time.
 void stop()
          Causes this progress monitor to stop monitoring a duration of time.
 
Methods inherited from interface sbrt.kernel.utilities.ProgressMonitor
getDuration, getProgress, started, stopped
 

Method Detail

increment

void increment()
Causes this progress monitor to increment an internal counter.


start

void start()
Causes this progress monitor to start monitoring a duration of time.

Throws:
java.lang.IllegalStateException - if start() was already called without a subsequent call to stop().

stop

void stop()
Causes this progress monitor to stop monitoring a duration of time.

Throws:
java.lang.IllegalStateException - if start() was never called, or if stop() has already been called since the last call to start().

resetCount

void resetCount()
Causes this progress monitor to reset its internal counter to 0.


asUnmodifiable

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.