Package com.google.protobuf.util
Class Durations
- java.lang.Object
-
- com.google.protobuf.util.Durations
-
public final class Durations extends java.lang.ObjectUtilities to help create/manipulateprotobuf/duration.proto. All operations throw anIllegalArgumentExceptionif the input(s) are not valid.
-
-
Field Summary
Fields Modifier and Type Field Description static com.google.protobuf.DurationMAX_VALUEA constant holding the maximum validDuration, approximately+10,000years.static com.google.protobuf.DurationMIN_VALUEA constant holding the minimum validDuration, approximately-10,000years.static com.google.protobuf.DurationZEROA constant holding the duration of zero.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static com.google.protobuf.Durationadd(com.google.protobuf.Duration d1, com.google.protobuf.Duration d2)Add two durations.static com.google.protobuf.DurationcheckNotNegative(com.google.protobuf.Duration duration)Ensures that the givenDurationis not negative.static com.google.protobuf.DurationcheckPositive(com.google.protobuf.Duration duration)Ensures that the givenDurationis positive.static com.google.protobuf.DurationcheckValid(com.google.protobuf.Duration duration)Throws anIllegalArgumentExceptionif the givenDurationis not valid.static com.google.protobuf.DurationcheckValid(com.google.protobuf.Duration.Builder durationBuilder)Builds the given builder and throws anIllegalArgumentExceptionif it is not valid.static java.util.Comparator<com.google.protobuf.Duration>comparator()Returns aComparatorforDurations which sorts in increasing chronological order.static intcompare(com.google.protobuf.Duration x, com.google.protobuf.Duration y)Compares two durations.static com.google.protobuf.DurationfromDays(long days)Create a Duration from the number of days.static com.google.protobuf.DurationfromHours(long hours)Create a Duration from the number of hours.static com.google.protobuf.DurationfromMicros(long microseconds)Create a Duration from the number of microseconds.static com.google.protobuf.DurationfromMillis(long milliseconds)Create a Duration from the number of milliseconds.static com.google.protobuf.DurationfromMinutes(long minutes)Create a Duration from the number of minutes.static com.google.protobuf.DurationfromNanos(long nanoseconds)Create a Duration from the number of nanoseconds.static com.google.protobuf.DurationfromSeconds(long seconds)Create a Duration from the number of seconds.static booleanisNegative(com.google.protobuf.Duration duration)Returns whether the givenDurationis negative or not.static booleanisValid(long seconds, int nanos)Returns true if the given number of seconds and nanos is a validDuration.static booleanisValid(com.google.protobuf.Duration duration)Returns true if the givenDurationis valid.static com.google.protobuf.Durationparse(java.lang.String value)Parse from a string to produce a duration.static com.google.protobuf.Durationsubtract(com.google.protobuf.Duration d1, com.google.protobuf.Duration d2)Subtract a duration from another.static longtoDays(com.google.protobuf.Duration duration)Convert a Duration to the number of days.static longtoHours(com.google.protobuf.Duration duration)Convert a Duration to the number of hours.static longtoMicros(com.google.protobuf.Duration duration)Convert a Duration to the number of microseconds.static longtoMillis(com.google.protobuf.Duration duration)Convert a Duration to the number of milliseconds.static longtoMinutes(com.google.protobuf.Duration duration)Convert a Duration to the number of minutes.static longtoNanos(com.google.protobuf.Duration duration)Convert a Duration to the number of nanoseconds.static longtoSeconds(com.google.protobuf.Duration duration)Convert a Duration to the number of seconds.static doubletoSecondsAsDouble(com.google.protobuf.Duration duration)Returns the number of seconds of the given duration as adouble.static java.lang.StringtoString(com.google.protobuf.Duration duration)Convert Duration to string format.
-
-
-
Field Detail
-
MIN_VALUE
public static final com.google.protobuf.Duration MIN_VALUE
A constant holding the minimum validDuration, approximately-10,000years.
-
MAX_VALUE
public static final com.google.protobuf.Duration MAX_VALUE
A constant holding the maximum validDuration, approximately+10,000years.
-
ZERO
public static final com.google.protobuf.Duration ZERO
A constant holding the duration of zero.
-
-
Method Detail
-
comparator
public static java.util.Comparator<com.google.protobuf.Duration> comparator()
Returns aComparatorforDurations which sorts in increasing chronological order. Nulls and invalidDurations are not allowed (seeisValid(com.google.protobuf.Duration)).
-
compare
public static int compare(com.google.protobuf.Duration x, com.google.protobuf.Duration y)Compares two durations. The value returned is identical to what would be returned by:Durations.comparator().compare(x, y).- Returns:
- the value
0ifx == y; a value less than0ifx < y; and a value greater than0ifx > y
-
isValid
public static boolean isValid(com.google.protobuf.Duration duration)
Returns true if the givenDurationis valid. Thesecondsvalue must be in the range [-315,576,000,000, +315,576,000,000]. Thenanosvalue must be in the range [-999,999,999, +999,999,999].Note: Durations less than one second are represented with a 0
secondsfield and a positive or negativenanosfield. For durations of one second or more, a non-zero value for thenanosfield must be of the same sign as thesecondsfield.
-
isValid
public static boolean isValid(long seconds, int nanos)Returns true if the given number of seconds and nanos is a validDuration. Thesecondsvalue must be in the range [-315,576,000,000, +315,576,000,000]. Thenanosvalue must be in the range [-999,999,999, +999,999,999].Note: Durations less than one second are represented with a 0
secondsfield and a positive or negativenanosfield. For durations of one second or more, a non-zero value for thenanosfield must be of the same sign as thesecondsfield.
-
isNegative
public static boolean isNegative(com.google.protobuf.Duration duration)
Returns whether the givenDurationis negative or not.
-
checkNotNegative
@CanIgnoreReturnValue public static com.google.protobuf.Duration checkNotNegative(com.google.protobuf.Duration duration)
Ensures that the givenDurationis not negative.- Throws:
java.lang.IllegalArgumentException- ifdurationis negative or invalidjava.lang.NullPointerException- ifdurationisnull
-
checkPositive
@CanIgnoreReturnValue public static com.google.protobuf.Duration checkPositive(com.google.protobuf.Duration duration)
Ensures that the givenDurationis positive.- Throws:
java.lang.IllegalArgumentException- ifdurationis negative,ZERO, or invalidjava.lang.NullPointerException- ifdurationisnull
-
checkValid
@CanIgnoreReturnValue public static com.google.protobuf.Duration checkValid(com.google.protobuf.Duration duration)
Throws anIllegalArgumentExceptionif the givenDurationis not valid.
-
checkValid
public static com.google.protobuf.Duration checkValid(com.google.protobuf.Duration.Builder durationBuilder)
Builds the given builder and throws anIllegalArgumentExceptionif it is not valid. SeecheckValid(Duration).- Returns:
- A valid, built
Duration.
-
toString
public static java.lang.String toString(com.google.protobuf.Duration duration)
Convert Duration to string format. The string format will contains 3, 6, or 9 fractional digits depending on the precision required to represent the exact Duration value. For example: "1s", "1.010s", "1.000000100s", "-3.100s" The range that can be represented by Duration is from -315,576,000,000 to +315,576,000,000 inclusive (in seconds).- Returns:
- The string representation of the given duration.
- Throws:
java.lang.IllegalArgumentException- if the given duration is not in the valid range.
-
parse
public static com.google.protobuf.Duration parse(java.lang.String value) throws java.text.ParseExceptionParse from a string to produce a duration.- Returns:
- A Duration parsed from the string.
- Throws:
java.text.ParseException- if parsing fails.
-
fromDays
public static com.google.protobuf.Duration fromDays(long days)
Create a Duration from the number of days.
-
fromHours
public static com.google.protobuf.Duration fromHours(long hours)
Create a Duration from the number of hours.
-
fromMinutes
public static com.google.protobuf.Duration fromMinutes(long minutes)
Create a Duration from the number of minutes.
-
fromSeconds
public static com.google.protobuf.Duration fromSeconds(long seconds)
Create a Duration from the number of seconds.
-
fromMillis
public static com.google.protobuf.Duration fromMillis(long milliseconds)
Create a Duration from the number of milliseconds.
-
fromMicros
public static com.google.protobuf.Duration fromMicros(long microseconds)
Create a Duration from the number of microseconds.
-
fromNanos
public static com.google.protobuf.Duration fromNanos(long nanoseconds)
Create a Duration from the number of nanoseconds.
-
toDays
public static long toDays(com.google.protobuf.Duration duration)
Convert a Duration to the number of days. The result will be rounded towards 0 to the nearest day.
-
toHours
public static long toHours(com.google.protobuf.Duration duration)
Convert a Duration to the number of hours. The result will be rounded towards 0 to the nearest hour.
-
toMinutes
public static long toMinutes(com.google.protobuf.Duration duration)
Convert a Duration to the number of minutes. The result will be rounded towards 0 to the nearest minute.
-
toSeconds
public static long toSeconds(com.google.protobuf.Duration duration)
Convert a Duration to the number of seconds. The result will be rounded towards 0 to the nearest second. E.g., if the duration represents -1 nanosecond, it will be rounded to 0.
-
toSecondsAsDouble
public static double toSecondsAsDouble(com.google.protobuf.Duration duration)
Returns the number of seconds of the given duration as adouble. This method should be used to accommodate APIs that only accept durations asdoublevalues.This conversion may lose precision.
If you need the number of seconds in this duration as a
long(not adouble), simply useduration.getSeconds()ortoSeconds(com.google.protobuf.Duration)(which includes validation).
-
toMillis
public static long toMillis(com.google.protobuf.Duration duration)
Convert a Duration to the number of milliseconds. The result will be rounded towards 0 to the nearest millisecond. E.g., if the duration represents -1 nanosecond, it will be rounded to 0.
-
toMicros
public static long toMicros(com.google.protobuf.Duration duration)
Convert a Duration to the number of microseconds. The result will be rounded towards 0 to the nearest microseconds. E.g., if the duration represents -1 nanosecond, it will be rounded to 0.
-
toNanos
public static long toNanos(com.google.protobuf.Duration duration)
Convert a Duration to the number of nanoseconds.
-
add
public static com.google.protobuf.Duration add(com.google.protobuf.Duration d1, com.google.protobuf.Duration d2)Add two durations.
-
subtract
public static com.google.protobuf.Duration subtract(com.google.protobuf.Duration d1, com.google.protobuf.Duration d2)Subtract a duration from another.
-
-