Package org.esa.snap.core.datamodel

Class ProgressListenerList

java.lang.Object

org.esa.snap.core.datamodel.ProgressListenerList

All Implemented Interfaces:

ProgressListener

public class ProgressListenerList
extends Object
implements ProgressListener

A utility class for clients interested in the progress made while reading, writing or somehow processing data products.

Version:

$Revision$ $Date$

Constructor Summary

Constructors

Constructor	Description
ProgressListenerList()

Method Summary

Modifier and Type	Method	Description
void	addProgressListener(ProgressListener listener)
void	fireProcessEnded(boolean success)
boolean	fireProcessInProgress(int currentProgressValue)
boolean	fireProcessStarted(String processName, int minProgressValue, int maxProgressValue)
boolean	isEmpty()
void	processEnded(boolean success)	Don't call this method directly.
boolean	processInProgress(int currentProgressValue)	Don't call this method directly.
boolean	processStarted(String processDescription, int minProgressValue, int maxProgressValue)	Don't call this method directly.
void	removeAllProgressListeners()
void	removeProgressListener(ProgressListener listener)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProgressListenerList

public ProgressListenerList()

Method Detail

processStarted

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

Don't call this method directly. Instead use fireProcessStarted(java.lang.String, int, int).

Specified by:

processStarted in interface ProgressListener

Parameters:

processDescription -

minProgressValue -

maxProgressValue -

Returns:

true if the process is started, otherwise false.

processInProgress

public boolean processInProgress(int currentProgressValue)

Don't call this method directly. Instead use fireProcessInProgress(int).

Specified by:

processInProgress in interface ProgressListener

Parameters:

currentProgressValue -

Returns:

true if the process should be continued, false otherwise

processEnded

public void processEnded(boolean success)

Don't call this method directly. Instead use fireProcessEnded(boolean).

Specified by:

processEnded in interface ProgressListener

Parameters:

success -

addProgressListener

public void addProgressListener(ProgressListener listener)

removeProgressListener

public void removeProgressListener(ProgressListener listener)

removeAllProgressListeners

public void removeAllProgressListeners()

fireProcessStarted

public boolean fireProcessStarted(String processName,
                                  int minProgressValue,
                                  int maxProgressValue)

fireProcessInProgress

public boolean fireProcessInProgress(int currentProgressValue)

fireProcessEnded

public void fireProcessEnded(boolean success)

isEmpty

public boolean isEmpty()