Protocol Buffers [Util] 3.7.1 · com.google.protobuf.util.Timestamps

Field Summary

Modifier and Type	Field and Description
private static final Comparator<Timestamp>	COMPARATOR
public static final Timestamp	EPOCH A constant holding the `Timestamp` of epoch time, `1970-01-01T00:00:00.000000000Z`.
public static final Timestamp	MAX_VALUE A constant holding the maximum valid `Timestamp`, `9999-12-31T23:59:59.999999999Z`.
pack-priv static final long	MICROS_PER_SECOND
pack-priv static final long	MILLIS_PER_SECOND
public static final Timestamp	MIN_VALUE A constant holding the minimum valid `Timestamp`, `0001-01-01T00:00:00Z`.
pack-priv static final long	NANOS_PER_MICROSECOND
pack-priv static final long	NANOS_PER_MILLISECOND
pack-priv static final long	NANOS_PER_SECOND
pack-priv static final long	TIMESTAMP_SECONDS_MAX
pack-priv static final long	TIMESTAMP_SECONDS_MIN
private static final ThreadLocal<SimpleDateFormat>	timestampFormat

Constructor Summary

Access	Constructor and Description
private	Timestamps()

Method Summary

Modifier and Type	Method and Description
public static Timestamp	add(Timestamp start, Duration length) Add a duration to a timestamp.
public static Duration	between(Timestamp from, Timestamp to) Calculate the difference between two timestamps.
public static Timestamp	checkValid(Timestamp timestamp) Throws an `IllegalArgumentException` if the given `Timestamp` is not valid.
public static Timestamp	Returns: A valid, built `Timestamp`. checkValid(Timestamp.Builder timestampBuilder) Builds the given builder and throws an `IllegalArgumentException` if it is not valid.
public static Comparator<Timestamp>	comparator() Returns a `Comparator` for `Timestamp`s which sorts in increasing chronological order.
public static int	Returns: the value `0` if `x == y`; a value less than `0` if `x < y`; and a value greater than `0` if `x > y` compare(Timestamp x, Timestamp y) Compares two timestamps.
private static SimpleDateFormat	createTimestampFormat()
pack-priv static String	formatNanos(int nanos) Format the nano part of a timestamp or a duration.
public static Timestamp	fromMicros(long microseconds) Create a Timestamp from the number of microseconds elapsed from the epoch.
public static Timestamp	fromMillis(long milliseconds) Create a Timestamp from the number of milliseconds elapsed from the epoch.
public static Timestamp	fromNanos(long nanoseconds) Create a Timestamp from the number of nanoseconds elapsed from the epoch.
public static Timestamp	fromSeconds(long seconds) Create a Timestamp from the number of seconds elapsed from the epoch.
public static boolean	isValid(Timestamp timestamp) Returns true if the given `Timestamp` is valid.
public static boolean	isValid(long seconds, int nanos) Returns true if the given number of seconds and nanos is a valid `Timestamp`.
pack-priv static Timestamp	normalizedTimestamp(long seconds, int nanos)
public static Timestamp	Returns: A Timestamp parsed from the string. parse(String value) Parse from RFC 3339 date string to Timestamp.
pack-priv static int	parseNanos(String value)
private static long	parseTimezoneOffset(String value)
public static Timestamp	subtract(Timestamp start, Duration length) Subtract a duration from a timestamp.
public static long	toMicros(Timestamp timestamp) Convert a Timestamp to the number of microseconds elapsed from the epoch.
public static long	toMillis(Timestamp timestamp) Convert a Timestamp to the number of milliseconds elapsed from the epoch.
public static long	toNanos(Timestamp timestamp) Convert a Timestamp to the number of nanoseconds elapsed from the epoch.
public static long	toSeconds(Timestamp timestamp) Convert a Timestamp to the number of seconds elapsed from the epoch.
public static String	Returns: The string representation of the given timestamp. toString(Timestamp timestamp) Convert Timestamp to RFC 3339 date string format.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

