ariba.util.core
Class ProgressMonitor

java.lang.Object
  ariba.util.core.ProgressMonitor

public class ProgressMonitor
extends java.lang.Object

This class stores the user-visible progress information for the current thread so that it can be queried / reflected by a progress panel in the UI. The state is updated by the active current thread and is registered in a global Map keyed by SessionId so that progress polling (from another thread) can get the latest state.

Method Summary

java.lang.String	generateMessage()
int	getCurrentCount()
static ProgressMonitor	getInstanceForKey(java.lang.String key)
java.lang.String	getMessageFormatString()
int	getTotalCount()
void	incrementCurrentCount()
static ProgressMonitor	instance()
void	prepare(java.lang.String formatString, int total)
static void	register(java.lang.String key)
void	setCurrentCount(int count)
void	setMessageFormatString(java.lang.String messageFormatString)
void	setTotalCount(int total)

Methods inherited from class java.lang.Object

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

Method Detail

instance

public static ProgressMonitor instance()

register

public static void register(java.lang.String key)

getInstanceForKey

public static ProgressMonitor getInstanceForKey(java.lang.String key)

prepare

public void prepare(java.lang.String formatString,
                    int total)

generateMessage

public java.lang.String generateMessage()

incrementCurrentCount

public void incrementCurrentCount()

getMessageFormatString

public java.lang.String getMessageFormatString()

setMessageFormatString

public void setMessageFormatString(java.lang.String messageFormatString)

getCurrentCount

public int getCurrentCount()

setCurrentCount

public void setCurrentCount(int count)

getTotalCount

public int getTotalCount()

setTotalCount

public void setTotalCount(int total)