net.lecousin.framework.progress

Class MultiTaskProgress

java.lang.Object

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

net.lecousin.framework.progress.WorkProgressImpl

net.lecousin.framework.progress.MultiTaskProgress

All Implemented Interfaces:

SimpleListenable, WorkProgress, WorkProgress.MultiTask

public class MultiTaskProgress
extends WorkProgressImpl
implements WorkProgress.MultiTask

Implementation of WorkProgress, composed of sub-WorkProgress.

Nested Class Summary

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

WorkProgress.MultiTask.SubTask

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

WorkProgress.MultiTask

Field Summary

Fields

Modifier and Type	Field and Description
protected JoinPoint<Exception>	jp
protected ArrayList<WorkProgress.MultiTask.SubTask>	tasks

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
MultiTaskProgress(String text) Constructor.

Method Summary

Modifier and Type	Method and Description
WorkProgress.MultiTask.SubTask	addTask(WorkProgress task, long amount) Add the given sub-progress as a sub-task for the given amount of work (this amount is added to the total amount to be done).
WorkProgress	createTaskProgress(long amount, String text) Create a sub-progress for the given amount of work (this amount is added to the total amount to be done).
void	doneOnSubTasksDone() Automatically call the done or error method of this WorkProgress once all current sub-tasks are done.
List<? extends WorkProgress.MultiTask.SubTask>	getTasks() Return the sub-WorkProgress.
void	removeTask(WorkProgress.MultiTask.SubTask subTask) Remove a sub-task, but the amount of the parent remains unchanged.

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

cancel, changed, createEvent, done, error, getAmount, getPosition, getRemainingWork, getSubText, getSynch, getText, interruptEvents, progress, resumeEvents, setAmount, setPosition, 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

Field Detail

tasks

protected ArrayList<WorkProgress.MultiTask.SubTask> tasks

jp

protected JoinPoint<Exception> jp

Constructor Detail

MultiTaskProgress

public MultiTaskProgress(String text)

Constructor.

Method Detail

createTaskProgress

public WorkProgress createTaskProgress(long amount,
                                       String text)

Create a sub-progress for the given amount of work (this amount is added to the total amount to be done).

addTask

public WorkProgress.MultiTask.SubTask addTask(WorkProgress task,
                                              long amount)

Description copied from interface: WorkProgress.MultiTask

Add the given sub-progress as a sub-task for the given amount of work (this amount is added to the total amount to be done).

Specified by:

addTask in interface WorkProgress.MultiTask

removeTask

public void removeTask(WorkProgress.MultiTask.SubTask subTask)

Description copied from interface: WorkProgress.MultiTask

Remove a sub-task, but the amount of the parent remains unchanged.

Specified by:

removeTask in interface WorkProgress.MultiTask

getTasks

public List<? extends WorkProgress.MultiTask.SubTask> getTasks()

Description copied from interface: WorkProgress.MultiTask

Return the sub-WorkProgress.

Specified by:

getTasks in interface WorkProgress.MultiTask

doneOnSubTasksDone

public void doneOnSubTasksDone()

Automatically call the done or error method of this WorkProgress once all current sub-tasks are done.