org.eclipse.jgit.junit.time

Class MonotonicFakeClock

java.lang.Object

org.eclipse.jgit.junit.time.MonotonicFakeClock

All Implemented Interfaces:

MonotonicClock

public class MonotonicFakeClock
extends Object
implements MonotonicClock

Fake MonotonicClock for testing code that uses Clock.

Since:

4.6

Constructor Summary

Constructors

Constructor and Description
MonotonicFakeClock()

Method Summary

Modifier and Type	Method and Description
ProposedTimestamp	propose() Obtain a timestamp close to "now".
void	tick(long add, TimeUnit unit) Advance the time returned by future calls to propose().

Methods inherited from class java.lang.Object

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

Constructor Detail

MonotonicFakeClock

public MonotonicFakeClock()

Method Detail

tick

public void tick(long add,
                 TimeUnit unit)

Advance the time returned by future calls to propose().

Parameters:

add - amount of time to add; must be > 0.

unit - unit of add.

propose

public ProposedTimestamp propose()

Description copied from interface: MonotonicClock

Obtain a timestamp close to "now".

Proposed times are close to "now", but may not yet be certainly in the past. This allows the calling thread to interleave other useful work while waiting for the clock instance to create an assurance it will never in the future propose a time earlier than the returned time.

A hypothetical implementation could read the local system clock (managed by NTP) and return that proposal, concurrently sending network messages to closely collaborating peers in the same cluster to also ensure their system clocks are ahead of this time. In such an implementation the ProposedTimestamp.blockUntil(Duration) method would wait for replies from the peers indicating their own system clocks have moved past the proposed time.

Specified by:

propose in interface MonotonicClock

Returns:

"now". The value can be immediately accessed by ProposedTimestamp.read(TimeUnit) and friends, but the caller must use ProposedTimestamp.blockUntil(Duration) to ensure ordering holds.