- Direct Known Subclasses:
public abstract class TimeSource extends ObjectSource of time.
NOTE: depending on implementation returned values may not be related in any way to the current Epoch or calendar time, and they may even be negative - but the API guarantees that they are always monotonically increasing.
Nested Class Summary
Nested Classes Modifier and Type Class Description
TimeSource.CurrentTimeSourceImplementation that uses
TimeSource.NanoTimeSourceImplementation that uses
TimeSource.SimTimeSourceImplementation that uses
NANO_TIMEaccelerated by a double multiplier.
Constructors Constructor Description
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description
convertDelay(TimeUnit fromUnit, long value, TimeUnit toUnit)This method allows using TimeSource with APIs that require providing just plain time intervals, eg.
get(String type)Obtain an instance of time source.
getEpochTimeNs()Return Epoch time.
getTimeAndEpochNs()Return both the source's time value and the corresponding epoch time value.
getTimeNs()Return a time value, in nanosecond units.
sleep(long ms)Sleep according to this source's notion of time.
public static TimeSource get(String type)Obtain an instance of time source.
type- supported types:
nanoTimeand accelerated time with a double factor in the form of
- one of the supported types
public abstract long getTimeNs()Return a time value, in nanosecond units. Depending on implementation this value may or may not be related to Epoch time.
public abstract long getEpochTimeNs()Return Epoch time. Implementations that are not natively based on epoch time may return values that are consistently off by a (small) fixed number of milliseconds from the actual epoch time.
public abstract long getTimeAndEpochNs()Return both the source's time value and the corresponding epoch time value. This method ensures that epoch time calculations use the same internal value of time as that reported by
public abstract void sleep(long ms) throws InterruptedExceptionSleep according to this source's notion of time. Eg. accelerated time source such as
TimeSource.SimTimeSourcewill sleep proportionally shorter, according to its multiplier.
ms- number of milliseconds to sleep
InterruptedException- when the current thread is interrupted
convertDelayThis method allows using TimeSource with APIs that require providing just plain time intervals, eg.
Object.wait(long). Values returned by this method are adjusted according to the time source's notion of time - eg. accelerated time source provided by
TimeSource.SimTimeSourcewill return intervals that are proportionally shortened by the multiplier.
NOTE: converting small values may significantly affect precision of the returned values due to rounding, especially for accelerated time source, so care should be taken to use time units that result in relatively large values. For example, converting a value of 1 expressed in seconds would result in less precision than converting a value of 1000 expressed in milliseconds.
fromUnit- source unit
value- original value
toUnit- target unit
- converted value, possibly scaled by the source's notion of accelerated time