speiger.src.collections.chars.utils

Class CharAsyncBuilder.BaseCharTask

java.lang.Object

speiger.src.collections.chars.utils.CharAsyncBuilder.BaseCharTask

All Implemented Interfaces:

java.lang.Runnable, java.util.concurrent.Future<java.lang.Character>, java.util.concurrent.RunnableFuture<java.lang.Character>, CharTask

Enclosing class:

CharAsyncBuilder

public abstract static class CharAsyncBuilder.BaseCharTask
extends java.lang.Object
implements CharTask

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

Constructor Summary

Constructors

Constructor and Description
BaseCharTask()

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)
char	getChar() A Type Specific get method that allows to reduce (un)boxing of primtives.
char	getChar(long timeout, java.util.concurrent.TimeUnit unit) Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.
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

Methods inherited from interface speiger.src.collections.chars.functions.CharTask

get, get

Constructor Detail

BaseCharTask

public BaseCharTask()

Method Detail

run

public void run()

Specified by:

run in interface java.lang.Runnable

Specified by:

run in interface java.util.concurrent.RunnableFuture<java.lang.Character>

cancel

public boolean cancel(boolean cancelIfRunnning)

Specified by:

cancel in interface java.util.concurrent.Future<java.lang.Character>

getChar

public char getChar()
             throws java.lang.InterruptedException,
                    java.util.concurrent.ExecutionException

Description copied from interface: CharTask

A Type Specific get method that allows to reduce (un)boxing of primtives. Waits if necessary for the computation to complete, and then retrieves its result.

Specified by:

getChar in interface CharTask

Returns:

the computed result as primitive

Throws:

java.lang.InterruptedException - if the current thread was interrupted while waiting

java.util.concurrent.ExecutionException - if the computation threw an exception

getChar

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

Description copied from interface: CharTask

Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.

Specified by:

getChar in interface CharTask

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

the computed result as primitive

Throws:

java.lang.InterruptedException - if the current thread was interrupted while waiting

java.util.concurrent.ExecutionException - if the computation threw an exception

java.util.concurrent.TimeoutException - if the wait timed out

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface java.util.concurrent.Future<java.lang.Character>

isDone

public boolean isDone()

Specified by:

isDone in interface java.util.concurrent.Future<java.lang.Character>

isPaused

public boolean isPaused()

Description copied from interface: CharTask

Helper function to detect if the task is currently paused.

Specified by:

isPaused in interface CharTask

Returns:

true if paused

isSuccessful

public boolean isSuccessful()

Description copied from interface: CharTask

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 CharTask

Returns:

true if it was properly completed

pause

public void pause()

Description copied from interface: CharTask

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 CharTask

awaitPausing

public void awaitPausing()

Description copied from interface: CharTask

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 CharTask

resume

public void resume()

Description copied from interface: CharTask

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 CharTask