net.lecousin.framework.progress

Class WorkProgressImpl

java.lang.Object

net.lecousin.framework.event.SimpleListenableContainer<AsyncEvent>

net.lecousin.framework.progress.WorkProgressImpl

All Implemented Interfaces:

SimpleListenable, WorkProgress

Direct Known Subclasses:

MultiTaskProgress, SubWorkProgress

public class WorkProgressImpl
extends SimpleListenableContainer<AsyncEvent>
implements WorkProgress

Default implementation of a WorkProgress.

Nested Class Summary

Nested classes/interfaces inherited from interface net.lecousin.framework.progress.WorkProgress

WorkProgress.MultiTask

Field Summary

Fields

Modifier and Type	Field and Description
protected long	amount
protected boolean	eventsInterrupted
protected long	position
protected String	subText
protected Async<Exception>	synch
protected String	text

Fields inherited from class net.lecousin.framework.event.SimpleListenableContainer

event

Constructor Summary

Constructors

Constructor and Description
WorkProgressImpl(long amount) Constructor.
WorkProgressImpl(long amount, String text) Constructor.
WorkProgressImpl(long amount, String text, String subText) Constructor.

Method Summary

Modifier and Type	Method and Description
void	cancel(CancelException reason) Cancel the underlying work.
protected void	changed()
protected AsyncEvent	createEvent()
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.
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 class net.lecousin.framework.event.SimpleListenableContainer

addListener, hasListeners, removeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.lecousin.framework.progress.WorkProgress

link, linkTo, linkTo

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

addListener, hasListeners, listen, removeListener, unlisten

Field Detail

amount

protected long amount

position

protected long position

text

protected String text

subText

protected String subText

synch

protected Async<Exception> synch

eventsInterrupted

protected boolean eventsInterrupted

Constructor Detail

WorkProgressImpl

public WorkProgressImpl(long amount,
                        String text,
                        String subText)

Constructor.

WorkProgressImpl

public WorkProgressImpl(long amount,
                        String text)

Constructor.

WorkProgressImpl

public WorkProgressImpl(long amount)

Constructor.

Method Detail

createEvent

protected AsyncEvent createEvent()

Specified by:

createEvent in class SimpleListenableContainer<AsyncEvent>

setAmount

public void setAmount(long work)

Description copied from interface: WorkProgress

Set the total amount of work to be done.

Specified by:

setAmount in interface WorkProgress

getAmount

public long getAmount()

Description copied from interface: WorkProgress

Return the total amount of work to be done.

Specified by:

getAmount in interface WorkProgress

setPosition

public void setPosition(long position)

Description copied from interface: WorkProgress

Set the position (amount of work already done).

Specified by:

setPosition in interface WorkProgress

getPosition

public long getPosition()

Description copied from interface: WorkProgress

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

Specified by:

getPosition in interface WorkProgress

progress

public void progress(long amountDone)

Description copied from interface: WorkProgress

Add an amount of work already done.

Specified by:

progress in interface WorkProgress

done

public void done()

Description copied from interface: WorkProgress

Signal all the work has been done.

Specified by:

done in interface WorkProgress

error

public void error(Exception error)

Description copied from interface: WorkProgress

Signal an error.

Specified by:

error in interface WorkProgress

cancel

public void cancel(CancelException reason)

Description copied from interface: WorkProgress

Cancel the underlying work.

Specified by:

cancel in interface WorkProgress

getSynch

public IAsync<Exception> getSynch()

Description copied from interface: WorkProgress

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

Specified by:

getSynch in interface WorkProgress

getRemainingWork

public long getRemainingWork()

Description copied from interface: WorkProgress

Return the amount of remaining work.

Specified by:

getRemainingWork in interface WorkProgress

getText

public String getText()

Description copied from interface: WorkProgress

Return the text describing the work being done.

Specified by:

getText in interface WorkProgress

setText

public void setText(String text)

Description copied from interface: WorkProgress

Set the text describing the work being done.

Specified by:

setText in interface WorkProgress

getSubText

public String getSubText()

Description copied from interface: WorkProgress

Return a sub-text describing the work being done.

Specified by:

getSubText in interface WorkProgress

setSubText

public void setSubText(String text)

Description copied from interface: WorkProgress

Set the sub-text describing the work being done.

Specified by:

setSubText in interface WorkProgress

interruptEvents

public void interruptEvents()

Description copied from interface: WorkProgress

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

Specified by:

interruptEvents in interface WorkProgress

resumeEvents

public void resumeEvents(boolean trigger)

Description copied from interface: WorkProgress

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

Specified by:

resumeEvents in interface WorkProgress

changed

protected void changed()