io.opencensus.common

Class Timestamp

java.lang.Object

io.opencensus.common.Timestamp

All Implemented Interfaces:

Comparable<Timestamp>

@Immutable
public abstract class Timestamp
extends Object
implements Comparable<Timestamp>

A representation of an instant in time. The instant is the number of nanoseconds after the number of seconds since the Unix Epoch.

Use Tracing.getClock().now() to get the current timestamp since epoch (1970-01-01T00:00:00Z).

Method Summary

Modifier and Type	Method and Description
Timestamp	addDuration(Duration duration) Returns a Timestamp calculated as this Timestamp plus some Duration.
Timestamp	addNanos(long nanosToAdd) Returns a Timestamp calculated as this Timestamp plus some number of nanoseconds.
int	compareTo(Timestamp otherTimestamp) Compares this Timestamp to the specified Timestamp.
static Timestamp	create(long seconds, int nanos) Creates a new timestamp from given seconds and nanoseconds.
static Timestamp	fromMillis(long epochMilli) Creates a new timestamp from the given milliseconds.
abstract int	getNanos() Returns the number of nanoseconds after the number of seconds since the Unix Epoch represented by this timestamp.
abstract long	getSeconds() Returns the number of seconds since the Unix Epoch represented by this timestamp.
Duration	subtractTimestamp(Timestamp timestamp) Returns a Duration calculated as: this - timestamp.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Timestamp create(long seconds,
                               int nanos)

Creates a new timestamp from given seconds and nanoseconds.

Parameters:

seconds - Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

nanos - Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.

Returns:

new Timestamp with specified fields. For invalid inputs, a Timestamp of zero is returned.

fromMillis

public static Timestamp fromMillis(long epochMilli)

Creates a new timestamp from the given milliseconds.

Parameters:

epochMilli - the timestamp represented in milliseconds since epoch.

Returns:

new Timestamp with specified fields. For invalid inputs, a Timestamp of zero is returned.

getSeconds

public abstract long getSeconds()

Returns the number of seconds since the Unix Epoch represented by this timestamp.

Returns:

the number of seconds since the Unix Epoch.

getNanos

public abstract int getNanos()

Returns the number of nanoseconds after the number of seconds since the Unix Epoch represented by this timestamp.

Returns:

the number of nanoseconds after the number of seconds since the Unix Epoch.

addNanos

public Timestamp addNanos(long nanosToAdd)

Returns a Timestamp calculated as this Timestamp plus some number of nanoseconds.

Parameters:

nanosToAdd - the nanos to add, positive or negative.

Returns:

the calculated Timestamp. For invalid inputs, a Timestamp of zero is returned.

Throws:

ArithmeticException - if numeric overflow occurs.

addDuration

public Timestamp addDuration(Duration duration)

Returns a Timestamp calculated as this Timestamp plus some Duration.

Parameters:

duration - the Duration to add.

Returns:

a Timestamp with the specified Duration added.

subtractTimestamp

public Duration subtractTimestamp(Timestamp timestamp)

Returns a Duration calculated as: this - timestamp.

Parameters:

timestamp - the Timestamp to subtract.

Returns:

the calculated Duration. For invalid inputs, a Duration of zero is returned.

compareTo

public int compareTo(Timestamp otherTimestamp)

Compares this Timestamp to the specified Timestamp.

Specified by:

compareTo in interface Comparable<Timestamp>

Parameters:

otherTimestamp - the other Timestamp to compare to, not null.

Returns:

the comparator value: zero if equal, negative if this timestamp happens before otherTimestamp, positive if after.

Throws:

NullPointerException - if otherTimestamp is null.