net.openhft.chronicle.core.time

Enum SystemTimeProvider

java.lang.Object

java.lang.Enum<SystemTimeProvider>

net.openhft.chronicle.core.time.SystemTimeProvider

All Implemented Interfaces:

Serializable, Comparable<SystemTimeProvider>, TimeProvider

public enum SystemTimeProvider
extends Enum<SystemTimeProvider>
implements TimeProvider

SystemTimeProvider synthesises a nanosecond wall-clock time via System.nanoTime deltas in combination with System.currentTimeMillis.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Field Summary

Fields

Modifier and Type	Field and Description
static TimeProvider	CLOCK

Method Summary

Modifier and Type	Method and Description
long	currentTimeMicros() Retrieves the current time in microseconds.
long	currentTimeMillis() Retrieves the current time in milliseconds.
long	currentTimeNanos() Retrieves the current time in nanoseconds.
static SystemTimeProvider	valueOf(String name) Returns the enum constant of this type with the specified name.
static SystemTimeProvider[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final SystemTimeProvider INSTANCE

Field Detail

CLOCK

public static TimeProvider CLOCK

Method Detail

values

public static SystemTimeProvider[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SystemTimeProvider c : SystemTimeProvider.values())
    System.out.println(c);

Returns:

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

valueOf

public static SystemTimeProvider valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

currentTimeMillis

public long currentTimeMillis()

Description copied from interface: TimeProvider

Retrieves the current time in milliseconds.

This method returns the current time with millisecond precision, measured from the Unix epoch (00:00:00 UTC on 1 January 1970). It is expected to be implemented by all subclasses, providing the baseline precision for time measurements.

Specified by:

currentTimeMillis in interface TimeProvider

Returns:

the current time in milliseconds since the Unix epoch

currentTimeMicros

public long currentTimeMicros()

Description copied from interface: TimeProvider

Retrieves the current time in microseconds.

This default implementation offers microsecond precision by scaling the millisecond value from TimeProvider.currentTimeMillis() by a factor of 1000. Implementations may override this for higher accuracy if available.

Specified by:

currentTimeMicros in interface TimeProvider

Returns:

The current time in microseconds since the Unix epoch.

currentTimeNanos

public long currentTimeNanos()

Description copied from interface: TimeProvider

Retrieves the current time in nanoseconds.

This default method provides nanosecond precision by further scaling the microsecond value from TimeProvider.currentTimeMicros() by 1000. Implementations may provide more precise or direct measurements if their underlying system supports it.

Specified by:

currentTimeNanos in interface TimeProvider

Returns:

a nanosecond time stamp which is generally monotonically increasing