|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.table.join.TextProgressIndicator
public class TextProgressIndicator
ProgressIndicator which logs progress to an output stream.
Constructor Summary | |
---|---|
TextProgressIndicator(PrintStream out,
boolean profile)
Constructs a new indicator which will output to a given stream. |
Method Summary | |
---|---|
void |
endStage()
Indicates that no more ProgressIndicator.setLevel(double) calls will be made until
the next ProgressIndicator.startStage(java.lang.String) . |
void |
logMessage(String msg)
Registers a comment about the progress of the algorithm. |
void |
setLevel(double level)
Specifies that the work of the most recently-started stage is a certain proportion complete. |
void |
startStage(String stage)
Indicates that a number of ProgressIndicator.setLevel(double) calls may follow,
followed by a ProgressIndicator.endStage() call. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TextProgressIndicator(PrintStream out, boolean profile)
out
- output streamprofile
- true iff profiling reports are to be made along with
the normal progress logMethod Detail |
---|
public void startStage(String stage)
ProgressIndicator
ProgressIndicator.setLevel(double)
calls may follow,
followed by a ProgressIndicator.endStage()
call.
startStage
in interface ProgressIndicator
stage
- name/description of the processing stagepublic void setLevel(double level)
ProgressIndicator
ProgressIndicator.startStage(java.lang.String)
and ProgressIndicator.endStage()
,
preferably with non-decreasing values of level.
The method may throw an InterruptedException as a message to the caller that the work should be interrupted. A caller which receives such an exception should stop using resources and tidy up as soon as is convenient.
setLevel
in interface ProgressIndicator
level
- value between 0. and 1. indicating amount of completionpublic void endStage()
ProgressIndicator
ProgressIndicator.setLevel(double)
calls will be made until
the next ProgressIndicator.startStage(java.lang.String)
.
endStage
in interface ProgressIndicator
public void logMessage(String msg)
ProgressIndicator
ProgressIndicator.startStage(java.lang.String)
and ProgressIndicator.endStage()
.
logMessage
in interface ProgressIndicator
msg
- message
|
Copyright © 2004 CLRC: Central Laboratory of the Research Councils. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |