cz.auderis.tools.time

Class ManualTimeProvider

java.lang.Object

cz.auderis.tools.time.ManualTimeProvider

All Implemented Interfaces:

TimeProvider, Serializable

Direct Known Subclasses:

SteppingTimeProvider

public class ManualTimeProvider
extends Object
implements TimeProvider, Serializable

Implementation of TimeProvider that provides time that is constant; the time is changed exclusively by invoking appropriate methods.

This implementation is useful for testing, where non-real-time scenarios need to be checked.

Notice that the millisecond value may be negative - the class makes no checks in this regard.

Version:

1.0

Author:

Boleslav Bobcik <bbobcik@gmail.com>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected AtomicLong	time

Constructor Summary

Constructors

Constructor and Description
ManualTimeProvider() Instantiates a new manual time provider that is initialized to the current system time.
ManualTimeProvider(long startTime) Instantiates a new manual time provider that is initialized to the provided start time specified as milliseconds.

Method Summary

Modifier and Type	Method and Description
long	getTimeInMillis() Gets current time in milliseconds.
ManualTimeProvider	setTimeInMillis(long millis) Changes the time of this TimeProvider to the new value given in milliseconds.
ManualTimeProvider	step(long incrementMillis) Changes the time of this TimeProvider by the specified increment specified in milliseconds.
ManualTimeProvider	step(long increment, TimeUnit unit) Changes the time of this TimeProvider by the specified increment.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

time

protected final AtomicLong time

Constructor Detail

ManualTimeProvider

public ManualTimeProvider()

Instantiates a new manual time provider that is initialized to the current system time.

ManualTimeProvider

public ManualTimeProvider(long startTime)

Instantiates a new manual time provider that is initialized to the provided start time specified as milliseconds.

Parameters:

startTime - the start time given in milliseconds

Method Detail

getTimeInMillis

public long getTimeInMillis()

Description copied from interface: TimeProvider

Gets current time in milliseconds. The mechanism used to obtain the time value depends on implementation.

Specified by:

getTimeInMillis in interface TimeProvider

Returns:

time given in milliseconds

setTimeInMillis

public ManualTimeProvider setTimeInMillis(long millis)

Changes the time of this TimeProvider to the new value given in milliseconds.

Parameters:

millis - new time given in milliseconds

Returns:

the current instance

step

public ManualTimeProvider step(long incrementMillis)

Changes the time of this TimeProvider by the specified increment specified in milliseconds.

The increment may be negative.

Parameters:

incrementMillis - the increment given in milliseconds

Returns:

the current instance

step

public ManualTimeProvider step(long increment,
                               TimeUnit unit)

Changes the time of this TimeProvider by the specified increment.

The increment may be negative.

Parameters:

increment - the increment

unit - time unit of the increment

Returns:

the current instance

Throws:

NullPointerException - if unit is null

toString

public String toString()

Overrides:

toString in class Object