COMPARATOR	back to summary
private static final Comparator<Timestamp> COMPARATOR

EPOCH	back to summary
public static final Timestamp EPOCH A constant holding the `Timestamp` of epoch time, `1970-01-01T00:00:00.000000000Z`.

MAX_VALUE	back to summary
public static final Timestamp MAX_VALUE A constant holding the maximum valid `Timestamp`, `9999-12-31T23:59:59.999999999Z`.

MICROS_PER_SECOND	back to summary
pack-priv static final long MICROS_PER_SECOND

MILLIS_PER_SECOND	back to summary
pack-priv static final long MILLIS_PER_SECOND

MIN_VALUE	back to summary
public static final Timestamp MIN_VALUE A constant holding the minimum valid `Timestamp`, `0001-01-01T00:00:00Z`.

NANOS_PER_MICROSECOND	back to summary
pack-priv static final long NANOS_PER_MICROSECOND

NANOS_PER_MILLISECOND	back to summary
pack-priv static final long NANOS_PER_MILLISECOND

NANOS_PER_SECOND	back to summary
pack-priv static final long NANOS_PER_SECOND

TIMESTAMP_SECONDS_MAX	back to summary
pack-priv static final long TIMESTAMP_SECONDS_MAX

TIMESTAMP_SECONDS_MIN	back to summary
pack-priv static final long TIMESTAMP_SECONDS_MIN

timestampFormat	back to summary
private static final ThreadLocal<SimpleDateFormat> timestampFormat

Constructor Detail

Timestamps	back to summary
private Timestamps()

Method Detail

add	back to summary
public static Timestamp add(Timestamp start, Duration length) Add a duration to a timestamp.

between	back to summary
public static Duration between(Timestamp from, Timestamp to) Calculate the difference between two timestamps.

checkValid back to summary

checkValid	back to summary
public static Timestamp checkValid(Timestamp timestamp) Throws an `IllegalArgumentException` if the given `Timestamp` is not valid. Annotations @CanIgnoreReturnValue

public static Timestamp checkValid(Timestamp timestamp)

Throws an IllegalArgumentException if the given Timestamp is not valid.

Annotations

@CanIgnoreReturnValue

checkValid back to summary

checkValid	back to summary
public static Timestamp checkValid(Timestamp.Builder timestampBuilder) Builds the given builder and throws an `IllegalArgumentException` if it is not valid. See `checkValid(Timestamp)`. Returns:Timestamp A valid, built `Timestamp`.

public static Timestamp checkValid(Timestamp.Builder timestampBuilder)

Builds the given builder and throws an IllegalArgumentException if it is not valid. See checkValid(Timestamp).

Returns:Timestamp: A valid, built Timestamp.

comparator	back to summary
public static Comparator<Timestamp> comparator() Returns a `Comparator` for `Timestamp`s which sorts in increasing chronological order. Nulls and invalid `Timestamp`s are not allowed (see `isValid`).

compare back to summary

compare	back to summary
public static int compare(Timestamp x, Timestamp y) Compares two timestamps. The value returned is identical to what would be returned by: `Timestamps.comparator().compare(x, y)`. Returns:int the value `0` if `x == y`; a value less than `0` if `x < y`; and a value greater than `0` if `x > y`

public static int compare(Timestamp x, Timestamp y)

Compares two timestamps. The value returned is identical to what would be returned by: Timestamps.comparator().compare(x, y).

Returns:int: the value 0 if x == y; a value less than 0 if x < y; and a value greater than 0 if x > y

createTimestampFormat	back to summary
private static SimpleDateFormat createTimestampFormat()

formatNanos	back to summary
pack-priv static String formatNanos(int nanos) Format the nano part of a timestamp or a duration.

fromMicros	back to summary
public static Timestamp fromMicros(long microseconds) Create a Timestamp from the number of microseconds elapsed from the epoch. Annotations @SuppressWarnings:GoodTime

fromMicros

back to summary

public static Timestamp fromMicros(long microseconds)

Create a Timestamp from the number of microseconds elapsed from the epoch.

