|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Progress
A Generic way of keeping track of Threads and monitoring their progress.
for license details.
The copyright to this program is held by it's authors.
Field Summary | |
---|---|
static int |
UNKNOWN
Indicate that the total amount of work is unknown. |
Method Summary | |
---|---|
void |
beginJob(String name,
int totalWork)
Start the task. |
void |
cancel()
Cancel the job (if possible). |
void |
done()
Called to indicate that we are finished doing work. |
String |
getJobName()
|
String |
getSectionName()
We have moved onto another section so update the section title. |
int |
getTotalWork()
|
int |
getWork()
|
boolean |
isCancelable()
Might the job be cancelable? |
boolean |
isFinished()
Used to determine whether job is done or cancelled or reached totalWork. |
void |
setCancelable(boolean newCancelable)
Indicates whether the job is cancelable or not. |
void |
setSectionName(String name)
We have moved onto another section so update the section title. |
void |
setWork(int progress)
Indicate progress toward the whole. |
Field Detail |
---|
static final int UNKNOWN
Method Detail |
---|
void beginJob(String name, int totalWork)
name
- the initial name of the job.totalWork
- the total amount that is to be worked. If UNKNOWN then the progress is to be guessed.String getJobName()
int getTotalWork()
void done()
void setSectionName(String name)
name
- the name of the sectionString getSectionName()
void setWork(int progress)
progress
- a part of the whole.int getWork()
void cancel()
boolean isFinished()
boolean isCancelable()
void setCancelable(boolean newCancelable)
newCancelable
- The state to set.
|
Copyright ยจ 2003-2007 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |