org.mule.tck.util

Class TestTimeSupplier

java.lang.Object

org.mule.tck.util.TestTimeSupplier

All Implemented Interfaces:

Supplier<Long>, org.mule.runtime.api.time.TimeSupplier

public class TestTimeSupplier
extends Object
implements org.mule.runtime.api.time.TimeSupplier

A test TimeSupplier for externalizing the system time. It is initialised at a given initial timeInMillis using the TestTimeSupplier(long) constructor. The value can be retrieved through the get() method.

The usefulness of ths class comes from the behavior provided by the move(long, TimeUnit) method which allows changing that value per the tests needs. After invoking this method, you can retrieved the modified value through the get() method, although there's no way to retrieve the original one after move(long, TimeUnit) has been invoked.

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
TestTimeSupplier(long timeInMillis) Creates a new instance

Method Summary

Modifier and Type	Method and Description
Long	get() Returns the current virtualized time in milliseconds
long	move(long timeOffset, TimeUnit unit) Moves the current timeInMillis by the given time which is expressed in the given unit.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestTimeSupplier

public TestTimeSupplier(long timeInMillis)

Creates a new instance

Parameters:

timeInMillis - time in milliseconds to be supplied until its modified by move(long, TimeUnit)

Method Detail

get

public Long get()

Returns the current virtualized time in milliseconds

Specified by:

get in interface Supplier<Long>

Specified by:

get in interface org.mule.runtime.api.time.TimeSupplier

move

public long move(long timeOffset,
                 TimeUnit unit)

Moves the current timeInMillis by the given time which is expressed in the given unit.

Parameters:

timeOffset - the offset to be applied on timeInMillis

unit - a TimeUnit which qualifies the timeOffset

Returns:

the updated timeInMillis

Throws:

IllegalArgumentException - if timeOffset is negative