Package ch.nolix.coreapi.programcontrolapi.futureapi

Schnittstelle IFuture

Alle Superschnittstellen:
FinishRequestable
Alle bekannten Unterschnittstellen:
IImageGenerator, IResultFuture<R>
Alle bekannten Implementierungsklassen:
AbstractFuture, Future, ImageGenerator, ResultFuture
public interface IFuture extends FinishRequestable
A IFuture is supposed to be given back when a job is started in background. A IFuture can always be asked if the background job has finished or thrown an error.
Version:
2019-04-14
Autor:
Silvan Wyss

  • Methodendetails

    • caughtError

      boolean caughtError()
      Gibt zurück:
      true if the current IFuture caught an error.

    • getError

      Throwable getError()
      Gibt zurück:
      the error of the current IFuture.

    • isFinishedSuccessfully

      boolean isFinishedSuccessfully()
      Gibt zurück:
      true if the current IFuture is finished successfully.

    • isFinishedWithError

      boolean isFinishedWithError()
      Gibt zurück:
      true if the current IFuture is finished with an error.

    • waitUntilIsFinished

      void waitUntilIsFinished()
      Lets the current IFuture wait until it is finished.

    • waitUntilIsFinished

      void waitUntilIsFinished(int timeoutInMilliseconds)
      Lets the current IFuture wait until it is finished within the given timeoutInMilliseconds.
      Parameter:
      timeoutInMilliseconds -

    • waitUntilIsFinishedSuccessfully

      void waitUntilIsFinishedSuccessfully()
      Lets the current IFuture wait until it is finished successfully.
      Löst aus:
      RuntimeException - if the current IFuture catches an error.

    • waitUntilIsFinishedSuccessfully

      void waitUntilIsFinishedSuccessfully(int timeoutInMilliseconds)
      Lets the current IFuture wait until it is finished successfully within the given timeoutInMilliseconds.
      Parameter:
      timeoutInMilliseconds -
      Löst aus:
      RuntimeException - if the current IFuture catches an error.
      RuntimeException - if the current IFuture reached the given timeoutInMilliseconds before having finished.