org.geotoolkit.process
Interface ProcessListener

All Superinterfaces:

EventListener

All Known Implementing Classes:

ProgressController, ProgressMailer, ProgressPrinter, ProgressWindow

public interface ProcessListener
extends EventListener

Receives general indications of process progress and events indicating start, completion or failure. For any registered listeners, the Process.call() method shall invoke at least the started and completed or failed methods (mandatory). Calls to the progressing method are optional but recommended.

Since:

3.19

Version:

3.19

Author:

Johann Sorel (Geomatys)

Module:

utility/geotk-utility (download)

View source code for this class

Method Summary

void	completed(ProcessEvent event) Reports that a process has completed successfully.
void	failed(ProcessEvent event) Reports that a process has failed.
void	progressing(ProcessEvent event) Invoked at any time during process progression.
void	started(ProcessEvent event) Reports that a process is beginning.

Method Detail

started

void started(ProcessEvent event)

Reports that a process is beginning. Process implementations are required to call this method exactly once.

Parameters:

event - The progress event.

progressing

void progressing(ProcessEvent event)

Invoked at any time during process progression. Process implementations may invoke this method an arbitrary number of time. In addition to the source, task name and progress indicator, the event argument may contain the following optional information:

• ProcessEvent.getOutput(), if non-null, indicates an intermediate calculation value.
• ProcessEvent.getException(), if non-null, indicates a non-fatal warning.

Parameters:

event - The progress event.

completed

void completed(ProcessEvent event)

Reports that a process has completed successfully. Process implementations are required to call either this method or failed(ProcessEvent) exactly once. In addition to the source and task name, the event argument shall contain the following information:

• ProcessEvent.getOutput() is the final result returned by Process.call().

Parameters:

event - The progress event.

failed

void failed(ProcessEvent event)

Reports that a process has failed. Process implementations are required to call either this method or completed(ProcessEvent) exactly once. In addition to the source and task name, the event argument may contain the following optional information:

• ProcessEvent.getException(), if non-null, indicates the failure cause.
• ProcessEvent.getOutput(), if non-null, indicates the calculation state before the failure.

Parameters:

event - The progress event.