Package org.apache.flink.core.testutils

Class ManuallyTriggeredScheduledExecutorService

java.lang.Object

org.apache.flink.core.testutils.ManuallyTriggeredScheduledExecutorService

All Implemented Interfaces:

Executor, ExecutorService, ScheduledExecutorService

public class ManuallyTriggeredScheduledExecutorService
extends Object
implements ScheduledExecutorService

Simple ScheduledExecutorService implementation for testing purposes. It spawns no threads, but lets you trigger the execution of tasks manually.

This class is helpful when implementing tests tasks synchronous and control when they run, which would otherwise asynchronous and require complex triggers and latches to test.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ManuallyTriggeredScheduledExecutorService.RunnableCaller<T>	A Callable that wraps a Runnable.

Constructor Summary

Constructors

Constructor	Description
ManuallyTriggeredScheduledExecutorService()

Method Summary

Modifier and Type	Method	Description
boolean	awaitTermination(long timeout, TimeUnit unit)
void	execute(Runnable command)
Collection<ScheduledFuture<?>>	getActiveNonPeriodicScheduledTask()
Collection<ScheduledFuture<?>>	getActivePeriodicScheduledTask()
Collection<ScheduledFuture<?>>	getActiveScheduledTasks()
List<ScheduledFuture<?>>	getAllNonPeriodicScheduledTask()
List<ScheduledFuture<?>>	getAllPeriodicScheduledTask()
List<ScheduledFuture<?>>	getAllScheduledTasks()
<T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> tasks)
<T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)
<T> T	invokeAny(Collection<? extends Callable<T>> tasks)
<T> T	invokeAny(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)
boolean	isShutdown()
boolean	isTerminated()
int	numQueuedRunnables()	Gets the number of Runnables currently queued.
ScheduledFuture<?>	schedule(Runnable command, long delay, TimeUnit unit)
<V> ScheduledFuture<V>	schedule(Callable<V> callable, long delay, TimeUnit unit)
ScheduledFuture<?>	scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit)
ScheduledFuture<?>	scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit)
void	shutdown()
List<Runnable>	shutdownNow()
Future<?>	submit(Runnable task)
<T> Future<T>	submit(Runnable task, T result)
<T> Future<T>	submit(Callable<T> task)
void	trigger()	Triggers the next task that was submitted for execution.
void	trigger(Duration timeout)	Triggers the next task that was submitted for execution.
void	triggerAll()	Triggers all queuedRunnables.
void	triggerAllNonPeriodicTasks()	Executes all runnable and scheduled non-periodic tasks until none are left to run.
void	triggerNonPeriodicScheduledTask()	Triggers a single non-periodically scheduled task.
void	triggerNonPeriodicScheduledTasks()
void	triggerNonPeriodicScheduledTasks(Class<?> taskClazz)
void	triggerNonPeriodicScheduledTasksWithRecursion()	Triggers all non-periodically scheduled tasks.
void	triggerPeriodicScheduledTasks()
void	triggerScheduledTasks()	Triggers all registered tasks.

Methods inherited from class java.lang.Object

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

Constructor Detail

ManuallyTriggeredScheduledExecutorService

public ManuallyTriggeredScheduledExecutorService()

Method Detail

execute

public void execute(@Nonnull
                    Runnable command)

Specified by:

execute in interface Executor

schedule

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

Specified by:

schedule in interface ScheduledExecutorService

schedule

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

Specified by:

schedule in interface ScheduledExecutorService

scheduleAtFixedRate

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

Specified by:

scheduleAtFixedRate in interface ScheduledExecutorService

scheduleWithFixedDelay

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

Specified by:

scheduleWithFixedDelay in interface ScheduledExecutorService

shutdown

public void shutdown()

Specified by:

shutdown in interface ExecutorService

shutdownNow

public List<Runnable> shutdownNow()

Specified by:

shutdownNow in interface ExecutorService

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface ExecutorService

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface ExecutorService

awaitTermination

public boolean awaitTermination(long timeout,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface ExecutorService

Throws:

InterruptedException

submit

public <T> Future<T> submit(Callable<T> task)

Specified by:

submit in interface ExecutorService

submit

public <T> Future<T> submit(Runnable task,
                            T result)

Specified by:

submit in interface ExecutorService

submit

public Future<?> submit(Runnable task)

Specified by:

submit in interface ExecutorService

invokeAll

public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks)

Specified by:

invokeAll in interface ExecutorService

invokeAll

public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks,
                                     long timeout,
                                     TimeUnit unit)

Specified by:

invokeAll in interface ExecutorService

invokeAny

public <T> T invokeAny(Collection<? extends Callable<T>> tasks)

Specified by:

invokeAny in interface ExecutorService

invokeAny

public <T> T invokeAny(Collection<? extends Callable<T>> tasks,
                       long timeout,
                       TimeUnit unit)

Specified by:

invokeAny in interface ExecutorService

triggerAllNonPeriodicTasks

public void triggerAllNonPeriodicTasks()

Executes all runnable and scheduled non-periodic tasks until none are left to run. This is essentially a combination of triggerAll() and triggerNonPeriodicScheduledTasks() that allows making a test agnostic of how exactly a runnable is passed to the executor.

triggerAll

public void triggerAll()

Triggers all queuedRunnables.

trigger

public void trigger(Duration timeout)

Triggers the next task that was submitted for execution. The method blocks the given amount of time if no task is scheduled, yet.

Parameters:

timeout - The time to wait for a new task to be scheduled.

Throws:

IllegalStateException - if no task was scheduled in the given amount of time.

trigger

public void trigger()

Triggers the next task that was submitted for execution.

Throws:

IllegalStateException - if no task was scheduled before calling this method.

numQueuedRunnables

public int numQueuedRunnables()

Gets the number of Runnables currently queued.

getActiveScheduledTasks

public Collection<ScheduledFuture<?>> getActiveScheduledTasks()

getActivePeriodicScheduledTask

public Collection<ScheduledFuture<?>> getActivePeriodicScheduledTask()

getActiveNonPeriodicScheduledTask

public Collection<ScheduledFuture<?>> getActiveNonPeriodicScheduledTask()

getAllScheduledTasks

public List<ScheduledFuture<?>> getAllScheduledTasks()

getAllPeriodicScheduledTask

public List<ScheduledFuture<?>> getAllPeriodicScheduledTask()

getAllNonPeriodicScheduledTask

public List<ScheduledFuture<?>> getAllNonPeriodicScheduledTask()

triggerScheduledTasks

public void triggerScheduledTasks()

Triggers all registered tasks.

triggerNonPeriodicScheduledTask

public void triggerNonPeriodicScheduledTask()

Triggers a single non-periodically scheduled task.

Throws:

NoSuchElementException - If there is no such task.

triggerNonPeriodicScheduledTasksWithRecursion

public void triggerNonPeriodicScheduledTasksWithRecursion()

Triggers all non-periodically scheduled tasks. In contrast to triggerNonPeriodicScheduledTasks(), if such a task schedules another non-periodically schedule task, then this new task will also be triggered.

triggerNonPeriodicScheduledTasks

public void triggerNonPeriodicScheduledTasks()

triggerNonPeriodicScheduledTasks

public void triggerNonPeriodicScheduledTasks(Class<?> taskClazz)

triggerPeriodicScheduledTasks

public void triggerPeriodicScheduledTasks()