Package com.illumon.util.progress

Class ProgressLogger

java.lang.Object

com.illumon.util.progress.ProgressLogger

All Implemented Interfaces:

StatusCallback

public class ProgressLogger
extends Object
implements StatusCallback

Log the status and progress to a log file.

Constructor Summary

Constructors

Constructor	Description
ProgressLogger(StatusCallback parent, com.fishlib.io.logger.Logger log)

Method Summary

Modifier and Type	Method	Description
int	getValue()	get the current value of the progress object.
void	update(int progress, Supplier<String> status)	Update the progress % and status message.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.illumon.util.progress.StatusCallback

finish, finish, getStepValue, remaining, remaining, subrange, update

Constructor Details

ProgressLogger

public ProgressLogger(StatusCallback parent,
 com.fishlib.io.logger.Logger log)

Method Details

update

public void update(int progress,
 Supplier<String> status)

Description copied from interface: StatusCallback

Update the progress % and status message.

Specified by:

update in interface StatusCallback

Parameters:

progress - percent complete (0-100)

status - optional message supplier

getValue

public int getValue()

Description copied from interface: StatusCallback

get the current value of the progress object.

Specified by:

getValue in interface StatusCallback

Returns:

the % complete of the topmost ProcessStatus - a number between 1 and 100