Package snap.util

Class TaskMonitor.Text

java.lang.Object

snap.util.TaskMonitor.Text

All Implemented Interfaces:

TaskMonitor

Enclosing interface:

TaskMonitor

public static class TaskMonitor.Text
extends Object
implements TaskMonitor

A simple progress reporter printing on a stream.

Nested Class Summary

Nested classes/interfaces inherited from interface snap.util.TaskMonitor

TaskMonitor.Text

Field Summary

Fields inherited from interface snap.util.TaskMonitor

NULL

Constructor Summary

Constructors

Constructor	Description
Text(PrintStream aPS)	Initialize a new progress monitor.
Text(Writer out)	Initialize a new progress monitor.

Method Summary

Modifier and Type	Method	Description
void	beginTask(String aTitle, int theTotalWork)	Called to start task with total work.
void	endTask()	Called to end task work count.
boolean	isCancelled()	Check for user task cancellation.
void	startTasks(int aTaskCount)	Called to start monitor with number of tasks.
void	updateTask(int theWorkDone)	Called to update task work count.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Text

public Text(PrintStream aPS)

Initialize a new progress monitor.

Text

public Text(Writer out)

Initialize a new progress monitor.

Method Details

startTasks

public void startTasks(int aTaskCount)

Called to start monitor with number of tasks.

Specified by:

startTasks in interface TaskMonitor

beginTask

public void beginTask(String aTitle,
 int theTotalWork)

Called to start task with total work.

Specified by:

beginTask in interface TaskMonitor

updateTask

public void updateTask(int theWorkDone)

Called to update task work count.

Specified by:

updateTask in interface TaskMonitor

endTask

public void endTask()

Called to end task work count.

Specified by:

endTask in interface TaskMonitor

isCancelled

public boolean isCancelled()

Check for user task cancellation.

Specified by:

isCancelled in interface TaskMonitor

Returns:

true if the user asked the process to stop working.