net.bluemind.cli.utils

Class CliTaskMonitor

java.lang.Object

net.bluemind.cli.utils.CliTaskMonitor

All Implemented Interfaces:

IServerTaskMonitor

public class CliTaskMonitor
extends java.lang.Object
implements IServerTaskMonitor

Constructor Summary

Constructors

Constructor and Description
CliTaskMonitor()
CliTaskMonitor(java.lang.String logPrefix)

Method Summary

Modifier and Type	Method and Description
protected org.fusesource.jansi.Ansi	ansi()
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	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.
void	progress(int total, int current)
IServerTaskMonitor	subWork(double work)
IServerTaskMonitor	subWork(java.lang.String logPrefix, double work) Create a sub task monitor that uses a given amount of work unit from the task

Methods inherited from class java.lang.Object

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

Constructor Detail

CliTaskMonitor

public CliTaskMonitor()

CliTaskMonitor

public CliTaskMonitor(java.lang.String logPrefix)

Method Detail

ansi

protected org.fusesource.jansi.Ansi ansi()

subWork

public IServerTaskMonitor subWork(double work)

Specified by:

subWork in interface IServerTaskMonitor

See Also:

IServerTaskMonitor.subWork(String, double)

subWork

public IServerTaskMonitor subWork(java.lang.String logPrefix,
                                  double work)

Description copied from interface: IServerTaskMonitor

Create a sub task monitor that uses a given amount of work unit from the task

Specified by:

subWork in interface IServerTaskMonitor

work - the total number of work units given to the sub task monitor task.

Returns:

a sub task monitor. Begin must be called on the return monitor

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.

Specified by:

begin in interface IServerTaskMonitor

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.

Specified by:

progress in interface IServerTaskMonitor

Parameters:

doneWork - number of work units just completed

progress

public void progress(int total,
                     int current)

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.

Specified by:

end in interface IServerTaskMonitor

log

public void log(java.lang.String log)

Specified by:

log in interface IServerTaskMonitor