com.trivago.triava.time

Interface TimeSource

All Known Implementing Classes:

EstimatorTimeSource, OffsetTimeSource, SystemTimeSource

public interface TimeSource

The TimeSource interface allows the integration of arbitrary time sources. Simple implementations can deliver the system time from System.nanoTime(), more complex implementations can do for example the following:

• Cache the time
• Use a specific time when replaying error situations or to check behavior on DST time borders.
• Read it from custom hardware devices
• Skew the time to check the effects when ntp adjusts the time to go faster, slower or backwards.

Any implementation must be able to deliver the time in seconds and milliseconds since epoch, and may support more TimeUnit's.

Author:

cesken

Method Summary

Modifier and Type	Method and Description
long	millis() Returns the time in milliseconds.
long	seconds() Returns the time in seconds.
void	shutdown() Shutdown the time source.
long	time(TimeUnit timeUnit) Returns the time in the given time unit.

Method Detail

time

long time(TimeUnit timeUnit)

Returns the time in the given time unit. It is recommended for unsupported TimeUnit values to throw an UnsupportedOperation exception.

Parameters:

timeUnit - The time unit for the return value

Returns:

time in milliseconds since epoch

seconds

long seconds()

Returns the time in seconds. Convenience method, with the same effect as passing TimeUnit.SECONDS to time(TimeUnit)

Returns:

time in seconds since epoch

millis

long millis()

Returns the time in milliseconds. Convenience method, with the same effect as passing TimeUnit.MILLISECONDS time(TimeUnit)

Returns:

time in milliseconds since epoch

shutdown

void shutdown()

Shutdown the time source. Implementations should release all resources they use, like background threads, memory and connections to hardware clocks.