public class StepProgress extends FiniteProgress
Modifier and Type | Field and Description |
---|---|
(package private) String |
stepTitle
Title of the current step.
|
Constructor and Description |
---|
StepProgress(int total)
Constructor.
|
StepProgress(String task,
int total)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
StringBuffer |
appendToBuffer(StringBuffer buf)
Append a string representation of the progress to the given string buffer.
|
void |
beginStep(int step,
String stepTitle)
Deprecated.
|
void |
beginStep(int step,
String stepTitle,
Logging logger)
Do a new step and log it
|
protected String |
getStepTitle() |
void |
setCompleted()
Deprecated.
|
void |
setCompleted(Logging logger)
Mark the progress as completed and log it.
|
ensureCompleted, getTotal, isComplete, setProcessed
getProcessed, getTask, incrementProcessed, incrementProcessed, setProcessed, testLoggingRate, toString
String stepTitle
public StepProgress(int total)
total
- Total number of steps.public StepProgress(String task, int total)
task
- Task titletotal
- Total number of steps.public StringBuffer appendToBuffer(StringBuffer buf)
FiniteProgress
appendToBuffer
in interface Progress
appendToBuffer
in class FiniteProgress
buf
- Buffer to serialize to@Deprecated public void beginStep(int step, String stepTitle)
step
- Step numberstepTitle
- Step titlepublic void beginStep(int step, String stepTitle, Logging logger)
step
- Step numberstepTitle
- Step titlelogger
- Logger to report to.@Deprecated public void setCompleted()
public void setCompleted(Logging logger)
logger
- Logger to report to.protected String getStepTitle()