org.janusgraph.diskstorage.util.time

Interface TimestampProvider

All Known Implementing Classes:

TimestampProviders

public interface TimestampProvider

System time interface that abstracts time units, resolution, and measurements of time.

Method Summary

Modifier and Type	Method and Description
Instant	getTime() Returns the current time based on this timestamp provider as a Instant.
long	getTime(Instant timestamp) Returns the scalar value for this instant given the configured time unit
Instant	getTime(long sinceEpoch) Returns the given time as a Instant based off of this timestamp providers units
Timer	getTimer() Returns a Timer based on this timestamp provider
ChronoUnit	getUnit() Return the units of getTime().
void	sleepFor(Duration duration) Sleep for the given duration of time.
Instant	sleepPast(Instant futureTime) Block until the current time as returned by getTime() is greater than the given timepoint.

Method Detail

getTime

Instant getTime()

Returns the current time based on this timestamp provider as a Instant.

Returns:

getTime

Instant getTime(long sinceEpoch)

Returns the given time as a Instant based off of this timestamp providers units

Parameters:

sinceEpoch -

Returns:

getUnit

ChronoUnit getUnit()

Return the units of getTime(). This method's return value must be constant over at least the life of the object implementing this interface.

Returns:

this instance's time unit

sleepPast

Instant sleepPast(Instant futureTime)
           throws InterruptedException

Block until the current time as returned by getTime() is greater than the given timepoint.

Parameters:

futureTime - The time to sleep past

Returns:

the current time in the same units as the unit argument

Throws:

InterruptedException - if externally interrupted

sleepFor

void sleepFor(Duration duration)
       throws InterruptedException

Sleep for the given duration of time.

Parameters:

duration -

Throws:

InterruptedException

getTimer

Timer getTimer()

Returns a Timer based on this timestamp provider

Returns:

getTime

long getTime(Instant timestamp)

Returns the scalar value for this instant given the configured time unit

Parameters:

timestamp -

Returns: