javax.ide.progress

Class ProgressManager

java.lang.Object

javax.ide.progress.ProgressManager

public class ProgressManager
extends java.lang.Object

ProgressManager is a generic progress reporting system.

Method Summary

Modifier and Type	Method and Description
static void	beginProgress() beginProgress initiates the progress reporting process and performs initialization.
static void	completeProgress(java.lang.String name) completeProgress broadcasts the completeProgress event to all progress listeners.
static void	endProgress() endProgress ends the progress reporting process and performs cleanup.
static void	finalizeProgress(java.lang.String name, int count) Call finalizeProgress before calling updateProgress or updateProgressDescription.
static void	registerListener(java.lang.String name, IProgressListener listener) registerListener registers a listener to a progress event.
static void	removeListener(java.lang.String name, IProgressListener listener) removeListener removes a listener.
static void	updateProgress(java.lang.String name, int count) updateProgress broadcasts the updateProgress event to all progress listeners.
static void	updateProgressDescription(java.lang.String name, java.lang.String description, int count) updateProgressDescription broadcasts the updateProgressDescription event to all progress listeners.
static void	updateProgressTitle(java.lang.String name, java.lang.String title) updateProgressTitle broadcasts the updateProgressTitle event to all progress listeners.

Methods inherited from class java.lang.Object

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

Method Detail

beginProgress

public static void beginProgress()

beginProgress initiates the progress reporting process and performs initialization. Called before starting a process that will use the ProgressManager.

endProgress

public static void endProgress()

endProgress ends the progress reporting process and performs cleanup. Called when done with the ProgressManager.

registerListener

public static void registerListener(java.lang.String name,
                                    IProgressListener listener)

registerListener registers a listener to a progress event. Because ProgressManager is a multi-cast dispatch mechanism multiple listeners can listen to the events.

Parameters:

name -

listener -

removeListener

public static void removeListener(java.lang.String name,
                                  IProgressListener listener)

removeListener removes a listener. This call is superfluous and it is not mandated that it be called unless a specific listener need be removinged mid reporting. endProgress will perform any cleanup needed and removing all listeners remaining.

Parameters:

name -

listener -

completeProgress

public static void completeProgress(java.lang.String name)

completeProgress broadcasts the completeProgress event to all progress listeners.

Parameters:

name -

updateProgressTitle

public static void updateProgressTitle(java.lang.String name,
                                       java.lang.String title)

updateProgressTitle broadcasts the updateProgressTitle event to all progress listeners.

Parameters:

name -

title -

updateProgressDescription

public static void updateProgressDescription(java.lang.String name,
                                             java.lang.String description,
                                             int count)

updateProgressDescription broadcasts the updateProgressDescription event to all progress listeners.

Parameters:

name -

description -

count -

updateProgress

public static void updateProgress(java.lang.String name,
                                  int count)

updateProgress broadcasts the updateProgress event to all progress listeners.

Parameters:

name -

count -

finalizeProgress

public static void finalizeProgress(java.lang.String name,
                                    int count)

Call finalizeProgress before calling updateProgress or updateProgressDescription. This will bake the number of items that you want to update for this progres chunk.

Parameters:

name - specifies the name of the progress chunk.

count - is the number of items to update.