Package org.openhab.core.scheduler

Interface Scheduler

@NonNullByDefault
public interface Scheduler

A Scheduler service provides timed semantics to CompletableFutures. A Scheduler can delay a CompletableFutures, it can resolve a CompletableFutures at a certain time, or it can provide a timeout to a CompletableFutures.

This scheduler has a millisecond resolution.

Author:

Peter Kriens - Initial contribution, Simon Kaufmann - adapted to CompletableFutures, Hilbrand Bouwkamp - Initial contribution

Method Summary

Modifier and Type	Method	Description
ScheduledCompletableFuture<Instant>	after(Duration delay)	Return a ScheduledCompletableFuture that will resolve after the given duration.
<T> ScheduledCompletableFuture<T>	after(Callable<T> callable, Duration delay)	Return a ScheduledCompletableFuture that resolves after delaying with the result of the call that is executed after the delay.
ScheduledCompletableFuture<Instant>	at(Instant instant)	Return a ScheduledCompletableFuture that resolves at the given epochTime
<T> ScheduledCompletableFuture<T>	at(Callable<T> callable, Instant instant)	Return a ScheduledCompletableFuture that resolves at the given epochTime with the result of the call.
default ScheduledCompletableFuture<@Nullable Void>	at(SchedulerRunnable runnable, Instant instant)	Return a ScheduledCompletableFuture that resolves at the given epochTime and runs the runnable.
<T> ScheduledCompletableFuture<T>	before(CompletableFuture<T> promise, Duration timeout)	Return a ScheduledCompletableFuture that fails with a TimeoutException when the given CompletableFuture is not resolved before the given timeout.
<T> ScheduledCompletableFuture<T>	schedule(SchedulerRunnable callable, @Nullable String identifier, TemporalAdjuster temporalAdjuster)	Schedules the callable once or repeating using the temporalAdjuster to determine the time the callable should run.
<T> ScheduledCompletableFuture<T>	schedule(SchedulerRunnable callable, TemporalAdjuster temporalAdjuster)	Schedules the callable once or repeating using the temporalAdjuster to determine the time the callable should run.

Method Details

after

<T> ScheduledCompletableFuture<T> after(Callable<T> callable,
 Duration delay)

Return a ScheduledCompletableFuture that resolves after delaying with the result of the call that is executed after the delay.

Parameters:

callable - Provides the result

delay - The duration to wait

Returns:

A ScheduledCompletableFuture

at

ScheduledCompletableFuture<Instant> at(Instant instant)

Return a ScheduledCompletableFuture that resolves at the given epochTime

Parameters:

instant - The epoch time

Returns:

A ScheduledCompletableFuture

at

<T> ScheduledCompletableFuture<T> at(Callable<T> callable,
 Instant instant)

Return a ScheduledCompletableFuture that resolves at the given epochTime with the result of the call.

Parameters:

callable - Provides the result

instant - The epoch time

Returns:

A ScheduledCompletableFuture

at

default ScheduledCompletableFuture<@Nullable Void> at(SchedulerRunnable runnable,
 Instant instant)

Return a ScheduledCompletableFuture that resolves at the given epochTime and runs the runnable.

Parameters:

runnable - Runs at the given epochTime

instant - The epoch time

Returns:

A ScheduledCompletableFuture

before

<T> ScheduledCompletableFuture<T> before(CompletableFuture<T> promise,
 Duration timeout)

Return a ScheduledCompletableFuture that fails with a TimeoutException when the given CompletableFuture is not resolved before the given timeout. If the given CompletableFuture fails or is resolved before the timeout then the returned ScheduledCompletableFuture will be treated accordingly. The cancellation does not influence the final result of the given CompletableFuture since a CompletableFuture can only be failed or resolved by its creator.

If the timeout is in the past then the CompletableFuture will be resolved immediately

Parameters:

promise - The CompletableFuture to base the returned ScheduledCompletableFuture on

timeout - The number of milliseconds to wait.

Returns:

A ScheduledCompletableFuture

after

ScheduledCompletableFuture<Instant> after(Duration delay)

Return a ScheduledCompletableFuture that will resolve after the given duration. This ScheduledCompletableFuture can be cancelled.

Parameters:

delay - The delay to wait

Returns:

A ScheduledCompletableFuture

schedule

<T> ScheduledCompletableFuture<T> schedule(SchedulerRunnable callable,
 TemporalAdjuster temporalAdjuster)

Schedules the callable once or repeating using the temporalAdjuster to determine the time the callable should run. Runs until the job is cancelled or if the temporalAdjuster method SchedulerTemporalAdjuster.isDone(java.time.temporal.Temporal) returns true.

Parameters:

callable - Provides the result

temporalAdjuster - the temperalAdjuster to return the time the callable should run

Returns:

A ScheduledCompletableFuture

schedule

<T> ScheduledCompletableFuture<T> schedule(SchedulerRunnable callable,
 @Nullable String identifier,
 TemporalAdjuster temporalAdjuster)

Schedules the callable once or repeating using the temporalAdjuster to determine the time the callable should run. Runs until the job is cancelled or if the temporalAdjuster method SchedulerTemporalAdjuster.isDone(java.time.temporal.Temporal) returns true.

Parameters:

callable - Provides the result

identifier - an optional identifier for this job

temporalAdjuster - the temperalAdjuster to return the time the callable should run

Returns:

A ScheduledCompletableFuture