ai.eloquent.util

Class SafeTimerMock

java.lang.Object

ai.eloquent.util.SafeTimerMock

All Implemented Interfaces:

SafeTimer

public class SafeTimerMock
extends java.lang.Object
implements SafeTimer

This holds all of our timer tasks in a mocked environment, so that when we run unit tests we can guarantee that things are getting called.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SafeTimerMock.ScheduledTask This holds all our tasks for the timer mock

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<SafeTimerMock.ScheduledTask>	scheduled This is the list of all ScheduledTasks on this SafeTimerMock

Constructor Summary

Constructors

Constructor and Description
SafeTimerMock()

Method Summary

Modifier and Type	Method and Description
static void	advanceTime(long millis) This moves time forward in the mock timer, which will trigger any timers that need to be triggered in a synchronous manner on this thread.
void	cancel() Cancel this timer.
long	now() This retrieves the current time on this box.
int	numTasksScheduled() This returns the number of tasks we currently have scheduled on this SafeTimerMock.
static void	resetMockTime() This clears any previous timers we still had registered, and gets the system ready to restart
void	schedule(SafeTimerTask task, long delay)
void	schedule(SafeTimerTask task, long delay, long period)
void	scheduleAtFixedRate(SafeTimerTask task, long period) Schedule at a fixed rate with no delay.
void	scheduleAtFixedRate(SafeTimerTask task, long delay, long period)
static long	time() Get the current time on the timer mock.
void	waitForSilence() This blocks the calling thread until there are no outstanding tasks on this SafeTimerMock running, then continues.
void	withTimerLock(java.lang.Runnable runnable) This allows outside code to access the timer lock, in case they need to do things that can't allow time to slip

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.eloquent.util.SafeTimer

schedule, schedule, scheduleAtFixedRate, scheduleAtFixedRate

Field Detail

scheduled

public final java.util.List<SafeTimerMock.ScheduledTask> scheduled

This is the list of all ScheduledTasks on this SafeTimerMock

Constructor Detail

SafeTimerMock

public SafeTimerMock()

Method Detail

advanceTime

public static void advanceTime(long millis)

This moves time forward in the mock timer, which will trigger any timers that need to be triggered in a synchronous manner on this thread.

resetMockTime

public static void resetMockTime()

This clears any previous timers we still had registered, and gets the system ready to restart

numTasksScheduled

public int numTasksScheduled()

This returns the number of tasks we currently have scheduled on this SafeTimerMock.

waitForSilence

public void waitForSilence()

This blocks the calling thread until there are no outstanding tasks on this SafeTimerMock running, then continues. This will time out after 5 virtual "minutes" of waiting period.

time

public static long time()

Get the current time on the timer mock.

now

public long now()

This retrieves the current time on this box. This is only here so that it can be mocked.

Specified by:

now in interface SafeTimer

withTimerLock

public void withTimerLock(java.lang.Runnable runnable)

This allows outside code to access the timer lock, in case they need to do things that can't allow time to slip

schedule

public void schedule(SafeTimerTask task,
                     long delay)

Specified by:

schedule in interface SafeTimer

See Also:

Timer.schedule(TimerTask, long)

schedule

public void schedule(SafeTimerTask task,
                     long delay,
                     long period)

Specified by:

schedule in interface SafeTimer

See Also:

Timer.schedule(TimerTask, long, long)

scheduleAtFixedRate

public void scheduleAtFixedRate(SafeTimerTask task,
                                long delay,
                                long period)

Specified by:

scheduleAtFixedRate in interface SafeTimer

See Also:

Timer.scheduleAtFixedRate(TimerTask, long, long)

scheduleAtFixedRate

public void scheduleAtFixedRate(SafeTimerTask task,
                                long period)

Description copied from interface: SafeTimer

Schedule at a fixed rate with no delay.

Specified by:

scheduleAtFixedRate in interface SafeTimer

See Also:

Timer.scheduleAtFixedRate(TimerTask, long, long)

cancel

public void cancel()

Description copied from interface: SafeTimer

Cancel this timer.

Specified by:

cancel in interface SafeTimer