Annotations

@SuppressWarnings:GoodTime

fromMillis	back to summary
public static Timestamp fromMillis(long milliseconds) Create a Timestamp from the number of milliseconds elapsed from the epoch. Annotations @SuppressWarnings:GoodTime

fromMillis

back to summary

public static Timestamp fromMillis(long milliseconds)

Create a Timestamp from the number of milliseconds elapsed from the epoch.

Annotations

@SuppressWarnings:GoodTime

fromNanos	back to summary
public static Timestamp fromNanos(long nanoseconds) Create a Timestamp from the number of nanoseconds elapsed from the epoch. Annotations @SuppressWarnings:GoodTime

fromNanos

back to summary

public static Timestamp fromNanos(long nanoseconds)

Create a Timestamp from the number of nanoseconds elapsed from the epoch.

Annotations

@SuppressWarnings:GoodTime

fromSeconds	back to summary
public static Timestamp fromSeconds(long seconds) Create a Timestamp from the number of seconds elapsed from the epoch. Annotations @SuppressWarnings:GoodTime

fromSeconds

back to summary

public static Timestamp fromSeconds(long seconds)

Create a Timestamp from the number of seconds elapsed from the epoch.

Annotations

@SuppressWarnings:GoodTime

isValid back to summary

isValid	back to summary
public static boolean isValid(Timestamp timestamp) Returns true if the given `Timestamp` is valid. The `seconds` value must be in the range [-62,135,596,800, +253,402,300,799] (i.e., between 0001-01-01T00:00:00Z and 9999-12-31T23:59:59Z). The `nanos` value must be in the range [0, +999,999,999]. Note Negative second values with fractional seconds must still have non-negative nanos values that count forward in time.

public static boolean isValid(Timestamp timestamp)

Returns true if the given Timestamp is valid. The seconds value must be in the range [-62,135,596,800, +253,402,300,799] (i.e., between 0001-01-01T00:00:00Z and 9999-12-31T23:59:59Z). The nanos value must be in the range [0, +999,999,999].

Note

Negative second values with fractional seconds must still have non-negative nanos values that count forward in time.

isValid back to summary

isValid	back to summary
public static boolean isValid(long seconds, int nanos) Returns true if the given number of seconds and nanos is a valid `Timestamp`. The `seconds` value must be in the range [-62,135,596,800, +253,402,300,799] (i.e., between 0001-01-01T00:00:00Z and 9999-12-31T23:59:59Z). The `nanos` value must be in the range [0, +999,999,999]. Note Negative second values with fractional seconds must still have non-negative nanos values that count forward in time. Annotations @SuppressWarnings:GoodTime

public static boolean isValid(long seconds, int nanos)

Returns true if the given number of seconds and nanos is a valid Timestamp. The seconds value must be in the range [-62,135,596,800, +253,402,300,799] (i.e., between 0001-01-01T00:00:00Z and 9999-12-31T23:59:59Z). The nanos value must be in the range [0, +999,999,999].

Note

Negative second values with fractional seconds must still have non-negative nanos values that count forward in time.

Annotations

@SuppressWarnings:GoodTime

normalizedTimestamp	back to summary
pack-priv static Timestamp normalizedTimestamp(long seconds, int nanos)

parse back to summary

parse	back to summary
public static Timestamp parse(String value) throws ParseException Parse from RFC 3339 date string to Timestamp. This method accepts all outputs of `toString(Timestamp)` and it also accepts any fractional digits (or none) and any offset as long as they fit into nano-seconds precision. Example of accepted format: "1972-01-01T10:00:20.021-05:00" Returns:Timestamp A Timestamp parsed from the string. Exceptions ParseException: if parsing fails.

public static Timestamp parse(String value) throws ParseException

Parse from RFC 3339 date string to Timestamp. This method accepts all outputs of toString(Timestamp) and it also accepts any fractional digits (or none) and any offset as long as they fit into nano-seconds precision.

Example of accepted format: "1972-01-01T10:00:20.021-05:00"

