com.atlassian.bamboo.progressbar
Interface ProgressBar

All Known Subinterfaces:

BuildProgressBar

All Known Implementing Classes:

BuildProgressBarImpl, ProgressBarImpl

public interface ProgressBar

This object encapsulates the bar graph that represents a progress of a given build

Method Summary

long	getEstimatedDuration() Returns prospected duration of a task.
double	getPercentageCompleted() Elapsed time / total time
java.lang.String	getPercentageCompletedAsString()
java.lang.String	getPrettyTimeRemaining()
java.lang.String	getPrettyTimeRemaining(boolean isLong)
int	getTimeElapsedWidth() Return the width of the "elapsed time" progress bar
int	getTotalTimeWidth() Return the width of the "total time" progress bar
boolean	isUnderAverageTime() Returns true if elapse time < ave time
boolean	isValid() Returns true iff the ave time is > 0

Method Detail

isValid

boolean isValid()

Returns true iff the ave time is > 0

Returns:

isUnderAverageTime

boolean isUnderAverageTime()

Returns true if elapse time < ave time

Returns:

true if elapse time < ave time

getPercentageCompleted

double getPercentageCompleted()

Elapsed time / total time

Returns:

Elapsed time / total time

getPrettyTimeRemaining

java.lang.String getPrettyTimeRemaining()

Returns:

Returns the approximate amount of time remaining

getPrettyTimeRemaining

java.lang.String getPrettyTimeRemaining(boolean isLong)

Parameters:

isLong - true if you want the long-winded version, false if you want the short version

Returns:

Returns the approximate amount of time remaining

getTotalTimeWidth

int getTotalTimeWidth()

Return the width of the "total time" progress bar

Returns:

width of bar

getTimeElapsedWidth

int getTimeElapsedWidth()

Return the width of the "elapsed time" progress bar

Returns:

getEstimatedDuration

long getEstimatedDuration()

Returns prospected duration of a task.

Returns:

estimated execution total time in milliseconds

getPercentageCompletedAsString

java.lang.String getPercentageCompletedAsString()