Package org.esa.snap.core.datamodel

Interface ProgressListener

All Known Implementing Classes:

ProgressListenerList

public interface ProgressListener

The ProgressListener interface represents a listener for the observation of possibly time consuming processes.

Version:

$Revision$ $Date$

Method Summary

Modifier and Type	Method	Description
void	processEnded(boolean success)	Called when a process ended.
boolean	processInProgress(int currentProgressValue)	Called while a process in in progress.
boolean	processStarted(String processDescription, int minProgressValue, int maxProgressValue)	Called when a process started.

Method Details

processStarted

boolean processStarted(String processDescription,
 int minProgressValue,
 int maxProgressValue)

Called when a process started. If the process can be started, the listener should return true.

Parameters:

processDescription - a short description of the process beeing started

minProgressValue -

maxProgressValue -

Returns:

true if the process was successfully started (and should be continued), false otherwise

processInProgress

boolean processInProgress(int currentProgressValue)

Called while a process in in progress. A listener should return true if the process can be continued, false if it should be terminated.

Parameters:

currentProgressValue - the current progress value

Returns:

true if the process should be continued, false otherwise

processEnded

void processEnded(boolean success)

Called when a process ended.

Parameters:

success - if true the process was successfully ended, otherwise it was terminated by user demand or due to an exception.