SetTimeProvider (OpenHFT/Chronicle-Core 2026.4 API)

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 initialised to zero 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

All Methods Instance Methods Concrete Methods
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)` Enables time auto-increment after each call to `currentTimeNanos()`.
`long`	`currentTime(TimeUnit unit)` Converts and retrieves the current time in the specified 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.
`String`	`toString()` Provides a string representation of the provider 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 initialised to zero nanoseconds.
  - SetTimeProvider
```
public SetTimeProvider(long initialNanos)
```
    Constructs a time provider starting at a specific time in nanoseconds.
    
    Parameters:
    
    initialNanos - starting time in nanoseconds, non-negative
  - SetTimeProvider
```
public SetTimeProvider(String timestamp)
```
    Constructs a time provider starting at a time specified in ISO8601 format.
    
    Parameters:
    
    timestamp - ISO8601 timestamp, not null
  - SetTimeProvider
```
public SetTimeProvider(Instant instant)
```
    Constructs a time provider starting at a given Instant.
    
    Parameters:
    
    instant - initial time instant, not null
- Method Detail
  - now
```
public SetTimeProvider now()
```
    Constructs a time provider that starts now.
    
    Returns:
    
    a new provider initialised to the current time
  - autoIncrement
```
public SetTimeProvider autoIncrement(long autoIncrement,
                                     TimeUnit timeUnit)
```
    Enables time auto-increment after each call to currentTimeNanos().
    Example usage in a JUnit test:
```
 SetTimeProvider tp = new SetTimeProvider("2023-01-01T00:00:00")
         .autoIncrement(1, TimeUnit.MILLISECONDS);
 
 
```
    Every read of the current time now advances by one millisecond. When running tests concurrently, coordinate access to avoid unexpected jumps.
    Parameters:
    
    autoIncrement - increment amount, non-negative
    
    timeUnit - unit of autoIncrement
    
    Returns:
    
    this instance for chaining
  - currentTimeMillis
```
public void currentTimeMillis(long millis)
                       throws IllegalArgumentException
```
    Explicitly sets the current time in milliseconds.
    
    Parameters:
    
    millis - new time in milliseconds, not less than the current value
    
    Throws:
    
    IllegalArgumentException - if the time would go backwards
  - currentTimeMillis
```
public long currentTimeMillis()
```
    Retrieves the current time in milliseconds.
    
    Specified by:
    
    currentTimeMillis in interface TimeProvider
    
    Returns:
    
    the 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 in microseconds, not less than the current value
    
    Throws:
    
    IllegalArgumentException - if the time would go backwards
  - currentTimeMicros
```
public long currentTimeMicros()
```
    Retrieves the current time in microseconds.
    
    Specified by:
    
    currentTimeMicros in interface TimeProvider
    
    Returns:
    
    the 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 in nanoseconds, not less than the current value
    
    Throws:
    
    IllegalArgumentException - if the time would go backwards
  - currentTimeNanos
```
public long currentTimeNanos()
```
    Retrieves the current time in nanoseconds.
    
    Specified by:
    
    currentTimeNanos in interface TimeProvider
    
    Returns:
    
    the current time in nanoseconds since the epoch
  - currentTime
```
public long currentTime(TimeUnit unit)
```
    Converts and retrieves the current time in the specified unit.
    
    Parameters:
    
    unit - target unit, not null
    
    Returns:
    
    the current time in that unit
  - advanceMillis
```
public SetTimeProvider advanceMillis(long millis)
```
    Advances the current time by the specified duration in milliseconds.
    
    Parameters:
    
    millis - duration to add, may be negative
    
    Returns:
    
    this instance for chaining
  - advanceMicros
```
public SetTimeProvider advanceMicros(long micros)
```
    Advances the current time by the specified duration in microseconds.
    
    Parameters:
    
    micros - duration to add, may be negative
    
    Returns:
    
    this instance for chaining
  - advanceNanos
```
public SetTimeProvider advanceNanos(long nanos)
```
    Advances the current time by the specified duration in nanoseconds.
    
    Parameters:
    
    nanos - duration to add, may be negative
    
    Returns:
    
    this instance for chaining
  - toString
```
public String toString()
```
    Provides a string representation of the provider state.
    
    Overrides:
    
    toString in class AtomicLong
    
    Returns:
    
    summary of auto-increment value and current time

Class SetTimeProvider

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Constructor Detail

SetTimeProvider

SetTimeProvider

SetTimeProvider

SetTimeProvider

Method Detail

now

autoIncrement

currentTimeMillis

currentTimeMillis

currentTimeMicros

currentTimeMicros

currentTimeNanos

currentTimeNanos

currentTime

advanceMillis

advanceMicros

advanceNanos

toString