Returns:Timestamp

A Timestamp parsed from the string.

Exceptions

ParseException:: if parsing fails.

parseNanos	back to summary
pack-priv static int parseNanos(String value) throws ParseException

parseTimezoneOffset	back to summary
private static long parseTimezoneOffset(String value) throws ParseException

subtract	back to summary
public static Timestamp subtract(Timestamp start, Duration length) Subtract a duration from a timestamp.

toMicros	back to summary
public static long toMicros(Timestamp timestamp) Convert a Timestamp to the number of microseconds elapsed from the epoch. The result will be rounded down to the nearest microsecond. E.g., if the timestamp represents "1969-12-31T23:59:59.999999999Z", it will be rounded to -1 microsecond. Annotations @SuppressWarnings:GoodTime

toMicros

back to summary

public static long toMicros(Timestamp timestamp)

Convert a Timestamp to the number of microseconds elapsed from the epoch.

The result will be rounded down to the nearest microsecond. E.g., if the timestamp represents "1969-12-31T23:59:59.999999999Z", it will be rounded to -1 microsecond.

Annotations

@SuppressWarnings:GoodTime

toMillis	back to summary
public static long toMillis(Timestamp timestamp) Convert a Timestamp to the number of milliseconds elapsed from the epoch. The result will be rounded down to the nearest millisecond. E.g., if the timestamp represents "1969-12-31T23:59:59.999999999Z", it will be rounded to -1 millisecond. Annotations @SuppressWarnings:GoodTime

toMillis

back to summary

public static long toMillis(Timestamp timestamp)

Convert a Timestamp to the number of milliseconds elapsed from the epoch.

The result will be rounded down to the nearest millisecond. E.g., if the timestamp represents "1969-12-31T23:59:59.999999999Z", it will be rounded to -1 millisecond.

Annotations

@SuppressWarnings:GoodTime

toNanos	back to summary
public static long toNanos(Timestamp timestamp) Convert a Timestamp to the number of nanoseconds elapsed from the epoch. Annotations @SuppressWarnings:GoodTime

toNanos

back to summary

public static long toNanos(Timestamp timestamp)

Convert a Timestamp to the number of nanoseconds elapsed from the epoch.

Annotations

@SuppressWarnings:GoodTime

toSeconds	back to summary
public static long toSeconds(Timestamp timestamp) Convert a Timestamp to the number of seconds elapsed from the epoch. The result will be rounded down to the nearest second. E.g., if the timestamp represents "1969-12-31T23:59:59.999999999Z", it will be rounded to -1 second. Annotations @SuppressWarnings:GoodTime

toSeconds

back to summary

public static long toSeconds(Timestamp timestamp)

Convert a Timestamp to the number of seconds elapsed from the epoch.

The result will be rounded down to the nearest second. E.g., if the timestamp represents "1969-12-31T23:59:59.999999999Z", it will be rounded to -1 second.

Annotations

@SuppressWarnings:GoodTime

toString	back to summary
public static String toString(Timestamp timestamp) Convert Timestamp to RFC 3339 date string format. The output will always be Z-normalized and uses 3, 6 or 9 fractional digits as required to represent the exact value. Note that Timestamp can only represent time from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. See https://www.ietf.org/rfc/rfc3339.txt Example of generated format: "1972-01-01T10:00:20.021Z" Returns:String The string representation of the given timestamp. Exceptions IllegalArgumentException: if the given timestamp is not in the valid range.

toString

back to summary

public static String toString(Timestamp timestamp)

Convert Timestamp to RFC 3339 date string format. The output will always be Z-normalized and uses 3, 6 or 9 fractional digits as required to represent the exact value. Note that Timestamp can only represent time from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. See https://www.ietf.org/rfc/rfc3339.txt

Example of generated format: "1972-01-01T10:00:20.021Z"

Returns:String

The string representation of the given timestamp.

Exceptions

IllegalArgumentException:: if the given timestamp is not in the valid range.

public final Class Timestamps

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail