io.opencensus.testing.common

Class TestClock

java.lang.Object

io.opencensus.common.Clock

io.opencensus.testing.common.TestClock

@ThreadSafe
public final class TestClock
extends io.opencensus.common.Clock

A Clock that allows the time to be set for testing.

Since:

0.5

Method Summary

Modifier and Type	Method and Description
void	advanceTime(io.opencensus.common.Duration duration) Advances the time by a duration.
static TestClock	create() Creates a clock initialized to a constant non-zero time.
static TestClock	create(io.opencensus.common.Timestamp time) Creates a clock with the given time.
io.opencensus.common.Timestamp	now()
long	nowNanos()
void	setTime(io.opencensus.common.Timestamp time) Sets the time.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static TestClock create()

Creates a clock initialized to a constant non-zero time. Timestamp.create(0, 0) is not a good default, because it represents an invalid time.

Returns:

a clock initialized to a constant non-zero time.

Since:

0.5

create

public static TestClock create(io.opencensus.common.Timestamp time)

Creates a clock with the given time.

Parameters:

time - the initial time.

Returns:

a new TestClock with the given time.

Since:

0.5

setTime

public void setTime(io.opencensus.common.Timestamp time)

Sets the time.

Parameters:

time - the new time.

Since:

0.5

advanceTime

public void advanceTime(io.opencensus.common.Duration duration)

Advances the time by a duration.

Parameters:

duration - the increase in time.

Since:

0.5

now

public io.opencensus.common.Timestamp now()

Specified by:

now in class io.opencensus.common.Clock

nowNanos

public long nowNanos()

Specified by:

nowNanos in class io.opencensus.common.Clock