Module io.github.bucket4j.core

Package io.github.bucket4j

Interface TimeMeter

public interface TimeMeter

An abstraction over time measurement.

See Also:

• SYSTEM_NANOTIME
• SYSTEM_MILLISECONDS

Field Summary

Fields

Modifier and Type	Field	Description
static final TimeMeter	SYSTEM_MILLISECONDS	The implementation of TimeMeter which works around System.currentTimeMillis()
static final TimeMeter	SYSTEM_NANOTIME	The implementation of TimeMeter which works around System.nanoTime()

Method Summary

Modifier and Type	Method	Description
long	currentTimeNanos()	Returns current time in nanosecond precision, but not necessarily nanosecond resolution.
boolean	isWallClockBased()	Returns true if implementation of clock behaves the similar way as System.currentTimeMillis(), in other words if implementation can be used in distributed scenarios and returns approximately the same time in all machines in cluster

Field Details

SYSTEM_NANOTIME

static final TimeMeter SYSTEM_NANOTIME

The implementation of TimeMeter which works around System.nanoTime()

SYSTEM_MILLISECONDS

static final TimeMeter SYSTEM_MILLISECONDS

The implementation of TimeMeter which works around System.currentTimeMillis()

Method Details

currentTimeNanos

long currentTimeNanos()

Returns current time in nanosecond precision, but not necessarily nanosecond resolution.

Returns:

current time in nanoseconds

isWallClockBased

boolean isWallClockBased()

Returns true if implementation of clock behaves the similar way as System.currentTimeMillis(), in other words if implementation can be used in distributed scenarios and returns approximately the same time in all machines in cluster

Returns:

true if implementation can be used as wall clock