Package io.deephaven.base.clock

Enum Class SystemClockMillis

java.lang.Object

java.lang.Enum<SystemClockMillis>

io.deephaven.base.clock.SystemClockMillis

All Implemented Interfaces:

Clock, SystemClock, Serializable, Comparable<SystemClockMillis>, java.lang.constant.Constable

public enum SystemClockMillis
extends Enum<SystemClockMillis>
implements SystemClock

A clock based off of System.currentTimeMillis().

This clock differs from SystemClockUtc in that all timestamp methods have millisecond-level resolution.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Field Summary

Fields inherited from interface io.deephaven.base.clock.SystemClock

DEFAULT, KEY, SERVICE_LOADER, SYSTEM_MILLIS, SYSTEM_UTC

Method Summary

Modifier and Type	Method	Description
long	currentTimeMicros()	Equivalent to System.currentTimeMillis() * 1_000.
long	currentTimeMillis()	Equivalent to System.currentTimeMillis().
long	currentTimeNanos()	Nanoseconds since the epoch, 1970-01-01T00:00:00Z.
Instant	instantMillis()	The instant.
Instant	instantNanos()	The instant.
static SystemClockMillis	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SystemClockMillis[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INSTANCE

public static final SystemClockMillis INSTANCE

Method Details

values

public static SystemClockMillis[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SystemClockMillis valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

currentTimeMillis

public long currentTimeMillis()

Equivalent to System.currentTimeMillis().

Specified by:

currentTimeMillis in interface Clock

Returns:

epoch millis

currentTimeMicros

public long currentTimeMicros()

Equivalent to System.currentTimeMillis() * 1_000.

Specified by:

currentTimeMicros in interface Clock

Returns:

epoch microseconds

currentTimeNanos

public long currentTimeNanos()

Nanoseconds since the epoch, 1970-01-01T00:00:00Z.

The resolution is dependent on the JVM and underlying implementation. The resolution is greater than or equal to Clock.currentTimeMicros() and Clock.currentTimeMillis().

Calculates the time from Clock.systemUTC(). If you don't need nanosecond resolution, prefer currentTimeMillis().

Note: this method may allocate.

Specified by:

currentTimeNanos in interface Clock

Returns:

epoch nanoseconds

instantNanos

public Instant instantNanos()

The instant.

Has resolution equal to Clock.currentTimeNanos().

If you don't need the resolution provided by Clock.currentTimeNanos(), prefer Clock.instantMillis().

Equivalent to Instant.ofEpochMilli(System.currentTimeMillis()).

Specified by:

instantNanos in interface Clock

Returns:

the instant

instantMillis

public Instant instantMillis()

The instant.

Has resolution greater than or equal to Clock.currentTimeMillis().

Equivalent to Instant.ofEpochMilli(System.currentTimeMillis()).

Specified by:

instantMillis in interface Clock

Returns:

the instant.