hu.scelightapibase.service.job

Interface IProgressJob

All Superinterfaces:

HasRIcon, IControlledThread, IJob, INormalThread

public interface IProgressJob
extends IJob

An IJob which publishes its progress.

Author:

Andras Belicza

See Also:

IFactory.newJob(String, IRIcon, Runnable), IJob

Method Summary

Methods

Modifier and Type	Method and Description
int	getCurrentProgress() Returns the current progress value.
int	getMaximumProgress() Returns the maximum progress value.
void	setCurrentProgress(int currentValue) Sets the current progress value.
void	setMaximumProgress(int maxValue) Sets the maximum progress value.

Methods inherited from interface hu.scelightapibase.service.job.IJob

getStartedAt, setCallback, setEdtCallback, toString

Methods inherited from interface hu.scelightapibase.util.IControlledThread

close, getControlledState, getExecTimeMs, getPausedTimeMs, guestMayContinue, guestWaitIfPaused, isCancelRequested, isPauseRequested, mayContinue, requestCancel, requestPause, requestUnpause, waitIfPaused

Methods inherited from interface hu.scelightapibase.util.INormalThread

asThread, checkedSleep, start, waitToFinish

Methods inherited from interface hu.scelightapibase.util.gui.HasRIcon

getRicon

Method Detail

getMaximumProgress

int getMaximumProgress()

Returns the maximum progress value. A negative value indicates indeterminate status.

Returns:

the maximum progress value; a negative value indicates indeterminate status

See Also:

setMaximumProgress(int), getCurrentProgress()

setMaximumProgress

void setMaximumProgress(int maxValue)

Sets the maximum progress value. A negative value indicates indeterminate status.

Parameters:

maxValue - max progress value to be set

See Also:

getMaximumProgress()

getCurrentProgress

int getCurrentProgress()

Returns the current progress value.

Returns:

the current progress value

See Also:

setCurrentProgress(int), getMaximumProgress()

setCurrentProgress

void setCurrentProgress(int currentValue)

Sets the current progress value.

Parameters:

currentValue - current progress value to be set

See Also:

getCurrentProgress()