Interface SynchronizerApi.Run.SleepInvoke

All Superinterfaces:
SynchronizerApi.Base.SleepInvoke, SynchronizerApi.Fluent, SynchronizerApi.Run.Invoke
All Known Subinterfaces:
SynchronizerApi.Run.WakeSleepInvoke
Enclosing interface:
SynchronizerApi.Run

public static interface SynchronizerApi.Run.SleepInvoke extends SynchronizerApi.Run.Invoke, SynchronizerApi.Base.SleepInvoke
  • Method Details

    • thenSleepUntil

      default SynchronizerApi.Run.Invoke thenSleepUntil(BooleanSupplier state)
      Description copied from interface: SynchronizerApi.Base.SleepInvoke
      Adds sleeping to the action chain.

      This action ensures the given condition is met before performing the next action. When this action begins, the supplier is called immediately.
      Supplier returns false:
      The chain sleeps until either another chain wakes it up. The supplier is then called again and if it still returns false, the chain resumes sleeping.
      Supplier returns true:
      The chain proceeds to perform the next action.
      Specified by:
      thenSleepUntil in interface SynchronizerApi.Base.SleepInvoke
      Parameters:
      state - the supplier that returns true if the action chain should finish, false otherwise.
    • thenSleepUntil

      SynchronizerApi.Run.Invoke thenSleepUntil(BooleanSupplier state, Duration checkInterval)
      Description copied from interface: SynchronizerApi.Base.SleepInvoke
      Adds sleeping to the action chain.

      This action ensures the given condition is met before performing the next action. When this action begins, the supplier is called immediately.
      Supplier returns false:
      The chain sleeps until either another chain wakes it up or the checkInterval has passed.

      In both cases, the supplier is then called again and if it still returns false, the chain resumes sleeping.
      Supplier returns true:
      The chain proceeds to perform the next action.
      Specified by:
      thenSleepUntil in interface SynchronizerApi.Base.SleepInvoke
      Parameters:
      state - the supplier that returns true if the action chain should finish, false otherwise.
      checkInterval - how often the condition should be re-checked even if no wake call happens, or null for "never".