com.google.common.testing

Class FakeTicker

java.lang.Object

com.google.common.base.Ticker

com.google.common.testing.FakeTicker

@Beta
 @GwtCompatible
public class FakeTicker
extends com.google.common.base.Ticker

A Ticker whose value can be advanced programmatically in test.

The ticker can be configured so that the time is incremented whenever read() is called: see setAutoIncrementStep(long, java.util.concurrent.TimeUnit).

This class is thread-safe.

Since:

10.0

Author:

Jige Yu

Constructor Summary

Constructors

Constructor and Description
FakeTicker()

Method Summary

Modifier and Type	Method and Description
FakeTicker	advance(Duration duration) Advances the ticker value by duration.
FakeTicker	advance(long nanoseconds) Advances the ticker value by nanoseconds.
FakeTicker	advance(long time, TimeUnit timeUnit) Advances the ticker value by time in timeUnit.
long	read()
FakeTicker	setAutoIncrementStep(Duration autoIncrementStep) Sets the increment applied to the ticker whenever it is queried.
FakeTicker	setAutoIncrementStep(long autoIncrementStep, TimeUnit timeUnit) Sets the increment applied to the ticker whenever it is queried.

Methods inherited from class com.google.common.base.Ticker

systemTicker

Methods inherited from class java.lang.Object

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

Constructor Detail

FakeTicker

public FakeTicker()

Method Detail

advance

public FakeTicker advance(long time,
                          TimeUnit timeUnit)

Advances the ticker value by time in timeUnit.

advance

public FakeTicker advance(long nanoseconds)

Advances the ticker value by nanoseconds.

advance

@GwtIncompatible
public FakeTicker advance(Duration duration)

Advances the ticker value by duration.

Since:

28.0

setAutoIncrementStep

public FakeTicker setAutoIncrementStep(long autoIncrementStep,
                                       TimeUnit timeUnit)

Sets the increment applied to the ticker whenever it is queried.

The default behavior is to auto increment by zero. i.e: The ticker is left unchanged when queried.

setAutoIncrementStep

@GwtIncompatible
public FakeTicker setAutoIncrementStep(Duration autoIncrementStep)

Sets the increment applied to the ticker whenever it is queried.

The default behavior is to auto increment by zero. i.e: The ticker is left unchanged when queried.

Since:

28.0

read

public long read()

Specified by:

read in class com.google.common.base.Ticker