net.lecousin.framework.progress

Class SubWorkProgress

java.lang.Object

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

net.lecousin.framework.progress.WorkProgressImpl

net.lecousin.framework.progress.SubWorkProgress

All Implemented Interfaces:

SimpleListenable, WorkProgress, WorkProgress.MultiTask.SubTask

public class SubWorkProgress
extends WorkProgressImpl
implements WorkProgress.MultiTask.SubTask

Implementation of WorkProgress for a sub-aork, that will transmit its progression to its parent.

Nested Class Summary

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

WorkProgress.MultiTask.SubTask.Wrapper

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

WorkProgress.MultiTask

Field Summary

Fields inherited from class net.lecousin.framework.progress.WorkProgressImpl

amount, eventsInterrupted, position, subText, synch, text

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

event

Constructor Summary

Constructors

Constructor and Description
SubWorkProgress(WorkProgress parent, long parentWork, long amount) Constructor.
SubWorkProgress(WorkProgress parent, long parentWork, long amount, String text) Constructor.
SubWorkProgress(WorkProgress parent, long parentWork, long amount, String text, String subText) Constructor.

Method Summary

Modifier and Type	Method and Description
void	done() Signal all the work has been done.
WorkProgress	getProgress() Progress of this sub-task.
long	getWorkOnParent() Amount of work on the parent done by this sub-task.
void	progress(long amountDone) Add an amount of work already done.
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).

Methods inherited from class net.lecousin.framework.progress.WorkProgressImpl

cancel, changed, createEvent, error, getAmount, getPosition, getRemainingWork, getSubText, getSynch, getText, interruptEvents, resumeEvents, setSubText, setText

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

Constructor Detail

SubWorkProgress

public SubWorkProgress(WorkProgress parent,
                       long parentWork,
                       long amount,
                       String text,
                       String subText)

Constructor.

SubWorkProgress

public SubWorkProgress(WorkProgress parent,
                       long parentWork,
                       long amount,
                       String text)

Constructor.

SubWorkProgress

public SubWorkProgress(WorkProgress parent,
                       long parentWork,
                       long amount)

Constructor.

Method Detail

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

Overrides:

setAmount in class WorkProgressImpl

progress

public void progress(long amountDone)

Description copied from interface: WorkProgress

Add an amount of work already done.

Specified by:

progress in interface WorkProgress

Overrides:

progress in class WorkProgressImpl

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

Overrides:

setPosition in class WorkProgressImpl

done

public void done()

Description copied from interface: WorkProgress

Signal all the work has been done.

Specified by:

done in interface WorkProgress

Overrides:

done in class WorkProgressImpl

getWorkOnParent

public long getWorkOnParent()

Description copied from interface: WorkProgress.MultiTask.SubTask

Amount of work on the parent done by this sub-task.

Specified by:

getWorkOnParent in interface WorkProgress.MultiTask.SubTask

getProgress

public WorkProgress getProgress()

Description copied from interface: WorkProgress.MultiTask.SubTask

Progress of this sub-task.

Specified by:

getProgress in interface WorkProgress.MultiTask.SubTask