Package ch.nolix.core.programcontrol.flowcontrol

Klasse FlowController

java.lang.Object
ch.nolix.core.programcontrol.flowcontrol.FlowController
public final class FlowController extends Object
The FlowController provides methods for flow control. Of the FlowController an instance cannot be created.
Version:
2016-06-01
Autor:
Silvan Wyss

  • Methodendetails

    • asLongAs

      public static IAsLongAsMediator asLongAs(BooleanSupplier condition)
      Parameter:
      condition -
      Gibt zurück:
      a new AsLongAsMediator with the given condition.
      Löst aus:
      ArgumentIsNullException - if the given condition is null.

    • asSoonAs

      public static IAsSoonAsMediator asSoonAs(BooleanSupplier condition)
      Parameter:
      condition -
      Gibt zurück:
      a new AsSoonAsMediator with the given condition.
      Löst aus:
      ArgumentIsNullException - if the given condition is null.

    • asSoonAsNoMore

      public static IAsSoonAsMediator asSoonAsNoMore(BooleanSupplier condition)
      Parameter:
      condition -
      Gibt zurück:
      a new AsSoonAsMediator with the negation of the given condition.
      Löst aus:
      ArgumentIsNullException - if the given condition is null.

    • enqueue

      public static IFuture enqueue(Runnable job)
      Enqueues the given job.
      Parameter:
      job -
      Gibt zurück:
      a IFuture for the given job.
      Löst aus:
      ArgumentIsNullException - if the given job is null.

    • forCount

      public static ForCountMediator forCount(int maxRunCount)
      Parameter:
      maxRunCount -
      Gibt zurück:
      a new ForCountMediator with the given max run count.
      Löst aus:
      NegativeArgumentException - if the given max run count is negative.

    • forMaxMilliseconds

      public static ForMaxMillisecondsMediator forMaxMilliseconds(int maxDurationInMilliseconds)
      Parameter:
      maxDurationInMilliseconds -
      Gibt zurück:
      a new ForMaxMillisecondsMediator for the given maxDurationInMilliseconds.
      Löst aus:
      NegativeArgumentException - if the given maxDurationInMilliseconds is negative.

    • forMaxSeconds

      public static ForMaxMillisecondsMediator forMaxSeconds(int maxDurationInSeconds)
      Parameter:
      maxDurationInSeconds -
      Gibt zurück:
      a new ForMaxMillisecondsMediator for the given maxDurationInSeconds.
      Löst aus:
      NegativeArgumentException - if the given maxDurationInSeconds is negative.

    • runInBackground

      public static Future runInBackground(Runnable job)
      Runs the given job in background.
      Parameter:
      job -
      Gibt zurück:
      a new Future.
      Löst aus:
      ArgumentIsNullException - if the given job is null.

    • runInBackgroundAndOrder

      public static IFuture runInBackgroundAndOrder(Runnable job, Runnable... jobs)
      Runs the given jobs in background in the given order.
      Parameter:
      job -
      jobs -
      Gibt zurück:
      a new IFuture for the running of the given jobs.

    • runInBackground

      public static <R> ResultFuture<R> runInBackground(Supplier<R> resultJob)
      Runs the given result job in background. A result job is a job that returns a result.
      Typparameter:
      R - is the type of the result the given resultJob returns.
      Parameter:
      resultJob -
      Gibt zurück:
      a new ResultFuture.
      Löst aus:
      ArgumentIsNullException - if the given result job is null.

    • runInEnclosedMode

      public static void runInEnclosedMode(Runnable job)
      Runs the given job in an enclosed mode. Prints out the stack trace of any occurring error. An error will occur it the given job is null or if the given job will not run properly.
      Parameter:
      job -

    • runInEnclosedModeAndGetSuccessFlag

      public static boolean runInEnclosedModeAndGetSuccessFlag(Runnable job)
      Runs the given job in an enclosed mode. Prints out the stack trace of any occurring error. An error will occur it the given job is null or if the given job will not run properly.
      Parameter:
      job -
      Gibt zurück:
      true if the given job run successfully, false otherwise.

    • until

      public static IAsLongAsMediator until(BooleanSupplier condition)
      Parameter:
      condition -
      Gibt zurück:
      a new AsLongAsMediator for the negation of the given condition.
      Löst aus:
      ArgumentIsNullException - if the given condition is null.

    • waitAsLongAs

      public static ActionMediator waitAsLongAs(BooleanSupplier condition)
      Waits as long as the given condition is fulfilled.
      Parameter:
      condition -
      Gibt zurück:
      a ActionMediator.
      Löst aus:
      ArgumentIsNullException - if the given condition is null.

    • waitForMilliseconds

      public static ActionMediator waitForMilliseconds(int durationInMilliseconds)
      Waits for the given durationInMilliseconds.
      Parameter:
      durationInMilliseconds -
      Gibt zurück:
      a ActionMediator.
      Löst aus:
      NegativeArgumentException - if the given durationInMilliseconds is negative.

    • waitForSeconds

      public static ActionMediator waitForSeconds(int durationInSeconds)
      Waits for the given durationInSeconds.
      Parameter:
      durationInSeconds -
      Gibt zurück:
      a ActionMediator.
      Löst aus:
      NegativeArgumentException - if the given durationInSeconds is negative.

    • waitUntil

      public static ActionMediator waitUntil(BooleanSupplier condition)
      Waits until the given condition is fulfilled.
      Parameter:
      condition -
      Gibt zurück:
      a ActionMediator.
      Löst aus:
      ArgumentIsNullException - if the given condition is null.