com.nomagic.task

Interface ProgressStatus

All Known Implementing Classes:

EmptyProgressStatus, SimpleProgressStatus

@OpenApiAll
public interface ProgressStatus

Progress status interface. Usually used when performing long task to show task progress status. Can be implemented in various ways, represented in GUI.

Method Summary

Methods

Modifier and Type	Method and Description
long	getCurrent() Get current progress value.
java.lang.String	getDescription() Get progress description.
long	getMax() Get progress maximum value.
long	getMin() Get progress minimum value.
int	getPercentage() Get completed percentage.
void	increase() Increment progress current value.
void	init(java.lang.String description, long max) Initialize progress.
void	init(java.lang.String description, long min, long max) Initialize progress.
void	init(java.lang.String description, long min, long max, long current) Initialize progress.
boolean	isCancel()
boolean	isCompleted() Checks if progress status completed.
boolean	isIndeterminate() Checks if progres status is indeterminate,
boolean	isLocked() Check if progress status is locked.
void	reset() Reset progress status.
void	setCancel(boolean cancel) Call this when want current operation be canceled.
void	setCurrent(long current) Set progress current value.
void	setDescription(java.lang.String description) Set progress description.
void	setIndeterminate(boolean indeterminate) Set progress status as indeterminate.
void	setLocked(boolean lock) Lock the progress status.
void	setMax(long max) Set progress maximum value.
void	setMin(long min) Set progress minimum value.

Method Detail

setMin

void setMin(long min)

Set progress minimum value.

Parameters:

min -

setMax

void setMax(long max)

Set progress maximum value.

Parameters:

max -

setCurrent

void setCurrent(long current)

Set progress current value.

Parameters:

current -

setDescription

void setDescription(java.lang.String description)

Set progress description.

Parameters:

description -

getPercentage

int getPercentage()

Get completed percentage.

Returns:

getMin

long getMin()

Get progress minimum value.

Returns:

getMax

long getMax()

Get progress maximum value.

Returns:

getCurrent

long getCurrent()

Get current progress value.

Returns:

getDescription

java.lang.String getDescription()

Get progress description.

Returns:

reset

void reset()

Reset progress status.

increase

void increase()

Increment progress current value.

init

void init(java.lang.String description,
        long min,
        long max,
        long current)

Initialize progress.

Parameters:

description - progress description.

min - minimum value.

max - maximum value.

current - current value.

init

void init(java.lang.String description,
        long min,
        long max)

Initialize progress.

Parameters:

description - progress description.

min - minimum value.

max - maximum value.

init

void init(java.lang.String description,
        long max)

Initialize progress.

Parameters:

description - progress description.

max - maximum value.

isCompleted

boolean isCompleted()

Checks if progress status completed.

Returns:

setIndeterminate

void setIndeterminate(boolean indeterminate)

Set progress status as indeterminate.

Parameters:

indeterminate -

isIndeterminate

boolean isIndeterminate()

Checks if progres status is indeterminate,

Returns:

setLocked

void setLocked(boolean lock)

Lock the progress status. Locked status does not change progress value.

Parameters:

lock -

isLocked

boolean isLocked()

Check if progress status is locked.

Returns:

setCancel

void setCancel(boolean cancel)

Call this when want current operation be canceled. Actual operation can not support cancel.

Parameters:

cancel - new cancel value.

isCancel

boolean isCancel()

Returns:

true if current operation is requested to be canceled.