com.google.common.util.concurrent

Interface ListeningScheduledExecutorService

All Superinterfaces:

Executor, ExecutorService, ListeningExecutorService, ScheduledExecutorService

@Beta
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

Methods

Modifier and Type	Method and Description
<V> ListenableScheduledFuture<V>	schedule(Callable<V> callable, long delay, TimeUnit unit) Creates and executes a ScheduledFuture that becomes enabled after the given delay.
ListenableScheduledFuture<?>	schedule(Runnable command, long delay, TimeUnit unit) Creates and executes a one-shot action that becomes enabled after the given delay.
ListenableScheduledFuture<?>	scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit) Creates and executes 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.
ListenableScheduledFuture<?>	scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit) Creates and executes 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.

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

invokeAll, invokeAll, submit, submit, submit

Methods inherited from interface java.util.concurrent.ExecutorService

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

Methods inherited from interface java.util.concurrent.Executor

execute

Method Detail

schedule

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

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

Creates and executes a one-shot action 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

<V> ListenableScheduledFuture<V> schedule(Callable<V> callable,
                                        long delay,
                                        TimeUnit unit)

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

Creates and executes a ScheduledFuture that becomes enabled after the given delay.

Specified by:

schedule in interface ScheduledExecutorService

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)

scheduleAtFixedRate

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

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

Creates and executes 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. If any execution of the task encounters an exception, subsequent executions are suppressed. Otherwise, the task will only terminate via cancellation or termination of the executor. 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 task, and whose get() method will throw an exception upon cancellation

Since:

15.0 (previously returned ScheduledFuture)

scheduleWithFixedDelay

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

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

Creates and executes 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. If any execution of the task encounters an exception, subsequent executions are suppressed. Otherwise, the task will only terminate via cancellation or termination of the executor.

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 task, and whose get() method will throw an exception upon cancellation

Since:

15.0 (previously returned ScheduledFuture)