io.opentelemetry.sdk.internal

Class TestClock

java.lang.Object

io.opentelemetry.sdk.internal.TestClock

All Implemented Interfaces:

Clock

@ThreadSafe
public class TestClock
extends Object
implements Clock

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

Since:

0.1.0

Method Summary

Modifier and Type	Method and Description
void	advanceMillis(long millis) Advances the time by millis and mutates this instance.
void	advanceNanos(long nanos) Advances the time by nanos and mutates this instance.
static TestClock	create() Creates a clock initialized to a constant non-zero time.
static TestClock	create(long epochNanos) Creates a clock with the given time.
long	nanoTime() Returns a time measurement with nanosecond precision that can only be used to calculate elapsed time.
long	now() Obtains the current epoch timestamp in nanos from this clock.
void	setTime(long epochNanos) 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.

Returns:

a clock initialized to a constant non-zero time.

Since:

0.1.0

create

public static TestClock create(long epochNanos)

Creates a clock with the given time.

Parameters:

epochNanos - the initial time in nanos since epoch.

Returns:

a new TestClock with the given time.

Since:

0.1.0

setTime

public void setTime(long epochNanos)

Sets the time.

Parameters:

epochNanos - the new time.

Since:

0.1.0

advanceMillis

public void advanceMillis(long millis)

Advances the time by millis and mutates this instance.

Parameters:

millis - the increase in time.

Since:

0.1.0

advanceNanos

public void advanceNanos(long nanos)

Advances the time by nanos and mutates this instance.

Parameters:

nanos - the increase in time.

Since:

0.1.0

now

public long now()

Description copied from interface: Clock

Obtains the current epoch timestamp in nanos from this clock.

Specified by:

now in interface Clock

Returns:

the current epoch timestamp in nanos.

nanoTime

public long nanoTime()

Description copied from interface: Clock

Returns a time measurement with nanosecond precision that can only be used to calculate elapsed time.

Specified by:

nanoTime in interface Clock

Returns:

a time measurement with nanosecond precision that can only be used to calculate elapsed time.