net.openhft.chronicle.core.time

Class SetTimeProvider

java.lang.Object

java.lang.Number

java.util.concurrent.atomic.AtomicLong

net.openhft.chronicle.core.time.SetTimeProvider

All Implemented Interfaces:

Serializable, TimeProvider

public class SetTimeProvider
extends AtomicLong
implements TimeProvider

A TimeProvider implementation that allows explicit setting and manipulation of time values for testing purposes. This class supports time values in milliseconds, microseconds, and nanoseconds. It can be set to a specific time and can be auto-incremented at each call, which is useful for simulating time progression in a controlled testing environment.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SetTimeProvider() Constructs a time provider initialized to 0 nanoseconds.
SetTimeProvider(Instant instant) Constructs a time provider starting at a given Instant.
SetTimeProvider(long initialNanos) Constructs a time provider starting at a specific time in nanoseconds.
SetTimeProvider(String timestamp) Constructs a time provider starting at a time specified in ISO8601 format.

Method Summary

Modifier and Type	Method and Description
SetTimeProvider	advanceMicros(long micros) Advances the current time by the specified duration in microseconds.
SetTimeProvider	advanceMillis(long millis) Advances the current time by the specified duration in milliseconds.
SetTimeProvider	advanceNanos(long nanos) Advances the current time by the specified duration in nanoseconds.
SetTimeProvider	autoIncrement(long autoIncrement, TimeUnit timeUnit) Configures this time provider to auto-increment the time after each invocation.
long	currentTime(TimeUnit unit) Converts and retrieves the current time in the specified time unit.
long	currentTimeMicros() Retrieves the current time in microseconds.
void	currentTimeMicros(long micros) Explicitly sets the current time in microseconds.
long	currentTimeMillis() Retrieves the current time in milliseconds.
void	currentTimeMillis(long millis) Explicitly sets the current time in milliseconds.
long	currentTimeNanos() Retrieves the current time in nanoseconds.
void	currentTimeNanos(long nanos) Explicitly sets the current time in nanoseconds.
SetTimeProvider	now() Constructs a time provider that starts now, using the current nanosecond time.
String	toString() Provides a string representation of the SetTimeProvider state.

Methods inherited from class java.util.concurrent.atomic.AtomicLong

accumulateAndGet, addAndGet, compareAndSet, decrementAndGet, doubleValue, floatValue, get, getAndAccumulate, getAndAdd, getAndDecrement, getAndIncrement, getAndSet, getAndUpdate, incrementAndGet, intValue, lazySet, longValue, set, updateAndGet, weakCompareAndSet

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SetTimeProvider

public SetTimeProvider()

Constructs a time provider initialized to 0 nanoseconds.

SetTimeProvider

public SetTimeProvider(long initialNanos)

Constructs a time provider starting at a specific time in nanoseconds.

Parameters:

initialNanos - Initial time in nanoseconds since the epoch.

SetTimeProvider

public SetTimeProvider(String timestamp)

Constructs a time provider starting at a time specified in ISO8601 format.

Parameters:

timestamp - The initial timestamp in ISO8601 format.

SetTimeProvider

public SetTimeProvider(Instant instant)

Constructs a time provider starting at a given Instant.

Parameters:

instant - The initial time instant.

Method Detail

now

public SetTimeProvider now()

Constructs a time provider that starts now, using the current nanosecond time.

Returns:

A new SetTimeProvider initialized to the current time.

autoIncrement

public SetTimeProvider autoIncrement(long autoIncrement,
                                     TimeUnit timeUnit)

Configures this time provider to auto-increment the time after each invocation.

Parameters:

autoIncrement - The amount of time to auto-increment after each time retrieval.

timeUnit - The time unit of the autoIncrement value.

Returns:

The current SetTimeProvider instance for fluent method chaining.

currentTimeMillis

public void currentTimeMillis(long millis)
                       throws IllegalArgumentException

Explicitly sets the current time in milliseconds.

Parameters:

millis - New time value in milliseconds since the epoch. It must not be less than the previous value.

Throws:

IllegalArgumentException - if the time is set to a value earlier than the current time.

currentTimeMillis

public long currentTimeMillis()

Retrieves the current time in milliseconds.

Specified by:

currentTimeMillis in interface TimeProvider

Returns:

Current time in milliseconds since the epoch.

currentTimeMicros

public void currentTimeMicros(long micros)
                       throws IllegalArgumentException

Explicitly sets the current time in microseconds.

Parameters:

micros - New time value in microseconds since the epoch. It must not be less than the previous value.

Throws:

IllegalArgumentException - if the time is set to a value earlier than the current time.

currentTimeMicros

public long currentTimeMicros()

Retrieves the current time in microseconds.

Specified by:

currentTimeMicros in interface TimeProvider

Returns:

Current time in microseconds since the epoch.

currentTimeNanos

public void currentTimeNanos(long nanos)
                      throws IllegalArgumentException

Explicitly sets the current time in nanoseconds.

Parameters:

nanos - New time value in nanoseconds since the epoch. It must not be less than the previous value.

Throws:

IllegalArgumentException - if the time is set to a value earlier than the current time.

currentTimeNanos

public long currentTimeNanos()

Retrieves the current time in nanoseconds.

Specified by:

currentTimeNanos in interface TimeProvider

Returns:

Current time in nanoseconds since the epoch.

currentTime

public long currentTime(TimeUnit unit)

Converts and retrieves the current time in the specified time unit.

Parameters:

unit - The time unit to return the current time in.

Returns:

The current time in the specified time unit.

advanceMillis

public SetTimeProvider advanceMillis(long millis)

Advances the current time by the specified duration in milliseconds.

Parameters:

millis - The duration in milliseconds to advance the time.

Returns:

The current SetTimeProvider instance for fluent method chaining.

advanceMicros

public SetTimeProvider advanceMicros(long micros)

Advances the current time by the specified duration in microseconds.

Parameters:

micros - The duration in microseconds to advance the time.

Returns:

The current SetTimeProvider instance for fluent method chaining.

advanceNanos

public SetTimeProvider advanceNanos(long nanos)

Advances the current time by the specified duration in nanoseconds.

Parameters:

nanos - The duration in nanoseconds to advance the time.

Returns:

The current SetTimeProvider instance for fluent method chaining.

toString

public String toString()

Provides a string representation of the SetTimeProvider state.

Overrides:

toString in class AtomicLong

Returns:

A string representation, including the auto-increment value and current nanosecond time.