jhelp.util.thread

Class ThreadedTask<PARAMETER,RESULT,PROGRESS>

java.lang.Object

jhelp.util.thread.ThreadedTask<PARAMETER,RESULT,PROGRESS>

Type Parameters:

PARAMETER - Parameter type

RESULT - Result type

PROGRESS - Progression type

Direct Known Subclasses:

PostProgress, PreferencesSerializer, ThreadedSimpleTask

public abstract class ThreadedTask<PARAMETER,RESULT,PROGRESS>
extends java.lang.Object

Task do in separate thread
Extends this class to have a good thread manager with ThreadManager.
Its better to use this mechanism than create a new Thread instance and haven't issue noticed in "Scheduled mechanism" to know more see ThreadManager.
This class is the complete version, it have a parameter, a result and a progress information.

Parameter	It is given when this task turn arrive (One time or by repetition)	It allows to have only one instance that react to different parameters in different threads
Result	It is is computed by the implementation of the derived class.	When the result is computed this class is alerted.
Progress	During the computing, you can signal a progression to for example update a progress bar	The progression information is up to implementation and it signal in separate thread, so when received the progression information it is not the exact progression. We have do this choice to not slow down the computation by showing progression

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
private PostProgress<PROGRESS>	postProgress For post a progression

Constructor Summary

Constructors

Constructor and Description
ThreadedTask() Create a new instance of ThreadedTask

Method Summary

Methods

Modifier and Type	Method and Description
protected void	cancel() Request to cancel the task
protected void	canceled() It is call when a cancel is requested.
protected void	doProgress(PROGRESS progress) It is call when a progression information arrive.
protected abstract RESULT	doThreadAction(PARAMETER parameter) Call when the turn of this thread comes.
protected void	postProgress(PROGRESS progress) Call this method to post a progression during the computing
protected void	setResult(RESULT result) Call when task is finish.

Methods inherited from class java.lang.Object

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

Field Detail

postProgress

private PostProgress<PROGRESS> postProgress

For post a progression

Constructor Detail

ThreadedTask

public ThreadedTask()

Create a new instance of ThreadedTask

Method Detail

cancel

protected final void cancel()

Request to cancel the task

canceled

protected void canceled()

It is call when a cancel is requested.
Override it to do something on cancel, do nothing by default

doProgress

protected void doProgress(PROGRESS progress)

It is call when a progression information arrive.
Override it to do something on progression, do nothing by default

Parameters:

progress - Progression information

doThreadAction

protected abstract RESULT doThreadAction(PARAMETER parameter)

Call when the turn of this thread comes.
It does the action and compute the result

Parameters:

parameter - Parameter to use

Returns:

The computed result

postProgress

protected final void postProgress(PROGRESS progress)

Call this method to post a progression during the computing

Parameters:

progress - Progression information to post

setResult

protected void setResult(RESULT result)

Call when task is finish.
Override this method to do something when computing is finish, do nothing by default

Parameters:

result - Computed result