org.pf.tools.cda.core.processing
Interface IProgressMonitor


public interface IProgressMonitor

Generic interface for any kind of progress monitor. Applications should only work with this interface in order to get independent of the actual implementation of the progress monitor. That even allows to use a dummy progress monitor which does nothing.

Version:
1.0
Author:
M.Duchrow

Method Summary
 boolean showProgress(int value, java.lang.Object[] info)
          This method will be called by an application to display the current progress.
 void startProgressMonitor()
          Start the progress monitor.
 void terminateProgressMonitor()
          Terminate the progress monitor.
 

Method Detail

startProgressMonitor

void startProgressMonitor()
Start the progress monitor.


terminateProgressMonitor

void terminateProgressMonitor()
Terminate the progress monitor.


showProgress

boolean showProgress(int value,
                     java.lang.Object[] info)
This method will be called by an application to display the current progress.
If the method returns false, the execution must be stopped due to a user interrupt.

Any implementor of this method must be able to deal with null values for info and even null values inside the info array.

Parameters:
value - A numeric value that might indicate a percentage value or a counter
info - Any additional objects that might be shown by the implementing progress monitor
Returns:
true, if processing should continue, otherwise false