sbrt.kernel.util
Interface ProgressMonitor

All Known Subinterfaces:
MutableProgressMonitor
All Known Implementing Classes:
AbstractProgressMonitor, DiscreteProgressMonitor, PercentProgressMonitor

public interface ProgressMonitor

This interface is used to represent progress monitors.

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

Method Summary
 long getDuration()
          Returns the current duration of the process being monitored.
 java.lang.Number getProgress()
          Returns a number indicating the progress of the process being monitored.
 boolean started()
          Indicates if this progress monitor has already been started.
 boolean stopped()
          Indicates if this progress monitor has already been stopped.
 

Method Detail

getDuration

long getDuration()
Returns the current duration of the process being monitored.

Returns:
the current duration of the process in milliseconds.

getProgress

java.lang.Number getProgress()
Returns a number indicating the progress of the process being monitored.

Returns:
a number indicating the progress of the process being monitored.

started

boolean started()
Indicates if this progress monitor has already been started.

Returns:
true if this progress monitor has already been started; false otherwise.

stopped

boolean stopped()
Indicates if this progress monitor has already been stopped.

Returns:
true if this progress monitor has already been stopped; false otherwise.