org.jmock.lib.concurrent
Class DeterministicScheduler

java.lang.Object
  org.jmock.lib.concurrent.DeterministicScheduler

All Implemented Interfaces:

java.util.concurrent.Executor, java.util.concurrent.ExecutorService, java.util.concurrent.ScheduledExecutorService

public class DeterministicScheduler
extends java.lang.Object
implements java.util.concurrent.ScheduledExecutorService

A ScheduledExecutorService that executes commands on the thread that calls runNextPendingCommand, runUntilIdle or tick. Objects of this class can also be used as Executors or ExecutorServices if you just want to control background execution and don't need to schedule commands, but it may be simpler to use a DeterministicExecutor.

Author:

nat

Constructor Summary

DeterministicScheduler()

Method Summary

boolean	awaitTermination(long timeout, java.util.concurrent.TimeUnit unit)
void	execute(java.lang.Runnable command)
<T> java.util.List<java.util.concurrent.Future<T>>	invokeAll(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks)
<T> java.util.List<java.util.concurrent.Future<T>>	invokeAll(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks, long timeout, java.util.concurrent.TimeUnit unit)
<T> T	invokeAny(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks)
<T> T	invokeAny(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks, long timeout, java.util.concurrent.TimeUnit unit)
boolean	isIdle() Reports whether scheduler is "idle": has no commands pending immediate execution.
boolean	isShutdown()
boolean	isTerminated()
void	runNextPendingCommand() Runs the next command scheduled to be executed immediately.
void	runUntilIdle() Runs all commands scheduled to be executed immediately but does not tick time forward.
<V> java.util.concurrent.ScheduledFuture<V>	schedule(java.util.concurrent.Callable<V> callable, long delay, java.util.concurrent.TimeUnit unit)
java.util.concurrent.ScheduledFuture<?>	schedule(java.lang.Runnable command, long delay, java.util.concurrent.TimeUnit unit)
java.util.concurrent.ScheduledFuture<?>	scheduleAtFixedRate(java.lang.Runnable command, long initialDelay, long period, java.util.concurrent.TimeUnit unit)
java.util.concurrent.ScheduledFuture<?>	scheduleWithFixedDelay(java.lang.Runnable command, long initialDelay, long delay, java.util.concurrent.TimeUnit unit)
void	shutdown()
java.util.List<java.lang.Runnable>	shutdownNow()
<T> java.util.concurrent.Future<T>	submit(java.util.concurrent.Callable<T> callable)
java.util.concurrent.Future<?>	submit(java.lang.Runnable command)
<T> java.util.concurrent.Future<T>	submit(java.lang.Runnable command, T result)
void	tick(long duration, java.util.concurrent.TimeUnit timeUnit) Runs time forwards by a given duration, executing any commands scheduled for execution during that time period, and any background tasks spawned by the scheduled tasks.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeterministicScheduler

public DeterministicScheduler()

Method Detail

tick

public void tick(long duration,
                 java.util.concurrent.TimeUnit timeUnit)

Runs time forwards by a given duration, executing any commands scheduled for execution during that time period, and any background tasks spawned by the scheduled tasks. Therefore, when a call to tick returns, the executor will be idle.

Parameters:

duration -

timeUnit -

runUntilIdle

public void runUntilIdle()

Runs all commands scheduled to be executed immediately but does not tick time forward.

runNextPendingCommand

public void runNextPendingCommand()

Runs the next command scheduled to be executed immediately.

isIdle

public boolean isIdle()

Reports whether scheduler is "idle": has no commands pending immediate execution.

Returns:

true if there are no commands pending immediate execution, false if there are commands pending immediate execution.

execute

public void execute(java.lang.Runnable command)

Specified by:

execute in interface java.util.concurrent.Executor

schedule

public java.util.concurrent.ScheduledFuture<?> schedule(java.lang.Runnable command,
                                                        long delay,
                                                        java.util.concurrent.TimeUnit unit)

Specified by:

schedule in interface java.util.concurrent.ScheduledExecutorService

schedule

public <V> java.util.concurrent.ScheduledFuture<V> schedule(java.util.concurrent.Callable<V> callable,
                                                            long delay,
                                                            java.util.concurrent.TimeUnit unit)

Specified by:

schedule in interface java.util.concurrent.ScheduledExecutorService

scheduleAtFixedRate

public java.util.concurrent.ScheduledFuture<?> scheduleAtFixedRate(java.lang.Runnable command,
                                                                   long initialDelay,
                                                                   long period,
                                                                   java.util.concurrent.TimeUnit unit)

Specified by:

scheduleAtFixedRate in interface java.util.concurrent.ScheduledExecutorService

scheduleWithFixedDelay

public java.util.concurrent.ScheduledFuture<?> scheduleWithFixedDelay(java.lang.Runnable command,
                                                                      long initialDelay,
                                                                      long delay,
                                                                      java.util.concurrent.TimeUnit unit)

Specified by:

scheduleWithFixedDelay in interface java.util.concurrent.ScheduledExecutorService

awaitTermination

public boolean awaitTermination(long timeout,
                                java.util.concurrent.TimeUnit unit)
                         throws java.lang.InterruptedException

Specified by:

awaitTermination in interface java.util.concurrent.ExecutorService

Throws:

java.lang.InterruptedException

invokeAll

public <T> java.util.List<java.util.concurrent.Future<T>> invokeAll(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks)
                                                         throws java.lang.InterruptedException

Specified by:

invokeAll in interface java.util.concurrent.ExecutorService

Throws:

java.lang.InterruptedException

invokeAll

public <T> java.util.List<java.util.concurrent.Future<T>> invokeAll(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks,
                                                                    long timeout,
                                                                    java.util.concurrent.TimeUnit unit)
                                                         throws java.lang.InterruptedException

Specified by:

invokeAll in interface java.util.concurrent.ExecutorService

Throws:

java.lang.InterruptedException

invokeAny

public <T> T invokeAny(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks)
            throws java.lang.InterruptedException,
                   java.util.concurrent.ExecutionException

Specified by:

invokeAny in interface java.util.concurrent.ExecutorService

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

invokeAny

public <T> T invokeAny(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks,
                       long timeout,
                       java.util.concurrent.TimeUnit unit)
            throws java.lang.InterruptedException,
                   java.util.concurrent.ExecutionException,
                   java.util.concurrent.TimeoutException

Specified by:

invokeAny in interface java.util.concurrent.ExecutorService

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface java.util.concurrent.ExecutorService

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface java.util.concurrent.ExecutorService

shutdown

public void shutdown()

Specified by:

shutdown in interface java.util.concurrent.ExecutorService

shutdownNow

public java.util.List<java.lang.Runnable> shutdownNow()

Specified by:

shutdownNow in interface java.util.concurrent.ExecutorService

submit

public <T> java.util.concurrent.Future<T> submit(java.util.concurrent.Callable<T> callable)

Specified by:

submit in interface java.util.concurrent.ExecutorService

submit

public java.util.concurrent.Future<?> submit(java.lang.Runnable command)

Specified by:

submit in interface java.util.concurrent.ExecutorService

submit

public <T> java.util.concurrent.Future<T> submit(java.lang.Runnable command,
                                                 T result)

Specified by:

submit in interface java.util.concurrent.ExecutorService