speiger.src.collections.objects.utils

Class ObjectAsyncBuilder.BaseObjectTask<T>

java.lang.Object

speiger.src.collections.objects.utils.ObjectAsyncBuilder.BaseObjectTask<T>

Type Parameters:

T - the type of elements maintained by this Collection

All Implemented Interfaces:

java.lang.Runnable, java.util.concurrent.Future<T>, java.util.concurrent.RunnableFuture<T>, ObjectTask<T>

Enclosing class:

ObjectAsyncBuilder<T>

public abstract static class ObjectAsyncBuilder.BaseObjectTask<T>
extends java.lang.Object
implements ObjectTask<T>

Base Task of the Actions that can be performed. Allows to simplify the actions that get executed.

Constructor Summary

Constructors

Constructor and Description
BaseObjectTask()

Method Summary

Modifier and Type	Method and Description
void	awaitPausing() Pauses the task, which lets the thread finish without completing the task.
boolean	cancel(boolean cancelIfRunnning)
T	get()
T	get(long timeout, java.util.concurrent.TimeUnit unit)
boolean	isCancelled()
boolean	isDone()
boolean	isPaused() Helper function to detect if the task is currently paused.
boolean	isSuccessful() Quality of life function that allows to detect if no cancellation/exception was applied to this task and it completed on its own.
void	pause() Pauses the task, which lets the thread finish without completing the task.
void	resume() Continues the task if it wasn't already completed.
void	run()

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseObjectTask

public BaseObjectTask()

Method Detail

run

public void run()

Specified by:

run in interface java.lang.Runnable

Specified by:

run in interface java.util.concurrent.RunnableFuture<T>

cancel

public boolean cancel(boolean cancelIfRunnning)

Specified by:

cancel in interface java.util.concurrent.Future<T>

get

public T get()
      throws java.lang.InterruptedException,
             java.util.concurrent.ExecutionException

Specified by:

get in interface java.util.concurrent.Future<T>

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

get

public T get(long timeout,
             java.util.concurrent.TimeUnit unit)
      throws java.lang.InterruptedException,
             java.util.concurrent.ExecutionException,
             java.util.concurrent.TimeoutException

Specified by:

get in interface java.util.concurrent.Future<T>

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface java.util.concurrent.Future<T>

isDone

public boolean isDone()

Specified by:

isDone in interface java.util.concurrent.Future<T>

isPaused

public boolean isPaused()

Description copied from interface: ObjectTask

Helper function to detect if the task is currently paused.

Specified by:

isPaused in interface ObjectTask<T>

Returns:

true if paused

isSuccessful

public boolean isSuccessful()

Description copied from interface: ObjectTask

Quality of life function that allows to detect if no cancellation/exception was applied to this task and it completed on its own.

Specified by:

isSuccessful in interface ObjectTask<T>

Returns:

true if it was properly completed

pause

public void pause()

Description copied from interface: ObjectTask

Pauses the task, which lets the thread finish without completing the task. Tasks are written in the way where they can pause without any issues. This won't be instant, as this function is applied asynchronous and doesn't check if the thread paused. So make sure it had the time to pause.

Specified by:

pause in interface ObjectTask<T>

awaitPausing

public void awaitPausing()

Description copied from interface: ObjectTask

Pauses the task, which lets the thread finish without completing the task. Tasks are written in the way where they can pause without any issues. This won't be instant, as this function is applied asynchronous. It will await the pausing of the task.

Specified by:

awaitPausing in interface ObjectTask<T>

resume

public void resume()

Description copied from interface: ObjectTask

Continues the task if it wasn't already completed. This is done by resubmitting the task to the executor provided.

Specified by:

resume in interface ObjectTask<T>