ProgressLogger (JOTA : Library 1.0.0-beta7 API)

All Known Implementing Classes:

IntervalProgressLogger
```
public interface ProgressLogger
```
Represents a wrapper for the Logger used by IRI that implements a logic to report the progress of a single task. The progress is calculated by comparing the current step to the expected step count and shown as a percentage value.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ProgressLogger`	`abort()` Marks the task as failed and triggers the output of a status message informing us about the failure.
`ProgressLogger`	`abort(Throwable reason)` Marks the task as failed and triggers the output of a status message informing us about the failure.
`ProgressLogger`	`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.
`ProgressLogger`	`progress()` Increases the current step by one and triggers the output of the current progress.
`ProgressLogger`	`progress(int currentStep)` Sets the current step to the given value and triggers the output of the current progress.
`ProgressLogger`	`setCurrentStep(int currentStep)` Sets the current step to the given value without triggering an output.
`ProgressLogger`	`setEnabled(boolean enabled)` This method is the setter for the enabled flag of the logger.
`ProgressLogger`	`setStepCount(int stepCount)` Sets the expected step count to the given value without triggering an output.
`ProgressLogger`	`start()` Starts the logging by (re)setting the current step to 0 and trigger the output of the current progress.
`ProgressLogger`	`start(int stepCount)` Does the same as `start()` but sets the expected step count to the given value.

- Method Detail
  - start
```
ProgressLogger start()
```
    Starts the logging by (re)setting the current step to 0 and trigger the output of the current progress.
    
    Returns:
    
    the logger itself to allow the chaining of calls
  - start
```
ProgressLogger start(int stepCount)
```
    Does the same as start() but sets the expected step count to the given value. This allows us to initialize and start the logging in a single call.
    
    Parameters:
    
    stepCount - number of steps that the task involves
    
    Returns:
    
    the logger itself to allow the chaining of calls
  - progress
```
ProgressLogger 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.
    
    Returns:
    
    the logger itself to allow the chaining of calls
  - progress
```
ProgressLogger progress(int currentStep)
```
    Sets the current step to the given value and triggers the output of the current progress.
    
    Parameters:
    
    currentStep - the current step that was just finished
    
    Returns:
    
    the logger itself to allow the chaining of calls
  - finish
```
ProgressLogger 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.
    
    Returns:
    
    the logger itself to allow the chaining of calls
  - abort
```
ProgressLogger abort()
```
    Marks the task as failed and triggers the output of a status message informing us about the failure.
    
    Returns:
    
    the logger itself to allow the chaining of calls
  - abort
```
ProgressLogger abort(Throwable reason)
```
    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.
    
    Parameters:
    
    reason - reason for the failure
    
    Returns:
    
    the logger itself to allow the chaining of calls
  - getCurrentStep
```
int getCurrentStep()
```
    Returns the current finished step of this logger.
    
    Returns:
    
    current finished step of this logger
  - setCurrentStep
```
ProgressLogger setCurrentStep(int currentStep)
```
    Sets the current step to the given value without triggering an output.
    
    Parameters:
    
    currentStep - the current step that was just finished
    
    Returns:
    
    the logger itself to allow the chaining of calls
  - getStepCount
```
int getStepCount()
```
    Returns the expected step count of this logger.
    
    Returns:
    
    the expected step count of this logger
  - setStepCount
```
ProgressLogger setStepCount(int stepCount)
```
    Sets the expected step count to the given value without triggering an output.
    
    Parameters:
    
    stepCount - the expected step count of this logger
    
    Returns:
    
    the logger itself to allow the chaining of calls
  - getEnabled
```
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.
    
    Returns:
    
    true if the logger shall output messages and false otherwise (the logger is enabled by default)
  - setEnabled
```
ProgressLogger 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.
    
    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

Interface ProgressLogger

Method Summary

Method Detail

start

start

progress

progress

finish

abort

abort

getCurrentStep

setCurrentStep

getStepCount

setStepCount

getEnabled

setEnabled