net.lecousin.framework.concurrent

Class Task<T,TError extends Exception>

java.lang.Object

net.lecousin.framework.concurrent.Task<T,TError>

Type Parameters:

T - type of result

TError - type of error

Direct Known Subclasses:

DriveOperationsSequence, Task.Cpu, Task.Done, Task.OnFile, Task.Parameter, Task.Unmanaged

public abstract class Task<T,TError extends Exception>
extends Object

Task to be executed asynchronously.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Task.Cpu<T,TError extends Exception> Task using only CPU resource.
static class	Task.Done<T,TError extends Exception> Task already done with a result or an error.
static class	Task.OnFile<T,TError extends Exception> Task using a only a file resource.
class	Task.Output Synchronization point holding the result or error of this task.
static class	Task.Parameter<TParam,TResult,TError extends Exception> Task holding a parameter.
static class	Task.Unmanaged<TResult,TError extends Exception> Unmanaged task that may use any resource and block at any time without using a synchronization point.

Field Summary

Fields

Modifier and Type	Field and Description
static byte	NB_PRIORITES
static byte	PRIORITY_BACKGROUND
static byte	PRIORITY_IMPORTANT
static byte	PRIORITY_LOW
static byte	PRIORITY_NORMAL
static byte	PRIORITY_RATHER_IMPORTANT
static byte	PRIORITY_RATHER_LOW
static byte	PRIORITY_TOP
static byte	PRIORITY_URGENT
static byte	STATUS_BLOCKED started but blocked (waiting for something).
static byte	STATUS_DONE done.
static byte	STATUS_EXECUTED executed, but some sub-tasks are not yet done.
static byte	STATUS_NOT_STARTED not yet started.
static byte	STATUS_RUNNING started and still running.
static byte	STATUS_STARTED_READY started and put in the ready list of the task manager.
static byte	STATUS_STARTED_WAITING started but waiting for a specific time.
protected JoinPoint<TError>	taskJoin

Constructor Summary

Constructors

Constructor and Description
Task(Object resource, String description, byte priority) Constructor.
Task(Object resource, String description, byte priority, Consumer<Pair<T,TError>> ondone) Constructor.
Task(TaskManager manager, String description, byte priority) Constructor.
Task(TaskManager manager, String description, byte priority, Consumer<Pair<T,TError>> ondone) Constructor.

Method Summary

Modifier and Type	Method and Description
void	cancel(CancelException reason) Cancel this task.
boolean	cancelIfExecutionNotStarted(CancelException reason) Cancel this task only if not yet started.
void	changeNextExecutionTime(long time) Change the next execution time of scheduled or repetitive task.
Task<T,TError>	ensureUnblocked(IAsync<?>... sp) Ensure that when this task will be done, successfully or not, the given synchronization point are unblocked.
Task<T,TError>	executeAgainAt(long time) Execute again this task at the given time.
Task<T,TError>	executeAgainIn(long delay) Execute again this task in the given delay.
Task<T,TError>	executeAt(long time) Execute this task at the given time.
Task<T,TError>	executeEvery(long delay, long initialDelay) Execute this task repeatedly.
Task<T,TError>	executeIn(long delay) Execute this task in the given delay in milliseconds.
void	executeNextOccurenceNow() Change the next execution time to now.
void	executeNextOccurenceNow(byte priority) Change the next execution time to now with the given priority.
Application	getApplication()
CancelException	getCancelEvent()
String	getDescription()
TError	getError()
long	getMaxBlockingTimeInNanoBeforeToLog()
Task.Output	getOutput()
byte	getPriority()
T	getResult()
byte	getStatus()
TaskManager	getTaskManager()
boolean	hasError()
boolean	isCancelled()
boolean	isCancelling()
boolean	isDone()
boolean	isRunning()
boolean	isStarted()
boolean	isSuccessful()
void	ondone(Task<?,?> todo, boolean evenIfErrorOrCancel) Start the given task once this task is done.
abstract T	run() Method to implement to execute the task.
protected void	setDescription(String descr)
void	setDone(T result, TError error) Set this task as done with the given result or error.
void	setError(TError error) Set this task's error (MUST NOT be started).
void	setPriority(byte priority) Change the priority of this task.
Task<T,TError>	start() Ask to start the task.
void	startOn(boolean evenOnErrorOrCancel, IAsync<?>... list) Start this task once all the given synchronization points are unblocked.
void	startOn(IAsync<? extends Exception> sp, boolean evenOnErrorOrCancel) Start this task once the given synchronization point is unblocked.
void	startOnDone(Task<?,?> task) Start this task once the given task is done.
void	stopRepeat() Do not execute this task again.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PRIORITY_TOP

public static final byte PRIORITY_TOP

See Also:

Constant Field Values

PRIORITY_URGENT

public static final byte PRIORITY_URGENT

See Also:

Constant Field Values

PRIORITY_IMPORTANT

public static final byte PRIORITY_IMPORTANT

See Also:

Constant Field Values

PRIORITY_RATHER_IMPORTANT

public static final byte PRIORITY_RATHER_IMPORTANT

See Also:

Constant Field Values

PRIORITY_NORMAL

public static final byte PRIORITY_NORMAL

See Also:

Constant Field Values

PRIORITY_RATHER_LOW

