Interface SynchronizerApi.Base.SleepInvoke
-
- All Superinterfaces:
SynchronizerApi.Fluent
- All Known Subinterfaces:
SynchronizerApi.Base.WakeSleepInvoke
,SynchronizerApi.Get.SleepInvoke<T>
,SynchronizerApi.Get.WakeSleepInvoke<T>
,SynchronizerApi.Run.SleepInvoke
,SynchronizerApi.Run.WakeSleepInvoke
- Enclosing interface:
- SynchronizerApi.Base
public static interface SynchronizerApi.Base.SleepInvoke extends SynchronizerApi.Fluent
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default Object
thenSleepUntil(BooleanSupplier state)
Adds sleeping to the action chain.Object
thenSleepUntil(BooleanSupplier state, Duration checkInterval)
Adds sleeping to the action chain.
-
-
-
Method Detail
-
thenSleepUntil
default Object thenSleepUntil(BooleanSupplier state)
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.
- Parameters:
state
- the supplier that returnstrue
if the action chain should finish,false
otherwise.- Throws:
NullPointerException
- ifstate
is null
- Supplier returns
-
thenSleepUntil
Object thenSleepUntil(BooleanSupplier state, Duration checkInterval)
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 returnsfalse
, the chain resumes sleeping. - Supplier returns
true
: - The chain proceeds to perform the next action.
- Parameters:
state
- the supplier that returnstrue
if the action chain should finish,false
otherwise.checkInterval
- how often the condition should be re-checked even if no wake call happens, ornull
for "never".- Throws:
NullPointerException
- ifstate
is null
- Supplier returns
-
-