io.jarasandha.util.concurrent

Class CancellableTask<T>

java.lang.Object

io.jarasandha.util.concurrent.CancellableTask<T>

All Implemented Interfaces:

Runnable

public class CancellableTask<T>
extends Object
implements Runnable

Utility class to help implement Runnables that have state to be cleared at the end of their execution. This is simpler than CompletableFuture and the cancel() method is useful when the task has to be cancelled - even when it has not been scheduled.

If the ExecutorService.submit(Runnable) fails then the task can simply be cancelled and resources can be cleaned up.

Also see cancel().

The end could be due to:

- Success

- Failure - if the task has been cancelled or the task executed but encountered an error.

Created by ashwin.jayaprakash.

Constructor Summary

Constructors

Constructor and Description
CancellableTask(Callable<T> mainTask, Consumer<T> onSuccessTask, Consumer<Throwable> onFailureTask)

Method Summary

Modifier and Type	Method and Description
void	cancel() Guarantees that:
void	run()

Methods inherited from class java.lang.Object

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

Constructor Detail

CancellableTask

public CancellableTask(Callable<T> mainTask,
                       Consumer<T> onSuccessTask,
                       Consumer<Throwable> onFailureTask)

Method Detail

run

public void run()

Specified by:

run in interface Runnable

Throws:

IllegalStateException - If the task was already done or cancelled before.

cancel

public void cancel()

Guarantees that:

- The failure task is called with CancellationException if the task was never started.

- Or, cancels an already running task by interrupting that thread but not when it is running the failure/success task. Like FutureTask this call does not wait for the main thread to complete and return, but merely interrupts it and returns.