net.bluemind.core.task.service.internal

Class TaskMonitor

java.lang.Object

net.bluemind.core.task.service.AbstractTaskMonitor

net.bluemind.core.task.service.internal.TaskMonitor

All Implemented Interfaces:

IServerTaskMonitor, ISubTaskMonitorParent

public class TaskMonitor
extends AbstractTaskMonitor

Constructor Summary

Constructors

Constructor and Description
TaskMonitor(io.vertx.core.eventbus.EventBus eventBus, java.lang.String taskId)

Method Summary

Modifier and Type	Method and Description
void	begin(double work, 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.
boolean	ended()
void	log(java.lang.String log)
void	progress(double step, 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

TaskMonitor

public TaskMonitor(io.vertx.core.eventbus.EventBus eventBus,
                   java.lang.String taskId)

Method Detail

begin

public void begin(double work,
                  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:

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

progress

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

Description copied from interface: IServerTaskMonitor

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

Parameters:

step - number of work units just completed

log

public void log(java.lang.String log)

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.

ended

public boolean ended()