Package com.illumon.util.progress

Class ProcessStatusSubrange

java.lang.Object

com.illumon.util.progress.ProcessStatusSubrange

All Implemented Interfaces:

StatusCallback

public class ProcessStatusSubrange
extends Object
implements StatusCallback

An interface class that allows a StatusCallback to represent a portion of another's range.

Constructor Summary

Constructors

Constructor	Description
ProcessStatusSubrange(StatusCallback parentCallback, int begin, int end)

Method Summary

Modifier and Type	Method	Description
int	getStepValue()	Get the current value of the the current step/subrange.
int	getValue()	get the current value of the progress object.
void	update(int progress, Supplier<String> status)	This object has been assigned a range of the parents range.

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, remaining, remaining, subrange, update

Constructor Details

ProcessStatusSubrange

public ProcessStatusSubrange(StatusCallback parentCallback,
 int begin,
 int end)

Method Details

update

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

This object has been assigned a range of the parents range. Adjust the stepProgress value from 0-100 to the value in the full range of the parent object.

Specified by:

update in interface StatusCallback

Parameters:

progress - percent complete (0-100)

status - optional message text

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

getStepValue

public int getStepValue()

Description copied from interface: StatusCallback

Get the current value of the the current step/subrange.

Specified by:

getStepValue in interface StatusCallback

Returns:

the % complete of the current step - a number between 1 and 100