com.speedment.runtime.core.util

Interface ProgressMeasure

public interface ProgressMeasure

Measures the progress of a task.

Since:

2.3.0

Author:

Per Minborg

Field Summary

Fields

Modifier and Type	Field and Description
static double	DONE
static double	INDETERMINATE
static double	INITIAL

Method Summary

Modifier and Type	Method and Description
ProgressMeasure	addListener(Consumer<ProgressMeasure> listener) Adds a listener that will be called each time a value changes.
static ProgressMeasure	create()
String	getCurrentAction() Gets the current action.
double	getProgress() Gets the progress ratio.
default boolean	isDone() Returns true if this task is done.
void	setCurrentAction(String action) Sets the current action.
void	setProgress(double value) Sets the progress ratio.

Field Detail

INDETERMINATE

static final double INDETERMINATE

See Also:

Constant Field Values

INITIAL

static final double INITIAL

See Also:

Constant Field Values

DONE

static final double DONE

See Also:

Constant Field Values

Method Detail

setProgress

void setProgress(double value)

Sets the progress ratio. A negative value for progress indicates that the progress is indeterminate. A positive value between 0 and 1 indicates the percentage of progress where 0 is 0% and 1 is 100%. Any value greater than 1 is interpreted as 100%.

Parameters:

value - the new progress value

getProgress

double getProgress()

Gets the progress ratio. A negative value for progress indicates that the progress is indeterminate. A positive value between 0 and 1 indicates the percentage of progress where 0 is 0% and 1 is 100%. Any value greater than 1 is interpreted as 100%.

Returns:

the progress ratio

isDone

default boolean isDone()

Returns true if this task is done.

Returns:

true if done, else false

setCurrentAction

void setCurrentAction(String action)

Sets the current action.

Parameters:

action - what is going on

getCurrentAction

String getCurrentAction()

Gets the current action.

Returns:

what is going on

addListener

ProgressMeasure addListener(Consumer<ProgressMeasure> listener)

Adds a listener that will be called each time a value changes.

Parameters:

listener - to add

Returns:

an instance of a ProgressMeasure that has the provided listener

create

static ProgressMeasure create()