public class PrintWriterProgressMonitor extends Object implements ProgressMonitor
PrintWriter
.NULL, UNKNOWN
Constructor and Description |
---|
PrintWriterProgressMonitor(OutputStream output) |
PrintWriterProgressMonitor(PrintWriter output) |
Modifier and Type | Method and Description |
---|---|
void |
beginTask(String name,
int totalWork)
Notifies that the main task is beginning.
|
void |
done()
Notifies that the work is done; that is, either the main task is completed
or the user canceled it.
|
protected String |
getMessage() |
int |
getPercentageWorked() |
int |
getPrintStepPercentage() |
String |
getSubTaskName() |
String |
getTaskName() |
void |
internalWorked(double work)
Internal method to handle scaling correctly.
|
boolean |
isCanceled()
Returns whether cancelation of current operation has been requested.
|
protected void |
printCanceledMessage(PrintWriter pw) |
protected void |
printDoneMessage(PrintWriter pw) |
protected void |
printStartMessage(PrintWriter pw) |
protected void |
printWorkedMessage(PrintWriter pw) |
void |
setCanceled(boolean canceled)
Sets the cancel state to the given value.
|
void |
setPrintStepPercentage(int printStepPercentage) |
void |
setSubTaskName(String subTaskName)
Notifies that a subtask of the main task is beginning.
|
void |
setTaskName(String taskName)
Sets the task name to the given value.
|
void |
worked(int work)
Notifies that a given number of work unit of the main task
has been completed.
|
public PrintWriterProgressMonitor(OutputStream output)
public PrintWriterProgressMonitor(PrintWriter output)
public String getTaskName()
public void setTaskName(String taskName)
ProgressMonitor
setTaskName
in interface ProgressMonitor
taskName
- the name (or description) of the main taskProgressMonitor.beginTask(String, int)
public String getSubTaskName()
public void setSubTaskName(String subTaskName)
ProgressMonitor
setSubTaskName
in interface ProgressMonitor
subTaskName
- the name (or description) of the subtaskpublic int getPrintStepPercentage()
public void setPrintStepPercentage(int printStepPercentage)
public int getPercentageWorked()
public void beginTask(String name, int totalWork)
ProgressMonitor
beginTask
in interface ProgressMonitor
name
- the name (or description) of the main tasktotalWork
- the total number of work units into which
the main task is been subdivided. If the value is UNKNOWN
the implementation is free to indicate progress in a way which
doesn't require the total number of work units in advance.public void done()
ProgressMonitor
done
in interface ProgressMonitor
public void worked(int work)
ProgressMonitor
worked
in interface ProgressMonitor
work
- the number of work units just completedpublic void internalWorked(double work)
ProgressMonitor
worked(int)
.internalWorked
in interface ProgressMonitor
work
- the amount of work donepublic boolean isCanceled()
ProgressMonitor
isCanceled
in interface ProgressMonitor
true
if cancellation has been requested,
and false
otherwiseProgressMonitor.setCanceled(boolean)
public void setCanceled(boolean canceled)
ProgressMonitor
setCanceled
in interface ProgressMonitor
canceled
- true
indicates that cancelation has
been requested (but not necessarily acknowledged);
false
clears this flagProgressMonitor.isCanceled()
protected void printStartMessage(PrintWriter pw)
protected void printWorkedMessage(PrintWriter pw)
protected void printDoneMessage(PrintWriter pw)
protected void printCanceledMessage(PrintWriter pw)
protected String getMessage()
Copyright © 2014–2015 European Space Agency (ESA). All rights reserved.