net.bluemind.core.task.service

Class SubTaskMonitor

java.lang.Object

net.bluemind.core.task.service.AbstractTaskMonitor

net.bluemind.core.task.service.SubTaskMonitor

All Implemented Interfaces:

IServerTaskMonitor, ISubTaskMonitorParent

public class SubTaskMonitor
extends AbstractTaskMonitor

Constructor Summary

Constructors

Constructor and Description
SubTaskMonitor(int depth, java.lang.String logPrefix, double work, double subTotalWork, ISubTaskMonitorParent parentMonitor)

Method Summary

Modifier and Type	Method and Description
void	begin(double totalWork, java.lang.String log) Notifies that the task is beginning.
void	end(boolean success, java.lang.String log, java.lang.String result) Notifies that the task has been completed.
void	flush()
void	log(java.lang.String log)
void	progress(double doneWork, java.lang.String log) Notifies that a given number of work unit of the task has been completed.

Methods inherited from class net.bluemind.core.task.service.AbstractTaskMonitor

childEnded, subWork, subWork

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.bluemind.core.task.service.IServerTaskMonitor

begin, end, log, log, log, log, progress

Constructor Detail

SubTaskMonitor

public SubTaskMonitor(int depth,
                      java.lang.String logPrefix,
                      double work,
                      double subTotalWork,
                      ISubTaskMonitorParent parentMonitor)

Method Detail

begin

public void begin(double totalWork,
                  java.lang.String log)

Description copied from interface: IServerTaskMonitor

Notifies that the task is beginning. This must only be called once on a given monitor instance.

Parameters:

totalWork - the total number of work units into which the task is been subdivided.

progress

public void progress(double doneWork,
                     java.lang.String log)

Description copied from interface: IServerTaskMonitor

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

Parameters:

doneWork - number of work units just completed

end

public void end(boolean success,
                java.lang.String log,
                java.lang.String result)

Description copied from interface: IServerTaskMonitor

Notifies that the task has been completed.

flush

public void flush()

log

public void log(java.lang.String log)