org.apache.ratis.util

Class Timestamp

java.lang.Object

org.apache.ratis.util.Timestamp

All Implemented Interfaces:

Comparable<Timestamp>

public final class Timestamp
extends Object
implements Comparable<Timestamp>

Use System.nanoTime() as timestamps. This class takes care the possibility of numerical overflow. This is a value-based class.

Method Summary

Modifier and Type	Method and Description
Timestamp	addTime(TimeDuration t)
Timestamp	addTimeMs(long milliseconds)
int	compareTo(Timestamp that) Compare two timestamps, t0 (this) and t1 (that).
static Timestamp	currentTime()
static long	currentTimeNanos()
TimeDuration	elapsedTime()
long	elapsedTimeMs()
boolean	equals(Object obj)
int	hashCode()
static Timestamp	latest(Timestamp a, Timestamp b)
String	toString()
static Timestamp	valueOf(long nanos)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

valueOf

public static Timestamp valueOf(long nanos)

Returns:

a Timestamp for the given nanos.

currentTimeNanos

public static long currentTimeNanos()

Returns:

a long in nanos for the current time.

currentTime

public static Timestamp currentTime()

Returns:

a Timestamp for the current time.

latest

public static Timestamp latest(Timestamp a,
                               Timestamp b)

Returns:

the latest timestamp.

addTimeMs

public Timestamp addTimeMs(long milliseconds)

Parameters:

milliseconds - the time period to be added.

Returns:

a new Timestamp whose value is calculated by adding the given milliseconds to this timestamp.

addTime

public Timestamp addTime(TimeDuration t)

Parameters:

t - the time period to be added.

Returns:

a new Timestamp whose value is calculated by adding the given milliseconds to this timestamp.

elapsedTimeMs

public long elapsedTimeMs()

Returns:

the elapsed time in milliseconds. If the timestamp is a future time, the returned value is negative.

elapsedTime

public TimeDuration elapsedTime()

Returns:

the elapsed time in nanoseconds. If the timestamp is a future time, the returned value is negative.

compareTo

public int compareTo(Timestamp that)

Compare two timestamps, t0 (this) and t1 (that). This method uses t0 - t1 < 0, not t0 < t1, in order to take care the possibility of numerical overflow.

Specified by:

compareTo in interface Comparable<Timestamp>

See Also:

System.nanoTime()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object