|
|||||||||
| PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES | ||||||||
This package provides a mechanism for reporting progress of lengthy API operations.
See:
Description
| Interface Summary | |
|---|---|
| ProgressListener | Progress listeners are user-defined objects that listen for progress events, and take appropriate action upon their receipt. |
| Class Summary | |
|---|---|
| Example | View the source of this class for progress API examples. |
| ProgressEvent | ProgressEvent is the object used to communicate progress events to ProgressListeners. |
| ProgressLogger | This is a convenience class that can be extended by other classes that need to implement the progress listener interface. |
| ProgressManager | The ProgressManager object is the entry point into the progress reporting API. |
| ProgressMonitor | The ProgressMonitor object is used to monitor execution of lengthy monolithic operations, that otherwise do not provide any indication of their progress. |
| ProgressProcessor | This class provides a base implementation for progress event producing tools. |
| ProgressReporter | The ProgressReporter object is used to report progress in a flexible way, allowing for step reporting, percent reporting, or duration reporting. |
| ProgressRequestProcessor | This class provides a base implementation for progress event producing tools. |
This package provides a mechanism for reporting progress of lengthy API operations. The need to report lengthy operation progress to applications users has come to our attention in the context of numerous usability scenarios.
The design pattern used to implement progress reporting in this Java API is a well-known event model as described in the JavaBeans Specification. The four major parts of this design pattern are:
In this progress reporting API, events are represented by the ProgressEvent objects, listeners are represented by the ProgressListener objects, and event sources are the API functions that generate ProgressEvents. Support classes include ProgressManager, ProgresReporter and ProgressMonitor.
ProgressManager is the entry point. An API that support progress reporting should create an instance of the ProgressManager class in its context or connection instance, and provide a getter method getProgressManager(). Listeners interested in progress events for a particular API register themselves on the ProgressManager instance returned by the progress manager getter method of that API context or connection.
|
|||||||||
| PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES | ||||||||