com.atlassian.confluence.util

Class SubProgressMeter

java.lang.Object

com.atlassian.core.util.ProgressMeter

com.atlassian.confluence.util.SubProgressMeter

public class SubProgressMeter
extends com.atlassian.core.util.ProgressMeter

Allow us to break a single ProgressMeter to several ProgressMeter. Help to to easier to report progress

Since:

5.10

Constructor Summary

Constructors

Constructor and Description
SubProgressMeter(com.atlassian.core.util.ProgressMeter outerMeter, float percentageOfOuterMeter, int total)

Method Summary

Modifier and Type	Method and Description
void	setCompletedSuccessfully(boolean completedSuccessfully)
void	setPercentage(int percentageComplete)
void	setPercentage(int count, int total) Use this method to set the completion %age to object 10 of 30 etc.
void	setStatus(String status)

Methods inherited from class com.atlassian.core.util.ProgressMeter

getCurrentCount, getPercentageComplete, getStatus, getTotal, isCompletedSuccessfully, setCurrentCount, setTotalObjects

Methods inherited from class java.lang.Object

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

Constructor Detail

SubProgressMeter

public SubProgressMeter(com.atlassian.core.util.ProgressMeter outerMeter,
                        float percentageOfOuterMeter,
                        int total)

Method Detail

setPercentage

public void setPercentage(int count,
                          int total)

Use this method to set the completion %age to object 10 of 30 etc.

Overrides:

setPercentage in class com.atlassian.core.util.ProgressMeter

Parameters:

count - The current object count in progress

total - The total number of objects to be processed

setStatus

public void setStatus(String status)

Overrides:

setStatus in class com.atlassian.core.util.ProgressMeter

setPercentage

public void setPercentage(int percentageComplete)

Overrides:

setPercentage in class com.atlassian.core.util.ProgressMeter

setCompletedSuccessfully

public void setCompletedSuccessfully(boolean completedSuccessfully)

Overrides:

setCompletedSuccessfully in class com.atlassian.core.util.ProgressMeter