public static final byte PRIORITY_RATHER_LOW

See Also:

Constant Field Values

PRIORITY_LOW

public static final byte PRIORITY_LOW

See Also:

Constant Field Values

PRIORITY_BACKGROUND

public static final byte PRIORITY_BACKGROUND

See Also:

Constant Field Values

NB_PRIORITES

public static final byte NB_PRIORITES

See Also:

Constant Field Values

STATUS_NOT_STARTED

public static final byte STATUS_NOT_STARTED

not yet started.

See Also:

Constant Field Values

STATUS_STARTED_WAITING

public static final byte STATUS_STARTED_WAITING

started but waiting for a specific time.

See Also:

Constant Field Values

STATUS_STARTED_READY

public static final byte STATUS_STARTED_READY

started and put in the ready list of the task manager.

See Also:

Constant Field Values

STATUS_RUNNING

public static final byte STATUS_RUNNING

started and still running.

See Also:

Constant Field Values

STATUS_BLOCKED

public static final byte STATUS_BLOCKED

started but blocked (waiting for something).

See Also:

Constant Field Values

STATUS_EXECUTED

public static final byte STATUS_EXECUTED

executed, but some sub-tasks are not yet done.

See Also:

Constant Field Values

STATUS_DONE

public static final byte STATUS_DONE

done.

See Also:

Constant Field Values

taskJoin

protected JoinPoint<TError extends Exception> taskJoin

Constructor Detail

Task

public Task(TaskManager manager,
            String description,
            byte priority)

Constructor.

Task

public Task(TaskManager manager,
            String description,
            byte priority,
            Consumer<Pair<T,TError>> ondone)

Constructor.

Task

public Task(Object resource,
            String description,
            byte priority,
            Consumer<Pair<T,TError>> ondone)

Constructor.

Task

public Task(Object resource,
            String description,
            byte priority)

Constructor.

Method Detail

getStatus

public final byte getStatus()

getDescription

public final String getDescription()

setDescription

protected final void setDescription(String descr)

getApplication

public final Application getApplication()

getTaskManager

public final TaskManager getTaskManager()

run

public abstract T run()
               throws TError extends Exception,
                      CancelException

Method to implement to execute the task.

Throws:

TError extends Exception

CancelException

start

public final Task<T,TError> start()

Ask to start the task. This does not start it immediately, but adds it to the queue of tasks to execute.

cancel

public final void cancel(CancelException reason)

Cancel this task.

cancelIfExecutionNotStarted

public final boolean cancelIfExecutionNotStarted(CancelException reason)

Cancel this task only if not yet started.

setError

public final void setError(TError error)

Set this task's error (MUST NOT be started).

isDone

public final boolean isDone()

isSuccessful

public final boolean isSuccessful()

isCancelling

public final boolean isCancelling()

isCancelled

public final boolean isCancelled()

isStarted

public final boolean isStarted()

isRunning

public final boolean isRunning()

getResult

public final T getResult()

getError

public final TError getError()

getCancelEvent

public final CancelException getCancelEvent()

hasError

public final boolean hasError()

getPriority

public final byte getPriority()

setPriority

public final void setPriority(byte priority)

Change the priority of this task.

getOutput

public final Task.Output getOutput()

ensureUnblocked

public final Task<T,TError> ensureUnblocked(IAsync<?>... sp)

Ensure that when this task will be done, successfully or not, the given synchronization point are unblocked. If some are not, they are cancelled upon task completion.

executeAt

public final Task<T,TError> executeAt(long time)

Execute this task at the given time.

executeIn

public final Task<T,TError> executeIn(long delay)

Execute this task in the given delay in milliseconds.

executeEvery

public final Task<T,TError> executeEvery(long delay,
                                         long initialDelay)

Execute this task repeatedly.

stopRepeat

public final void stopRepeat()

Do not execute this task again.

executeAgainIn

public final Task<T,TError> executeAgainIn(long delay)

Execute again this task in the given delay.

executeAgainAt

public final Task<T,TError> executeAgainAt(long time)

Execute again this task at the given time.

changeNextExecutionTime

public final void changeNextExecutionTime(long time)

Change the next execution time of scheduled or repetitive task.

executeNextOccurenceNow

public final void executeNextOccurenceNow()

Change the next execution time to now.

executeNextOccurenceNow

public final void executeNextOccurenceNow(byte priority)

Change the next execution time to now with the given priority.

startOn

public final void startOn(IAsync<? extends Exception> sp,
                          boolean evenOnErrorOrCancel)

Start this task once the given synchronization point is unblocked.

startOn

public final void startOn(boolean evenOnErrorOrCancel,
                          IAsync<?>... list)

Start this task once all the given synchronization points are unblocked.

startOnDone

public final void startOnDone(Task<?,?> task)

Start this task once the given task is done. If the given task is null or already done, the method start() is called.

setDone

public final void setDone(T result,
                          TError error)

Set this task as done with the given result or error.

ondone

public final void ondone(Task<?,?> todo,
                         boolean evenIfErrorOrCancel)

Start the given task once this task is done.

getMaxBlockingTimeInNanoBeforeToLog

public long getMaxBlockingTimeInNanoBeforeToLog()

toString

public final String toString()

Overrides:

toString in class Object