com.github.deinok.threading

Class Task<R>

java.lang.Object

com.github.deinok.threading.Task<R>

Type Parameters:

R - The Result Type

All Implemented Interfaces:

IDeferred<R>, IPromise<R>, ITask<R>

public class Task<R>
extends Object
implements ITask<R>

A Task in parallel

Constructor Summary

Constructors

Constructor and Description
Task(Callable<R> callable) Creates a new Task

Method Summary

Modifier and Type	Method and Description
Task<R>	await() Ensures that the result is ready to be returned
boolean	cancel() Cancel the Task
Task<R>	execute(ExecutionMode executionMode) Executes the Task in the selected mode
Task<R>	executeAsync() Executes the Task Asynchronous
Task<R>	executeSync() Executes the Task Synchronous
int	getPriority() Gets the priority of the Task
R	getResult() Gets the result of the Task
Task<R>	onException(OnException onException) Callback executed when the Task ends with an exception
Task<R>	onSuccess(OnSuccess<R> onSuccess) Callback executed when the Task result is ready
Task<R>	setPriority(int priority) Sets the priority

Methods inherited from class java.lang.Object

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

Constructor Detail

Task

public Task(@NotNull
            Callable<R> callable)

Creates a new Task

Parameters:

callable - The callable function

Method Detail

getPriority

public int getPriority()

Gets the priority of the Task

Specified by:

getPriority in interface ITask<R>

Returns:

The Priority

setPriority

@NotNull
public Task<R> setPriority(int priority)

Sets the priority

Specified by:

setPriority in interface ITask<R>

Parameters:

priority - The new Priority

Returns:

The Task

execute

public Task<R> execute(@NotNull
                       ExecutionMode executionMode)

Executes the Task in the selected mode

Specified by:

execute in interface ITask<R>

Parameters:

executionMode - The Execution Mode

Returns:

The Task

executeAsync

@NotNull
public Task<R> executeAsync()

Executes the Task Asynchronous

Specified by:

executeAsync in interface ITask<R>

Returns:

The Task

executeSync

@NotNull
public Task<R> executeSync()

Executes the Task Synchronous

Specified by:

executeSync in interface ITask<R>

Returns:

The Task

cancel

public boolean cancel()

Cancel the Task

Specified by:

cancel in interface ITask<R>

Returns:

Returns if it is canceled

await

@NotNull
public Task<R> await()
                        throws RuntimeThreadException

Ensures that the result is ready to be returned

Specified by:

await in interface ITask<R>

Returns:

The Awaited Task(Finished)

Throws:

RuntimeThreadException

getResult

@Nullable
public R getResult()
                       throws RuntimeThreadException

Gets the result of the Task

Specified by:

getResult in interface IDeferred<R>

Returns:

The Result

Throws:

RuntimeThreadException - The probable Exception throw by the Thread

onSuccess

@NotNull
public Task<R> onSuccess(@Nullable
                                   OnSuccess<R> onSuccess)

Callback executed when the Task result is ready

Specified by:

onSuccess in interface IPromise<R>

Parameters:

onSuccess - The Callback Interface

Returns:

The Task

onException

@NotNull
public Task<R> onException(@Nullable
                                     OnException onException)

Callback executed when the Task ends with an exception

Specified by:

onException in interface IPromise<R>

Parameters:

onException - The Callback Interface

Returns:

The Task