org.iota.jota.utils.log.interval

Class IntervalProgressLogger

java.lang.Object

org.iota.jota.utils.log.interval.IntervalProgressLogger

All Implemented Interfaces:

ProgressLogger

public class IntervalProgressLogger
extends Object
implements ProgressLogger

Implements the basic contract of the ProgressLogger while showing the progress as messages in the console. Instead of printing all messages immediately and unnecessarily spamming the console output, it rate limits the amount of messages shown and only prints updates in a pre-defined interval.

Constructor Summary

Constructors

Constructor and Description
IntervalProgressLogger(String taskName, Class<?> clazz) Does the same as IntervalProgressLogger(String, Class, int) but defaults to DEFAULT_LOG_INTERVAL for the interval.
IntervalProgressLogger(String taskName, Class<?> clazz, int logInterval) Creates a ProgressLogger that shows its progress in a pre-defined interval.
IntervalProgressLogger(String taskName, org.slf4j.Logger logger) Does the same as IntervalProgressLogger(String, Logger, int) but defaults to DEFAULT_LOG_INTERVAL for the interval.
IntervalProgressLogger(String taskName, org.slf4j.Logger logger, int logInterval) Creates a ProgressLogger that shows its progress in a pre-defined interval.

Method Summary

Modifier and Type	Method and Description
IntervalProgressLogger	abort() Marks the task as failed and triggers the output of a status message informing us about the failure.
IntervalProgressLogger	abort(Throwable cause) Marks the task as failed and triggers the output of a status message informing us about the failure.
IntervalProgressLogger	finish() Sets the current step to the expected step count and triggers the output of the current progress.
int	getCurrentStep() Returns the current finished step of this logger.
boolean	getEnabled() This method is the getter for the enabled flag of the logger.
int	getStepCount() Returns the expected step count of this logger.
IntervalProgressLogger	progress() Increases the current step by one and triggers the output of the current progress.
IntervalProgressLogger	progress(int currentStep) Sets the current step to the given value and triggers the output of the current progress.
IntervalProgressLogger	setCurrentStep(int currentStep) Sets the current step to the given value without triggering an output.
IntervalProgressLogger	setEnabled(boolean enabled) This method is the setter for the enabled flag of the logger.
IntervalProgressLogger	setStepCount(int stepCount) Sets the expected step count to the given value without triggering an output.
IntervalProgressLogger	start() Starts the logging by (re)setting the current step to 0 and trigger the output of the current progress.
IntervalProgressLogger	start(int stepCount) Does the same as ProgressLogger.start() but sets the expected step count to the given value.

Methods inherited from class java.lang.Object

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

Constructor Detail

IntervalProgressLogger

public IntervalProgressLogger(String taskName,
                              Class<?> clazz)

Does the same as IntervalProgressLogger(String, Class, int) but defaults to DEFAULT_LOG_INTERVAL for the interval.

Parameters:

taskName - name of the task that shall be shown on the screen

clazz - class that is used to identify the origin of the log messages

IntervalProgressLogger

public IntervalProgressLogger(String taskName,
                              org.slf4j.Logger logger)

Does the same as IntervalProgressLogger(String, Logger, int) but defaults to DEFAULT_LOG_INTERVAL for the interval.

Parameters:

taskName - name of the task that shall be shown on the screen

logger - logback logger for issuing the messages

IntervalProgressLogger

public IntervalProgressLogger(String taskName,
                              Class<?> clazz,
                              int logInterval)

Creates a ProgressLogger that shows its progress in a pre-defined interval.

Parameters:

taskName - name of the task that shall be shown on the screen

clazz - class that is used to identify the origin of the log messages

logInterval - the time in milliseconds between consecutive log messages

IntervalProgressLogger

public IntervalProgressLogger(String taskName,
                              org.slf4j.Logger logger,
                              int logInterval)

Creates a ProgressLogger that shows its progress in a pre-defined interval.

Parameters:

taskName - name of the task that shall be shown on the screen

logger - logback logger for issuing the messages

logInterval - the time in milliseconds between consecutive log messages

Method Detail

start

public IntervalProgressLogger start()

Starts the logging by (re)setting the current step to 0 and trigger the output of the current progress.

Specified by:

start in interface ProgressLogger

Returns:

the logger itself to allow the chaining of calls

start

public IntervalProgressLogger start(int stepCount)

Does the same as ProgressLogger.start() but sets the expected step count to the given value. This allows us to initialize and start the logging in a single call.

Specified by:

start in interface ProgressLogger

Parameters:

stepCount - number of steps that the task involves

Returns:

the logger itself to allow the chaining of calls

progress

public IntervalProgressLogger progress()

Increases the current step by one and triggers the output of the current progress. This should be called whenever we finish a sub task.

Specified by:

progress in interface ProgressLogger

Returns:

the logger itself to allow the chaining of calls

progress

public IntervalProgressLogger progress(int currentStep)

Sets the current step to the given value and triggers the output of the current progress.

Specified by:

progress in interface ProgressLogger

Parameters:

currentStep - the current step that was just finished

Returns:

the logger itself to allow the chaining of calls

finish

public IntervalProgressLogger finish()

Sets the current step to the expected step count and triggers the output of the current progress. This allows us to dump the progress when the processing of the task succeeds. It will show the message immediately instead of waiting for the interval to pass.

Specified by:

finish in interface ProgressLogger

Returns:

the logger itself to allow the chaining of calls

abort

public IntervalProgressLogger abort()

Marks the task as failed and triggers the output of a status message informing us about the failure. It will show the message immediately instead of waiting for the interval to pass.

Specified by:

abort in interface ProgressLogger

Returns:

the logger itself to allow the chaining of calls

abort

public IntervalProgressLogger abort(Throwable cause)

Marks the task as failed and triggers the output of a status message informing us about the failure. The shown error message will contain the reason for the error given by the passed in Exception. It will show the message immediately instead of waiting for the interval to pass.

Specified by:

abort in interface ProgressLogger

Parameters:

cause - reason for the failure

Returns:

the logger itself to allow the chaining of calls

getCurrentStep

public int getCurrentStep()

Returns the current finished step of this logger.

Specified by:

getCurrentStep in interface ProgressLogger

Returns:

current finished step of this logger

setCurrentStep

public IntervalProgressLogger setCurrentStep(int currentStep)

Sets the current step to the given value without triggering an output.

Specified by:

setCurrentStep in interface ProgressLogger

Parameters:

currentStep - the current step that was just finished

Returns:

the logger itself to allow the chaining of calls

getStepCount

public int getStepCount()

Returns the expected step count of this logger.

Specified by:

getStepCount in interface ProgressLogger

Returns:

the expected step count of this logger

setStepCount

public IntervalProgressLogger setStepCount(int stepCount)

Sets the expected step count to the given value without triggering an output.

Specified by:

setStepCount in interface ProgressLogger

Parameters:

stepCount - the expected step count of this logger

Returns:

the logger itself to allow the chaining of calls

getEnabled

public boolean getEnabled()

This method is the getter for the enabled flag of the logger. If the logger is disabled it will simply omit showing log messages.

Specified by:

getEnabled in interface ProgressLogger

Returns:

true if the logger shall output messages and false otherwise (the logger is enabled by default)

setEnabled

public IntervalProgressLogger setEnabled(boolean enabled)

This method is the setter for the enabled flag of the logger. If the logger is disabled it will simply omit showing log messages.

Specified by:

setEnabled in interface ProgressLogger

Parameters:

enabled - true if the logger shall output messages and false otherwise (the logger is enabled by default)

Returns:

the logger itself to allow the chaining of calls