net.lecousin.framework.progress

Interface WorkProgress

All Superinterfaces:

SimpleListenable

All Known Implementing Classes:

FakeWorkProgress, MultiTaskProgress, SplashScreen, SubWorkProgress, WorkProgressImpl

public interface WorkProgress
extends SimpleListenable

A WorkProgress allows to follow the progression of an asynchronous or background work.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	WorkProgress.MultiTask Interface for a multi-task progress, which is composed of sub-WorkProgress.

Method Summary

Modifier and Type	Method and Description
void	cancel(CancelException reason) Cancel the underlying work.
void	done() Signal all the work has been done.
void	error(Exception error) Signal an error.
long	getAmount() Return the total amount of work to be done.
long	getPosition() Return the current position, which is the current amount of work already done.
long	getRemainingWork() Return the amount of remaining work.
String	getSubText() Return a sub-text describing the work being done.
IAsync<Exception>	getSynch() Return a synchronization point that will be unblocked by one of the method done, error or cancel.
String	getText() Return the text describing the work being done.
void	interruptEvents() Stop triggering events to listener, this may be useful before doing several modifications.
static void	link(WorkProgress subTask, WorkProgress progress, long work) Once the given sub-task is done, the given amount of work is added to the progress.
static void	linkTo(WorkProgress progress, IAsync<?> sp) Link this WorkProgress with the given synchronization point: once the synchronization point is unblocked, one of the done, error or cancel method is called.
static void	linkTo(WorkProgress progress, Task<?,?> task) Link this WorkProgress with the given task: once the task is done, one of the done, error or cancel method is called.
void	progress(long amountDone) Add an amount of work already done.
void	resumeEvents(boolean trigger) Resume triggering events after a call to interruptEvents(), and optionally trigger an event now.
void	setAmount(long work) Set the total amount of work to be done.
void	setPosition(long position) Set the position (amount of work already done).
void	setSubText(String text) Set the sub-text describing the work being done.
void	setText(String text) Set the text describing the work being done.

Methods inherited from interface net.lecousin.framework.event.SimpleListenable

addListener, hasListeners, listen, removeListener, unlisten

Method Detail

setAmount

void setAmount(long work)

Set the total amount of work to be done.

getAmount

long getAmount()

Return the total amount of work to be done.

setPosition

void setPosition(long position)

Set the position (amount of work already done).

getPosition

long getPosition()

Return the current position, which is the current amount of work already done.

getRemainingWork

long getRemainingWork()

Return the amount of remaining work.

progress

void progress(long amountDone)

Add an amount of work already done.

done

void done()

Signal all the work has been done.

error

void error(Exception error)

Signal an error.

cancel

void cancel(CancelException reason)

Cancel the underlying work.

getSynch

IAsync<Exception> getSynch()

Return a synchronization point that will be unblocked by one of the method done, error or cancel.

interruptEvents

void interruptEvents()

Stop triggering events to listener, this may be useful before doing several modifications.

resumeEvents

void resumeEvents(boolean trigger)

Resume triggering events after a call to interruptEvents(), and optionally trigger an event now.

getText

String getText()

Return the text describing the work being done.

setText

void setText(String text)

Set the text describing the work being done.

getSubText

String getSubText()

Return a sub-text describing the work being done.

setSubText

void setSubText(String text)

Set the sub-text describing the work being done.

linkTo

static void linkTo(WorkProgress progress,
                   IAsync<?> sp)

Link this WorkProgress with the given synchronization point: once the synchronization point is unblocked, one of the done, error or cancel method is called.

linkTo

static void linkTo(WorkProgress progress,
                   Task<?,?> task)

Link this WorkProgress with the given task: once the task is done, one of the done, error or cancel method is called.

link

static void link(WorkProgress subTask,
                 WorkProgress progress,
                 long work)

Once the given sub-task is done, the given amount of work is added to the progress.