Package org.infinispan.commons.time

Class DefaultTimeService

java.lang.Object

org.infinispan.commons.time.DefaultTimeService

All Implemented Interfaces:

TimeService

Direct Known Subclasses:

EmbeddedTimeService

public class DefaultTimeService
extends Object
implements TimeService

The default implementation of TimeService. It does not perform any optimization and relies on System.currentTimeMillis() and System.nanoTime().

Since:

5.3

Author:

Pedro Ruivo

Field Summary

Fields

Modifier and Type	Field	Description
static DefaultTimeService	INSTANCE

Constructor Summary

Constructors

Constructor	Description
DefaultTimeService()

Method Summary

Modifier and Type	Method	Description
long	expectedEndTime(long duration, TimeUnit inputTimeUnit)
Instant	instant()
boolean	isTimeExpired(long endTimeNanos)
long	remainingTime(long endTimeNanos, TimeUnit outputTimeUnit)
long	time()
long	timeDuration(long startTimeNanos, long endTimeNanos, TimeUnit outputTimeUnit)
long	timeDuration(long startTimeNanos, TimeUnit outputTimeUnit)	It is equivalent to timeDuration(startTime, time(), outputTimeUnit).
long	wallClockTime()

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final DefaultTimeService INSTANCE

Constructor Detail

DefaultTimeService

public DefaultTimeService()

Method Detail

wallClockTime

public long wallClockTime()

Specified by:

wallClockTime in interface TimeService

Returns:

the current clock time in milliseconds. Note that it depends of the system time.

time

public long time()

Specified by:

time in interface TimeService

Returns:

the current cpu time in nanoseconds. Note that some platforms do not provide nanosecond precision.

instant

public Instant instant()

Specified by:

instant in interface TimeService

Returns:

the current Instant. Similarly to TimeService.time(), note that some platforms do not provide nanosecond precision.

timeDuration

public long timeDuration(long startTimeNanos,
                         TimeUnit outputTimeUnit)

Description copied from interface: TimeService

It is equivalent to timeDuration(startTime, time(), outputTimeUnit).

Specified by:

timeDuration in interface TimeService

Parameters:

startTimeNanos - start cpu time in nanoseconds, usually returned by TimeService.time().

outputTimeUnit - the TimeUnit of the returned value.

Returns:

the duration between the current cpu time and startTime. It returns zero if startTime is less than zero or if startTime is greater than the current cpu time.

timeDuration

public long timeDuration(long startTimeNanos,
                         long endTimeNanos,
                         TimeUnit outputTimeUnit)

Specified by:

timeDuration in interface TimeService

Parameters:

startTimeNanos - start cpu time in nanoseconds, usually returned by TimeService.time().

endTimeNanos - end cpu time in nanoseconds, usually returned by TimeService.time().

outputTimeUnit - the TimeUnit of the returned value.

Returns:

the duration between the endTime and startTime. It returns zero if startTime or endTime are less than zero or if startTime is greater than the endTime.

isTimeExpired

public boolean isTimeExpired(long endTimeNanos)

Specified by:

isTimeExpired in interface TimeService

Parameters:

endTimeNanos - a cpu time in nanoseconds, usually returned by TimeService.time()

Returns:

true if the endTime is less or equals than the current cpu time.

remainingTime

public long remainingTime(long endTimeNanos,
                          TimeUnit outputTimeUnit)

Specified by:

remainingTime in interface TimeService

Parameters:

endTimeNanos - the end cpu time in nanoseconds.

outputTimeUnit - the TimeUnit of the returned value.

Returns:

the remaining cpu time until the endTime is reached.

expectedEndTime

public long expectedEndTime(long duration,
                            TimeUnit inputTimeUnit)

Specified by:

expectedEndTime in interface TimeService

Parameters:

duration - the duration.

inputTimeUnit - the TimeUnit of the duration.

Returns:

the expected end time in nano seconds. If duration is less or equals to zero, the current cpu time is returned (TimeService.time()).