|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IProgressBar
Progress bars allow operations to report progress. The progress bar is
started when instantiated, and expects a certain number of 'units' of
progress. A unit of progress is reported by calling the increment()
or multiple units can be reported by calling increment(int)
. When
the task is finished, the reporter should call the finish()
method.
Method Summary | |
---|---|
void |
finish()
Stops the progress bar and prints the total time that the progress bar ran. |
int |
getCount()
Returns the current state of the progress bar, that is, the number of units of progress that have been reported to it. |
Date |
getEndTime()
Returns the date and time on which this progress bar was finished. |
int |
getExpected()
Returns the expected number of units of progress. |
int |
getExpectedTicks()
Returns the expected number of ticks. |
Date |
getStartTime()
Returns the date and time on which this progress bar was started. |
double |
getStepSize()
Returns the number of units of progress that are represented by one tick. |
int |
getTickCount()
Returns the number of current progress bar ticks that have been used. |
void |
increment()
Increments the progress bar by 1. |
void |
increment(int amount)
Increments the progress bar by a given amount. |
Method Detail |
---|
int getCount()
int getTickCount()
int getExpected()
int getExpectedTicks()
double getStepSize()
Date getStartTime()
Date getEndTime()
null
.
null
if not yet finished.void increment()
void increment(int amount)
amount
- amount by which the progress bar will be incrementedvoid finish()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |