org.apache.wiki.ui.progress

Class ProgressManager

java.lang.Object

org.apache.wiki.ui.progress.ProgressManager

public class ProgressManager
extends Object

Manages progressing items. In general this class is used whenever JSPWiki is doing something which may require a long time. In addition, this manager provides a JSON interface for finding remotely what the progress is. The JSON object name is JSON_PROGRESSTRACKER = ""progressTracker"".

Since:

2.6

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ProgressManager.JSONTracker Provides access to a progress indicator, assuming you know the ID.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROGRESSTRACKER The name of the progress tracker JSON object.

Constructor Summary

Constructors

Constructor and Description
ProgressManager() Creates a new ProgressManager.

Method Summary

Modifier and Type	Method and Description
String	getNewProgressIdentifier() You can use this to get an unique process identifier.
int	getProgress(String id) Get the progress in percents.
void	startProgress(ProgressItem pi, String id) Call this method to get your ProgressItem into the ProgressManager queue.
void	stopProgress(String id) Call this method to remove your ProgressItem from the queue (after which getProgress() will no longer find it.

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROGRESSTRACKER

public static final String JSON_PROGRESSTRACKER

The name of the progress tracker JSON object. The current value is ""progressTracker"",

See Also:

Constant Field Values

Constructor Detail

ProgressManager

public ProgressManager()

Creates a new ProgressManager.

Method Detail

getNewProgressIdentifier

public String getNewProgressIdentifier()

You can use this to get an unique process identifier.

Returns:

A new random value

startProgress

public void startProgress(ProgressItem pi,
                          String id)

Call this method to get your ProgressItem into the ProgressManager queue. The ProgressItem will be moved to state STARTED.

Parameters:

pi - ProgressItem to start

id - The progress identifier

stopProgress

public void stopProgress(String id)

Call this method to remove your ProgressItem from the queue (after which getProgress() will no longer find it. The ProgressItem will be moved to state STOPPED.

Parameters:

id - The progress identifier

getProgress

public int getProgress(String id)
                throws IllegalArgumentException

Get the progress in percents.

Parameters:

id - The progress identifier.

Returns:

a value between 0 to 100 indicating the progress

Throws:

IllegalArgumentException - If no such progress item exists.