uk.org.lidalia.test

Class StaticTimeRule

java.lang.Object

uk.org.lidalia.test.StaticTimeRule

All Implemented Interfaces:

org.junit.rules.TestRule

public class StaticTimeRule
extends Object
implements org.junit.rules.TestRule

A JUnit rule that sets the time returned by the Joda Time classes to a static time for the duration of the test.

At the start of each test the time as viewed by Joda Time classes is frozen to the provided time. At the end of the test it is returned to the system time. This makes time based testing predictable.

Method Summary

Methods

Modifier and Type	Method and Description
static StaticTimeRule	always(org.joda.time.ReadableInstant instant)
static StaticTimeRule	alwaysNow()
static StaticTimeRule	alwaysStartOfEpoch()
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)
org.joda.time.ReadableInstant	getInstant()

Methods inherited from class java.lang.Object

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

Method Detail

alwaysStartOfEpoch

public static StaticTimeRule alwaysStartOfEpoch()

Returns:

a static time rule which will freeze the time at the start of the unix epoch

alwaysNow

public static StaticTimeRule alwaysNow()

Returns:

a static time rule which will freeze the time at the instant this method was invoked

always

public static StaticTimeRule always(org.joda.time.ReadableInstant instant)

Parameters:

instant - the instant at which time will be frozen

Returns:

a static time rule which will freeze the time to the provided instant

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                      org.junit.runner.Description description)

Specified by:

apply in interface org.junit.rules.TestRule

getInstant

public org.joda.time.ReadableInstant getInstant()

Returns:

the instant at which time is frozen by this rule