com.zaxxer.hikari.util

Interface ClockSource

All Known Implementing Classes:

ClockSource.MillisecondClockSource, ClockSource.NanosecondClockSource

public interface ClockSource

A resolution-independent provider of current time-stamps and elapsed time calculations.

Author:

Brett Wooldridge

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ClockSource.Factory Factory class used to create a platform-specific ClockSource.
static class	ClockSource.MillisecondClockSource
static class	ClockSource.NanosecondClockSource

Field Summary

Fields

Modifier and Type	Field and Description
static ClockSource	INSTANCE
static String[]	TIMEUNIT_DISPLAY_VALUES
static TimeUnit[]	TIMEUNITS_DESCENDING

Method Summary

Methods

Modifier and Type	Method and Description
long	currentTime() Get the current time-stamp (resolution is opaque).
String	elapsedDisplayString(long startTime, long endTime) Get a String representation of the elapsed time in appropriate magnitude terminology.
long	elapsedMillis(long startTime) Convert an opaque time-stamp returned by currentTime() into an elapsed time in milliseconds, based on the current instant in time.
long	elapsedMillis(long startTime, long endTime) Get the difference in milliseconds between two opaque time-stamps returned by currentTime().
long	elapsedNanos(long startTime) Convert an opaque time-stamp returned by currentTime() into an elapsed time in milliseconds, based on the current instant in time.
long	elapsedNanos(long startTime, long endTime) Get the difference in nanoseconds between two opaque time-stamps returned by currentTime().
TimeUnit	getSourceTimeUnit() Get the TimeUnit the ClockSource is denominated in.
long	plusMillis(long time, long millis) Return the specified opaque time-stamp plus the specified number of milliseconds.
long	toMillis(long time) Convert an opaque time-stamp returned by currentTime() into milliseconds.
long	toNanos(long time) Convert an opaque time-stamp returned by currentTime() into nanoseconds.

Field Detail

INSTANCE

static final ClockSource INSTANCE

TIMEUNITS_DESCENDING

static final TimeUnit[] TIMEUNITS_DESCENDING

TIMEUNIT_DISPLAY_VALUES

static final String[] TIMEUNIT_DISPLAY_VALUES

Method Detail

currentTime

long currentTime()

Get the current time-stamp (resolution is opaque).

Returns:

the current time-stamp

toMillis

long toMillis(long time)

Convert an opaque time-stamp returned by currentTime() into milliseconds.

Parameters:

time - an opaque time-stamp returned by an instance of this class

Returns:

the time-stamp in milliseconds

toNanos

long toNanos(long time)

Convert an opaque time-stamp returned by currentTime() into nanoseconds.

Parameters:

time - an opaque time-stamp returned by an instance of this class

Returns:

the time-stamp in nanoseconds

elapsedMillis

long elapsedMillis(long startTime)

Convert an opaque time-stamp returned by currentTime() into an elapsed time in milliseconds, based on the current instant in time.

Parameters:

startTime - an opaque time-stamp returned by an instance of this class

Returns:

the elapsed time between startTime and now in milliseconds

elapsedMillis

long elapsedMillis(long startTime,
                 long endTime)

Get the difference in milliseconds between two opaque time-stamps returned by currentTime().

Parameters:

startTime - an opaque time-stamp returned by an instance of this class

endTime - an opaque time-stamp returned by an instance of this class

Returns:

the elapsed time between startTime and endTime in milliseconds

elapsedNanos

long elapsedNanos(long startTime)

Convert an opaque time-stamp returned by currentTime() into an elapsed time in milliseconds, based on the current instant in time.

Parameters:

startTime - an opaque time-stamp returned by an instance of this class

Returns:

the elapsed time between startTime and now in milliseconds

elapsedNanos

long elapsedNanos(long startTime,
                long endTime)

Get the difference in nanoseconds between two opaque time-stamps returned by currentTime().

Parameters:

startTime - an opaque time-stamp returned by an instance of this class

endTime - an opaque time-stamp returned by an instance of this class

Returns:

the elapsed time between startTime and endTime in nanoseconds

plusMillis

long plusMillis(long time,
              long millis)

Return the specified opaque time-stamp plus the specified number of milliseconds.

Parameters:

time - an opaque time-stamp

millis - milliseconds to add

Returns:

a new opaque time-stamp

getSourceTimeUnit

TimeUnit getSourceTimeUnit()

Get the TimeUnit the ClockSource is denominated in.

Returns:

the internal TimeUnit used by the ClockSource

elapsedDisplayString

String elapsedDisplayString(long startTime,
                          long endTime)

Get a String representation of the elapsed time in appropriate magnitude terminology.

Parameters:

startTime - an opaque time-stamp

endTime - an opaque time-stamp

Returns:

a string representation of the elapsed time interval