com.azalient.api.file.event
Interface ProcessListener

public interface ProcessListener

A process listener is notified of the progress of a number of processes in Commuter. The enumeration within this interface lists all the processes that can be tracked. The progress notifications are fired at regular intervals during each process, and then finally, when the process is complete. The notifications can be used, for example, to display a progress bar.

Why the enumeration? This allows the processes to be concurrent, either nested inside each other, or independent, in separate threads. This allow the progress display to have a panel of progress bars - as soon as it detected a new process was starting, it can open a new progress bar, and dsiplay the progress on it.

API processes can use one of the GENERIC_PROCESS tags. It does not matter if more than one process uses the same tag, but if this happens the progress display may jump around while both processes are sending notifications.

Nested Class Summary

static class

ProcessListener.ProgressTag An enumeration of processes that use the progress notifications.

Method Summary

void	progress(ProcessListener.ProgressTag tag, String message, double proportion) Called to notify the listener that the named process has complete a proportion [0.0 ...
void	progressDone(ProcessListener.ProgressTag tag) Called to notify the listener that the named process has completed

Method Detail

progress

void progress(ProcessListener.ProgressTag tag,
              String message,
              double proportion)

Called to notify the listener that the named process has complete a proportion [0.0 ... 1.0] of its task. A descriptive message about the progress may be supplied.

progressDone

void progressDone(ProcessListener.ProgressTag tag)

Called to notify the listener that the named process has completed