griffon.plugins.tasks

Interface Task<V,C>

All Known Implementing Classes:

AbstractTask

public interface Task<V,C>

A long-running task.

The contract is this of UIThreadWorker with the difference that in case of an execution exception the failed(Throwable) method is invoked and done(Object) is not.

Since:

19.07.11 22:13

Author:

Eike Kettner

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Task.Mode
static class	Task.State

Method Summary

Modifier and Type	Method and Description
void	done(V value) This method is invoked once execute(Tracker) has successfully finished and is called on the UI thread.
V	execute(Tracker<C> tracker) This method implements the long-running work and returns a result.
void	failed(Throwable cause) This method is invoked if execute(Tracker) threw an exception.
String	getId() A id that identifies this task (or a group of tasks).
Task.Mode	getMode()
void	process(List<C> chunks) Calls going to Tracker.publish(Object[]) from within execute(Tracker) are routed to this method.

Method Detail

getId

String getId()

A id that identifies this task (or a group of tasks). This doesn't have to be unique among all tasks. It's used to register TaskListener on this id that will receive events solely for tasks with a certain id.

Returns:

execute

V execute(Tracker<C> tracker)
   throws Exception

This method implements the long-running work and returns a result. This method is invoked on a worker thread.

Parameters:

tracker - to publish intermediate results

Returns:

Throws:

Exception

done

void done(V value)

This method is invoked once execute(Tracker) has successfully finished and is called on the UI thread.

Parameters:

value -

failed

void failed(Throwable cause)

This method is invoked if execute(Tracker) threw an exception. This method is executed on the UI thread.

Parameters:

cause -

process

void process(List<C> chunks)

Calls going to Tracker.publish(Object[]) from within execute(Tracker) are routed to this method. This method is invoked on the UI thread.

Parameters:

chunks -

getMode

Task.Mode getMode()