Package org.hortonmachine.gears.libs.monitor

Class PrintStreamProgressMonitor

java.lang.Object

org.hortonmachine.gears.libs.monitor.PrintStreamProgressMonitor

All Implemented Interfaces:

IHMProgressMonitor

public class PrintStreamProgressMonitor
extends Object
implements IHMProgressMonitor

A progress monitor for printstream based applications, i.e. console or commandline.

This implements both IHMProgressMonitor and IProgressMonitor in order to be used also in the part of the code that needs to stay clean of rcp code.

Author:

Andrea Antonello (www.hydrologis.com)

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	cancelled
protected PrintStream	errStream
protected int	lastPercentage
protected PrintStream	outStream
protected int	runningWork
protected String	taskName
protected int	totalWork

Fields inherited from interface org.hortonmachine.gears.libs.monitor.IHMProgressMonitor

UNKNOWN

Constructor Summary

Constructors

Constructor	Description
PrintStreamProgressMonitor()
PrintStreamProgressMonitor(PrintStream outStream, PrintStream errorStream)
PrintStreamProgressMonitor(String prefix, PrintStream outStream, PrintStream errorStream)

Method Summary

Modifier and Type	Method	Description
<T> T	adapt(Class<T> adaptee)	Adapts the monitor to a given class.
void	beginTask(String name)
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.
void	errorMessage(String message)	Sends out an error message.
void	exceptionThrown(String message)	Method to be called in case of exception.
PrintStream	getPrintStream()
void	internalWorked(double work)	Internal method to handle scaling correctly.
boolean	isCanceled()	Returns whether cancellation of current operation has been requested.
void	message(String message)	Sends out a message.
void	onModuleExit()	Method to call on module finalization.
void	setCanceled(boolean cancelled)	Sets the cancel state to the given value.
void	setTaskName(String name)	Sets the task name to the given value.
void	subTask(String name)	Notifies that a subtask of the main task is beginning.
void	worked(int work)	Notifies that a given number of work unit of the main task has been completed.

Methods inherited from class java.lang.Object

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

Field Detail

cancelled

protected boolean cancelled

outStream

protected final PrintStream outStream

errStream

protected final PrintStream errStream

taskName

protected String taskName

totalWork

protected int totalWork

runningWork

protected int runningWork

lastPercentage

protected int lastPercentage

Constructor Detail

PrintStreamProgressMonitor

public PrintStreamProgressMonitor()

PrintStreamProgressMonitor

public PrintStreamProgressMonitor(PrintStream outStream,
                                  PrintStream errorStream)

PrintStreamProgressMonitor

public PrintStreamProgressMonitor(String prefix,
                                  PrintStream outStream,
                                  PrintStream errorStream)

Method Detail

beginTask

public void beginTask(String name,
                      int totalWork)

Description copied from interface: IHMProgressMonitor

Notifies that the main task is beginning.

Specified by:

beginTask in interface IHMProgressMonitor

beginTask

public void beginTask(String name)

done

public void done()

Description copied from interface: IHMProgressMonitor

Notifies that the work is done; that is, either the main task is completed or the user canceled it.

Specified by:

done in interface IHMProgressMonitor

internalWorked

public void internalWorked(double work)

Description copied from interface: IHMProgressMonitor

Internal method to handle scaling correctly.

Specified by:

internalWorked in interface IHMProgressMonitor

isCanceled

public boolean isCanceled()

Description copied from interface: IHMProgressMonitor

Returns whether cancellation of current operation has been requested.

Specified by:

isCanceled in interface IHMProgressMonitor

Returns:

setCanceled

public void setCanceled(boolean cancelled)

Description copied from interface: IHMProgressMonitor

Sets the cancel state to the given value.

Specified by:

setCanceled in interface IHMProgressMonitor

setTaskName

public void setTaskName(String name)

Description copied from interface: IHMProgressMonitor

Sets the task name to the given value.

Specified by:

setTaskName in interface IHMProgressMonitor

subTask

public void subTask(String name)

Description copied from interface: IHMProgressMonitor

Notifies that a subtask of the main task is beginning.

Specified by:

subTask in interface IHMProgressMonitor

worked

public void worked(int work)

Description copied from interface: IHMProgressMonitor

Notifies that a given number of work unit of the main task has been completed.

Specified by:

worked in interface IHMProgressMonitor

getPrintStream

public PrintStream getPrintStream()

adapt

public <T> T adapt(Class<T> adaptee)

Description copied from interface: IHMProgressMonitor

Adapts the monitor to a given class.

Specified by:

adapt in interface IHMProgressMonitor

Parameters:

adaptee - the class to which to adapt to.

Returns:

the adapted object or null, if it is not assignable.

errorMessage

public void errorMessage(String message)

Description copied from interface: IHMProgressMonitor

Sends out an error message.

Specified by:

errorMessage in interface IHMProgressMonitor

Parameters:

message - the error message to send out.

message

public void message(String message)

Description copied from interface: IHMProgressMonitor

Sends out a message.

Specified by:

message in interface IHMProgressMonitor

Parameters:

message - the message to send out.

exceptionThrown

public void exceptionThrown(String message)

Description copied from interface: IHMProgressMonitor

Method to be called in case of exception.

Specified by:

exceptionThrown in interface IHMProgressMonitor

Parameters:

message - the error message to send out.

onModuleExit

public void onModuleExit()

Description copied from interface: IHMProgressMonitor

Method to call on module finalization.

Specified by:

onModuleExit in interface IHMProgressMonitor