org.sbml.jsbml.util

Interface ProgressListener

All Superinterfaces:

java.util.EventListener

public interface ProgressListener
extends java.util.EventListener

The listener interface for receiving progress events. The class interested in handling these events should implement this interface.

Since:

1.0

Version:

$Rev$

Author:

Andreas Dräger

Method Summary

Modifier and Type	Method and Description
void	progressFinish() This method is called when the process is finished, irrespective of the progress/total ratio.
void	progressStart(int total) Reports the total number of expected steps.
void	progressUpdate(int progress, java.lang.String message) Reports the current progress to this listener, i.e., progress < total.

Method Detail

progressStart

void progressStart(int total)

Reports the total number of expected steps. Note that in some use-cases the total number of steps might be unknown and therefore this method might be called with a very high default number, e.g., Integer.MAX_VALUE.

Parameters:

total - the estimated total number of computation steps to be performed by this process.

progressUpdate

void progressUpdate(int progress,
                    java.lang.String message)

Reports the current progress to this listener, i.e., progress < total. Note that with every call of this method an increasing progress must be reported, i.e., two subsequent calls of this method must ensure that p₁ < p₂ (where p₁ and p₂ are the arguments passed to this method in the two subsequent calls).

Parameters:

progress - the number of steps that have been completed already

message - can be null, a more detailed message to be displayed to the user in some way.

progressFinish

void progressFinish()

This method is called when the process is finished, irrespective of the progress/total ratio.