co.codewizards.cloudstore.core.progress

Class LoggerProgressMonitor

java.lang.Object

co.codewizards.cloudstore.core.progress.LoggerProgressMonitor

All Implemented Interfaces:

ProgressMonitor

public class LoggerProgressMonitor
extends Object
implements ProgressMonitor

A progress monitor implementation which logs to an SLF4J Logger.

Author:

Marco หงุ่ยตระกูล-Schulze - marco at nightlabs dot de

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoggerProgressMonitor.LogLevel The level to use for logging.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MESSAGE_VARIABLE_NAME The variable containing the task-name (i.e.
static String	MESSAGE_VARIABLE_PERCENTAGE The variable containing the current percentage.

Constructor Summary

Constructors

Constructor and Description
LoggerProgressMonitor(Logger logger) Create a monitor logging to the specified logger.

Method Summary

Methods

Modifier and Type	Method and Description
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.
Logger	getLogger() Get the logger to which this monitor is writing.
LoggerProgressMonitor.LogLevel	getLogLevel() Get the log-level that is used when writing to the logger.
float	getLogMinPercentageDifference() Get the minimum percentage difference to trigger a new log message.
long	getLogMinPeriodMSec() Get the minimum log period in milliseconds.
String	getMessage() Get the log-message.
void	internalWorked(double worked) Internal method to handle scaling correctly.
boolean	isCanceled() Returns whether cancelation of current operation has been requested.
void	setCanceled(boolean canceled) Sets the cancel state to the given value.
void	setLogLevel(LoggerProgressMonitor.LogLevel logLevel) Set the log-level to use when writing to the logger.
void	setLogMinPercentageDifference(float logMinPercentageDifference) Set the minimum period between log messages in milliseconds.
void	setLogMinPeriodMSec(long logMinPeriodMSec) Set the minimum period between log messages in milliseconds.
void	setMessage(String message) Set the message which will be written to the logger.
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

MESSAGE_VARIABLE_NAME

public static final String MESSAGE_VARIABLE_NAME

The variable containing the task-name (i.e. what is done). This is the name which is passed to the ProgressMonitor.beginTask(String, int) method.

See Also:

setMessage(String), Constant Field Values

MESSAGE_VARIABLE_PERCENTAGE

public static final String MESSAGE_VARIABLE_PERCENTAGE

The variable containing the current percentage.

See Also:

setMessage(String), Constant Field Values

Constructor Detail

LoggerProgressMonitor

public LoggerProgressMonitor(Logger logger)

Create a monitor logging to the specified logger.

Parameters:

logger - the logger to write to. Must not be null.

Method Detail

getMessage

public String getMessage()

Get the log-message. For details see setMessage(String).

Returns:

the message to be logged.

See Also:

setMessage(String)

setMessage

public void setMessage(String message)

Set the message which will be written to the logger.

Before writing to the logger, the variables contained in this message are replaced by their actual values. The following variables can be used:

• MESSAGE_VARIABLE_NAME
• MESSAGE_VARIABLE_PERCENTAGE

Parameters:

message - the message to be logged.

See Also:

getMessage()

getLogger

public Logger getLogger()

Get the logger to which this monitor is writing. It is the one that has been passed to LoggerProgressMonitor(Logger) before.

Returns:

the logger.

getLogMinPeriodMSec

public long getLogMinPeriodMSec()

Get the minimum log period in milliseconds. For details see setLogMinPeriodMSec(long).

Returns:

the minimum log period.

See Also:

setLogMinPeriodMSec(long)

setLogMinPeriodMSec

public void setLogMinPeriodMSec(long logMinPeriodMSec)

Set the minimum period between log messages in milliseconds.

In order to prevent log flooding as well as to improve performance, calling worked(int) or internalWorked(double) will only cause a log message to be printed, if at least one of the following criteria are met:

• The last log message happened longer ago than the time (in milliseconds) configured by the property logMinPeriodMSec (i.e. by this method).
• The percentage difference to the last log message is larger than the min-percentage-difference.
• 100% are reached.

Parameters:

logMinPeriodMSec - the minimum period between log messages.

See Also:

getLogMinPeriodMSec(), setLogMinPercentageDifference(float)

getLogMinPercentageDifference

public float getLogMinPercentageDifference()

Get the minimum percentage difference to trigger a new log message. For details see setLogMinPercentageDifference(float).

Returns:

the minimum percentage difference.

See Also:

setLogMinPercentageDifference(float)

setLogMinPercentageDifference

public void setLogMinPercentageDifference(float logMinPercentageDifference)

Set the minimum period between log messages in milliseconds.

In order to prevent log flooding as well as to improve performance, calling worked(int) or internalWorked(double) will only cause a log message to be printed, if at least one of the following criteria are met:

• The last log message happened longer ago than the time (in milliseconds) configured by the property logMinPeriodMSec.
• The percentage difference to the last log message is larger than the percentage configured by the property logMinPercentageDifference (i.e. by this method).
• 100% are reached.

Parameters:

logMinPercentageDifference - the minimum percentage difference between log messages.

See Also:

getLogMinPercentageDifference(), setLogMinPeriodMSec(long)

beginTask

public void beginTask(String name,
             int totalWork)

Description copied from interface: ProgressMonitor

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

Specified by:

beginTask in interface ProgressMonitor

Parameters:

name - the name (or description) of the main task

totalWork - the total number of work units into which the main task is been subdivided. If the value is UNKNOWN the implementation is free to indicate progress in a way which doesn't require the total number of work units in advance.

done

public void done()

Description copied from interface: ProgressMonitor

Notifies that the work is done; that is, either the main task is completed or the user canceled it. This method may be called more than once (implementations should be prepared to handle this case).

Specified by:

done in interface ProgressMonitor

internalWorked

public void internalWorked(double worked)

Description copied from interface: ProgressMonitor

Internal method to handle scaling correctly. This method must not be called by a client. Clients should always use the method worked(int).

Note: EclipseRCP is strange!

Specified by:

internalWorked in interface ProgressMonitor

Parameters:

worked - the amount of work done

getLogLevel

public LoggerProgressMonitor.LogLevel getLogLevel()

Get the log-level that is used when writing to the logger.

Returns:

the log-level to be used.

setLogLevel

public void setLogLevel(LoggerProgressMonitor.LogLevel logLevel)

Set the log-level to use when writing to the logger.

Parameters:

logLevel - the LoggerProgressMonitor.LogLevel to be used.

isCanceled

public boolean isCanceled()

Description copied from interface: ProgressMonitor

Returns whether cancelation of current operation has been requested. Long-running operations should poll to see if cancelation has been requested.

If this is true, the long-running operation should throw an OperationCanceledException.

Specified by:

isCanceled in interface ProgressMonitor

Returns:

true if cancellation has been requested, and false otherwise

See Also:

ProgressMonitor.setCanceled(boolean)

setCanceled

public void setCanceled(boolean canceled)

Description copied from interface: ProgressMonitor

Sets the cancel state to the given value.

Specified by:

setCanceled in interface ProgressMonitor

Parameters:

canceled - true indicates that cancelation has been requested (but not necessarily acknowledged); false clears this flag

See Also:

ProgressMonitor.isCanceled()

setTaskName

public void setTaskName(String name)

Description copied from interface: ProgressMonitor

Sets the task name to the given value. This method is used to restore the task label after a nested operation was executed. Normally there is no need for clients to call this method.

Specified by:

setTaskName in interface ProgressMonitor

Parameters:

name - the name (or description) of the main task

See Also:

ProgressMonitor.beginTask(java.lang.String, int)

subTask

public void subTask(String name)

Description copied from interface: ProgressMonitor

Notifies that a subtask of the main task is beginning. Subtasks are optional; the main task might not have subtasks.

Specified by:

subTask in interface ProgressMonitor

Parameters:

name - the name (or description) of the subtask

worked

public void worked(int work)

Description copied from interface: ProgressMonitor

Notifies that a given number of work unit of the main task has been completed. Note that this amount represents an installment, as opposed to a cumulative amount of work done to date.

Specified by:

worked in interface ProgressMonitor

Parameters:

work - the number of work units just completed