Module dev.mccue.guava.concurrent

Package dev.mccue.guava.concurrent

Class AbstractScheduledService.Scheduler

java.lang.Object

dev.mccue.guava.concurrent.AbstractScheduledService.Scheduler

Direct Known Subclasses:

AbstractScheduledService.CustomScheduler

Enclosing class:

AbstractScheduledService

public abstract static class AbstractScheduledService.Scheduler
extends Object

A scheduler defines the policy for how the AbstractScheduledService should run its task.

Consider using the #newFixedDelaySchedule and #newFixedRateSchedule factory methods, these provide Scheduler instances for the common use case of running the service with a fixed schedule. If more flexibility is needed then consider subclassing CustomScheduler.

Since:

11.0

Author:

Luke Sandberg

Method Summary

Modifier and Type	Method	Description
static AbstractScheduledService.Scheduler	newFixedDelaySchedule(long initialDelay, long delay, TimeUnit unit)	Returns a Scheduler that schedules the task using the ScheduledExecutorService#scheduleWithFixedDelay method.
static AbstractScheduledService.Scheduler	newFixedDelaySchedule(Duration initialDelay, Duration delay)	Returns a Scheduler that schedules the task using the ScheduledExecutorService#scheduleWithFixedDelay method.
static AbstractScheduledService.Scheduler	newFixedRateSchedule(long initialDelay, long period, TimeUnit unit)	Returns a Scheduler that schedules the task using the ScheduledExecutorService#scheduleAtFixedRate method.
static AbstractScheduledService.Scheduler	newFixedRateSchedule(Duration initialDelay, Duration period)	Returns a Scheduler that schedules the task using the ScheduledExecutorService#scheduleAtFixedRate method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

newFixedDelaySchedule

public static AbstractScheduledService.Scheduler newFixedDelaySchedule(Duration initialDelay,
 Duration delay)

Returns a Scheduler that schedules the task using the ScheduledExecutorService#scheduleWithFixedDelay method.

Parameters:

initialDelay - the time to delay first execution

delay - the delay between the termination of one execution and the commencement of the next

Since:

28.0

newFixedDelaySchedule

public static AbstractScheduledService.Scheduler newFixedDelaySchedule(long initialDelay,
 long delay,
 TimeUnit unit)

Returns a Scheduler that schedules the task using the ScheduledExecutorService#scheduleWithFixedDelay method.

Parameters:

initialDelay - the time to delay first execution

delay - the delay between the termination of one execution and the commencement of the next

unit - the time unit of the initialDelay and delay parameters

newFixedRateSchedule

public static AbstractScheduledService.Scheduler newFixedRateSchedule(Duration initialDelay,
 Duration period)

Returns a Scheduler that schedules the task using the ScheduledExecutorService#scheduleAtFixedRate method.

Parameters:

initialDelay - the time to delay first execution

period - the period between successive executions of the task

Since:

28.0

newFixedRateSchedule

public static AbstractScheduledService.Scheduler newFixedRateSchedule(long initialDelay,
 long period,
 TimeUnit unit)

Returns a Scheduler that schedules the task using the ScheduledExecutorService#scheduleAtFixedRate method.

Parameters:

initialDelay - the time to delay first execution

period - the period between successive executions of the task

unit - the time unit of the initialDelay and period parameters