speiger.src.collections.chars.functions

Interface CharTask

All Superinterfaces:

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

All Known Implementing Classes:

CharAsyncBuilder.BaseCharTask

public interface CharTask
extends java.util.concurrent.RunnableFuture<java.lang.Character>

A Type Specific Task interface that allows you to keep track of the task that is currently running.
It extends Runnable future and supports said functions but also provides quality of life functions like:
- isSuccesfull: which allows to detect if the task was completed properly and not interrupted or crashed. - pause/resume: which allows to pause/resume the task at any moment, making it easier to create thread-safe actions.

Method Summary

Modifier and Type	Method and Description
void	awaitPausing() Pauses the task, which lets the thread finish without completing the task.
default java.lang.Character	get() Deprecated.
default java.lang.Character	get(long timeout, java.util.concurrent.TimeUnit unit) Deprecated.
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	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.

Methods inherited from interface java.util.concurrent.RunnableFuture

run

Methods inherited from interface java.util.concurrent.Future

cancel, isCancelled, isDone

Method Detail

isPaused

boolean isPaused()

Helper function to detect if the task is currently paused.

Returns:

true if paused

pause

void pause()

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.

awaitPausing

void awaitPausing()

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.

resume

void resume()

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

isSuccessful

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.

Returns:

true if it was properly completed

getChar

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

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.

Returns:

the computed result as primitive

Throws:

java.util.concurrent.CancellationException - if the computation was cancelled

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

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

getChar

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

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

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

the computed result as primitive

Throws:

java.util.concurrent.CancellationException - if the computation was cancelled

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

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

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

get

@Deprecated
default java.lang.Character get()
                                      throws java.lang.InterruptedException,
                                             java.util.concurrent.ExecutionException

Deprecated.

Specified by:

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

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

get

@Deprecated
default java.lang.Character get(long timeout,
                                             java.util.concurrent.TimeUnit unit)
                                      throws java.lang.InterruptedException,
                                             java.util.concurrent.ExecutionException,
                                             java.util.concurrent.TimeoutException

Deprecated.

Specified by:

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

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException