com.github.benmanes.caffeine.cache

Interface Scheduler

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Scheduler

A scheduler that submits a task to an executor after a given delay.

Method Summary

Modifier and Type	Method and Description
static @NonNull Scheduler	disabledScheduler() Returns a scheduler that always returns a successfully completed future.
static @NonNull Scheduler	forScheduledExecutorService(@NonNull ScheduledExecutorService scheduledExecutorService) Returns a scheduler that delegates to the a ScheduledExecutorService.
static @NonNull Scheduler	guardedScheduler(@NonNull Scheduler scheduler) Returns a scheduler that suppresses and logs any exception thrown by the delegate scheduler.
@NonNull Future<?>	schedule(@NonNull Executor executor, @NonNull Runnable command, @Positive long delay, @NonNull TimeUnit unit) Returns a future that will submit the task to the given executor after the given delay.
static @NonNull Scheduler	systemScheduler() Returns a scheduler that uses the system-wide scheduling thread if available, or else returns disabledScheduler() if not present.

Method Detail

schedule

@NonNull Future<?> schedule(@NonNull Executor executor,
                            @NonNull Runnable command,
                            @Positive long delay,
                            @NonNull TimeUnit unit)

Returns a future that will submit the task to the given executor after the given delay.

Parameters:

executor - the executor to run the task

command - the runnable task to schedule

delay - how long to delay, in units of unit

unit - a TimeUnit determining how to interpret the delay parameter

Returns:

a scheduled future representing pending submission of the task

disabledScheduler

static @NonNull Scheduler disabledScheduler()

Returns a scheduler that always returns a successfully completed future.

Returns:

a scheduler that always returns a successfully completed future

systemScheduler

static @NonNull Scheduler systemScheduler()

Returns a scheduler that uses the system-wide scheduling thread if available, or else returns disabledScheduler() if not present. This scheduler is provided in Java 9 or above by using CompletableFuture delayedExecutor.

Returns:

a scheduler that uses the system-wide scheduling thread if available, or else a disabled scheduler

forScheduledExecutorService

static @NonNull Scheduler forScheduledExecutorService(@NonNull ScheduledExecutorService scheduledExecutorService)

Returns a scheduler that delegates to the a ScheduledExecutorService.

Parameters:

scheduledExecutorService - the executor to schedule on

Returns:

a scheduler that delegates to the a ScheduledExecutorService

guardedScheduler

static @NonNull Scheduler guardedScheduler(@NonNull Scheduler scheduler)

Returns a scheduler that suppresses and logs any exception thrown by the delegate scheduler.

Parameters:

scheduler - the scheduler to delegate to

Returns:

an scheduler that suppresses and logs any exception thrown by the delegate