Modul speiger.src.collections
Package speiger.src.collections.shorts.utils

Klasse ShortAsyncBuilder.BaseShortTask

java.lang.Object
speiger.src.collections.shorts.utils.ShortAsyncBuilder.BaseShortTask
Alle implementierten Schnittstellen:
Runnable, Future<Short>, RunnableFuture<Short>, ShortTask
Umschließende Klasse:
ShortAsyncBuilder
public abstract static class ShortAsyncBuilder.BaseShortTask extends Object implements ShortTask
Base Task of the Actions that can be performed. Allows to simplify the actions that get executed.

  • Verschachtelte Klassen - Übersicht

    Von Schnittstelle geerbte verschachtelte Klassen/Schnittstellen java.util.concurrent.Future

    Future.State

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    BaseShortTask()
     

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    void
    awaitPausing()
    Pauses the task, which lets the thread finish without completing the task.
    boolean
    cancel(boolean cancelIfRunnning)
     
    short
    getShort()
    A Type Specific get method that allows to reduce (un)boxing of primtives.
    short
    getShort(long timeout, 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()
     

    Von Klasse geerbte Methoden java.lang.Object

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

    Von Schnittstelle geerbte Methoden java.util.concurrent.Future

    exceptionNow, resultNow, state

    Von Schnittstelle geerbte Methoden speiger.src.collections.shorts.functions.ShortTask

    get, get

  • Konstruktordetails

    • BaseShortTask

      public BaseShortTask()

  • Methodendetails

    • run

      public void run()
      Angegeben von:
      run in Schnittstelle Runnable
      Angegeben von:
      run in Schnittstelle RunnableFuture<Short>

    • cancel

      public boolean cancel(boolean cancelIfRunnning)
      Angegeben von:
      cancel in Schnittstelle Future<Short>

    • getShort

      public short getShort() throws InterruptedException, ExecutionException
      Beschreibung aus Schnittstelle kopiert: ShortTask
      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.
      Angegeben von:
      getShort in Schnittstelle ShortTask
      Gibt zurück:
      the computed result as primitive
      Löst aus:
      InterruptedException - if the current thread was interrupted while waiting
      ExecutionException - if the computation threw an exception

    • getShort

      public short getShort(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException
      Beschreibung aus Schnittstelle kopiert: ShortTask
      Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.
      Angegeben von:
      getShort in Schnittstelle ShortTask
      Parameter:
      timeout - the maximum time to wait
      unit - the time unit of the timeout argument
      Gibt zurück:
      the computed result as primitive
      Löst aus:
      InterruptedException - if the current thread was interrupted while waiting
      ExecutionException - if the computation threw an exception
      TimeoutException - if the wait timed out

    • isCancelled

      public boolean isCancelled()
      Angegeben von:
      isCancelled in Schnittstelle Future<Short>

    • isDone

      public boolean isDone()
      Angegeben von:
      isDone in Schnittstelle Future<Short>

    • isPaused

      public boolean isPaused()
      Beschreibung aus Schnittstelle kopiert: ShortTask
      Helper function to detect if the task is currently paused.
      Angegeben von:
      isPaused in Schnittstelle ShortTask
      Gibt zurück:
      true if paused

    • isSuccessful

      public boolean isSuccessful()
      Beschreibung aus Schnittstelle kopiert: ShortTask
      Quality of life function that allows to detect if no cancellation/exception was applied to this task and it completed on its own.
      Angegeben von:
      isSuccessful in Schnittstelle ShortTask
      Gibt zurück:
      true if it was properly completed

    • pause

      public void pause()
      Beschreibung aus Schnittstelle kopiert: ShortTask
      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.
      Angegeben von:
      pause in Schnittstelle ShortTask

    • awaitPausing

      public void awaitPausing()
      Beschreibung aus Schnittstelle kopiert: ShortTask
      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.
      Angegeben von:
      awaitPausing in Schnittstelle ShortTask

    • resume

      public void resume()
      Beschreibung aus Schnittstelle kopiert: ShortTask
      Continues the task if it wasn't already completed. This is done by resubmitting the task to the executor provided.
      Angegeben von:
      resume in Schnittstelle ShortTask