Package com.google.common.util.concurrent

Interface ListeningScheduledExecutorService

All Superinterfaces:

Executor, ExecutorService, ListeningExecutorService, ScheduledExecutorService

@GwtIncompatible
public interface ListeningScheduledExecutorService
extends ScheduledExecutorService, ListeningExecutorService

A ScheduledExecutorService that returns ListenableFuture instances from its ExecutorService methods. To create an instance from an existing ScheduledExecutorService, call MoreExecutors.listeningDecorator(ScheduledExecutorService).

Since:

10.0

Author:

Chris Povirk

Method Summary

Modifier and Type	Method	Description
ListenableScheduledFuture<?>	schedule(Runnable command, long delay, TimeUnit unit)	Submits a one-shot task that becomes enabled after the given delay.
default ListenableScheduledFuture<?>	schedule(Runnable command, Duration delay)	Duration-based overload of schedule(Runnable, long, TimeUnit).
<V extends @Nullable Object> ListenableScheduledFuture<V>	schedule(Callable<V> callable, long delay, TimeUnit unit)	Submits a value-returning one-shot task that becomes enabled after the given delay.
default <V extends @Nullable Object> ListenableScheduledFuture<V>	schedule(Callable<V> callable, Duration delay)	Duration-based overload of schedule(Callable, long, TimeUnit).
ListenableScheduledFuture<?>	scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit)	Submits a periodic action that becomes enabled first after the given initial delay, and subsequently with the given period; that is, executions will commence after initialDelay, then initialDelay + period, then initialDelay + 2 * period, and so on.
default ListenableScheduledFuture<?>	scheduleAtFixedRate(Runnable command, Duration initialDelay, Duration period)	Duration-based overload of scheduleAtFixedRate(Runnable, long, long, TimeUnit).
ListenableScheduledFuture<?>	scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit)	Submits a periodic action that becomes enabled first after the given initial delay, and subsequently with the given delay between the termination of one execution and the commencement of the next.
default ListenableScheduledFuture<?>	scheduleWithFixedDelay(Runnable command, Duration initialDelay, Duration delay)	Duration-based overload of scheduleWithFixedDelay(Runnable, long, long, TimeUnit).

Methods inherited from interface java.util.concurrent.Executor

execute

Methods inherited from interface java.util.concurrent.ExecutorService

awaitTermination, invokeAny, invokeAny, isShutdown, isTerminated, shutdown, shutdownNow

Methods inherited from interface com.google.common.util.concurrent.ListeningExecutorService

invokeAll, invokeAll, submit, submit, submit

Method Detail

schedule

ListenableScheduledFuture<?> schedule(Runnable command,
                                      long delay,
                                      TimeUnit unit)

Description copied from interface: java.util.concurrent.ScheduledExecutorService

Submits a one-shot task that becomes enabled after the given delay.

Specified by:

schedule in interface ScheduledExecutorService

Parameters:

command - the task to execute

delay - the time from now to delay execution

unit - the time unit of the delay parameter

Returns:

a ScheduledFuture representing pending completion of the task and whose get() method will return null upon completion

Since:

15.0 (previously returned ScheduledFuture)

schedule

default ListenableScheduledFuture<?> schedule(Runnable command,
                                              Duration delay)

Duration-based overload of schedule(Runnable, long, TimeUnit).

Since:

29.0

schedule

<V extends @Nullable Object> ListenableScheduledFuture<V> schedule(Callable<V> callable,
                                                                   long delay,
                                                                   TimeUnit unit)

Description copied from interface: java.util.concurrent.ScheduledExecutorService

Submits a value-returning one-shot task that becomes enabled after the given delay.

Specified by:

schedule in interface ScheduledExecutorService

Type Parameters:

V - the type of the callable's result

Parameters:

callable - the function to execute

delay - the time from now to delay execution

unit - the time unit of the delay parameter

Returns:

a ScheduledFuture that can be used to extract result or cancel

Since:

15.0 (previously returned ScheduledFuture)

schedule

default <V extends @Nullable Object> ListenableScheduledFuture<V> schedule(Callable<V> callable,
                                                                           Duration delay)

Duration-based overload of schedule(Callable, long, TimeUnit).

Since:

29.0

scheduleAtFixedRate

ListenableScheduledFuture<?> scheduleAtFixedRate(Runnable command,
                                                 long initialDelay,
                                                 long period,
                                                 TimeUnit unit)

Description copied from interface: java.util.concurrent.ScheduledExecutorService

Submits a periodic action that becomes enabled first after the given initial delay, and subsequently with the given period; that is, executions will commence after initialDelay, then initialDelay + period, then initialDelay + 2 * period, and so on.

The sequence of task executions continues indefinitely until one of the following exceptional completions occur:

• The task is explicitly cancelled via the returned future.
• The executor terminates, also resulting in task cancellation.
• An execution of the task throws an exception. In this case calling get on the returned future will throw ExecutionException, holding the exception as its cause.

Subsequent executions are suppressed. Subsequent calls to isDone() on the returned future will return true.

If any execution of this task takes longer than its period, then subsequent executions may start late, but will not concurrently execute.

Specified by:

scheduleAtFixedRate in interface ScheduledExecutorService

Parameters:

command - the task to execute

initialDelay - the time to delay first execution

period - the period between successive executions

unit - the time unit of the initialDelay and period parameters

Returns:

a ScheduledFuture representing pending completion of the series of repeated tasks. The future's get() method will never return normally, and will throw an exception upon task cancellation or abnormal termination of a task execution.

Since:

15.0 (previously returned ScheduledFuture)

scheduleAtFixedRate

default ListenableScheduledFuture<?> scheduleAtFixedRate(Runnable command,
                                                         Duration initialDelay,
                                                         Duration period)

Duration-based overload of scheduleAtFixedRate(Runnable, long, long, TimeUnit).

Since:

29.0

scheduleWithFixedDelay

ListenableScheduledFuture<?> scheduleWithFixedDelay(Runnable command,
                                                    long initialDelay,
                                                    long delay,
                                                    TimeUnit unit)

Description copied from interface: java.util.concurrent.ScheduledExecutorService

Submits a periodic action that becomes enabled first after the given initial delay, and subsequently with the given delay between the termination of one execution and the commencement of the next.

The sequence of task executions continues indefinitely until one of the following exceptional completions occur:

• The task is explicitly cancelled via the returned future.
• The executor terminates, also resulting in task cancellation.
• An execution of the task throws an exception. In this case calling get on the returned future will throw ExecutionException, holding the exception as its cause.

Subsequent executions are suppressed. Subsequent calls to isDone() on the returned future will return true.

Specified by:

scheduleWithFixedDelay in interface ScheduledExecutorService

Parameters:

command - the task to execute

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

Returns:

a ScheduledFuture representing pending completion of the series of repeated tasks. The future's get() method will never return normally, and will throw an exception upon task cancellation or abnormal termination of a task execution.

Since:

15.0 (previously returned ScheduledFuture)

scheduleWithFixedDelay

default ListenableScheduledFuture<?> scheduleWithFixedDelay(Runnable command,
                                                            Duration initialDelay,
                                                            Duration delay)

Duration-based overload of scheduleWithFixedDelay(Runnable, long, long, TimeUnit).

Since:

29.0