1 /*
2 * Copyright (c) 2012, 2023, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 /*
27 * This file is available under and governed by the GNU General Public
28 * License version 2 only, as published by the Free Software Foundation.
29 * However, the following notice accompanied the original version of this
30 * file:
31 *
32 * Copyright (c) 2007-2012, Stephen Colebourne & Michael Nascimento Santos
33 *
34 * All rights reserved.
35 *
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions are met:
38 *
39 * * Redistributions of source code must retain the above copyright notice,
40 * this list of conditions and the following disclaimer.
41 *
42 * * Redistributions in binary form must reproduce the above copyright notice,
43 * this list of conditions and the following disclaimer in the documentation
44 * and/or other materials provided with the distribution.
45 *
46 * * Neither the name of JSR-310 nor the names of its contributors
47 * may be used to endorse or promote products derived from this software
48 * without specific prior written permission.
49 *
50 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
51 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
52 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
53 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
54 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
55 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
56 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
57 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
58 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
59 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
60 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
61 */
62 package java.time;
63
64 import static java.time.LocalTime.MINUTES_PER_HOUR;
65 import static java.time.LocalTime.NANOS_PER_MILLI;
66 import static java.time.LocalTime.NANOS_PER_SECOND;
67 import static java.time.LocalTime.SECONDS_PER_DAY;
68 import static java.time.LocalTime.SECONDS_PER_HOUR;
69 import static java.time.LocalTime.SECONDS_PER_MINUTE;
70 import static java.time.temporal.ChronoField.NANO_OF_SECOND;
71 import static java.time.temporal.ChronoUnit.DAYS;
72 import static java.time.temporal.ChronoUnit.NANOS;
73 import static java.time.temporal.ChronoUnit.SECONDS;
74
75 import java.io.DataInput;
76 import java.io.DataOutput;
77 import java.io.IOException;
78 import java.io.InvalidObjectException;
79 import java.io.ObjectInputStream;
80 import java.io.Serializable;
81 import java.math.BigDecimal;
82 import java.math.BigInteger;
83 import java.math.RoundingMode;
84 import java.time.format.DateTimeParseException;
85 import java.time.temporal.ChronoField;
86 import java.time.temporal.ChronoUnit;
87 import java.time.temporal.Temporal;
88 import java.time.temporal.TemporalAmount;
89 import java.time.temporal.TemporalUnit;
90 import java.time.temporal.UnsupportedTemporalTypeException;
91 import java.util.List;
92 import java.util.Objects;
93 import java.util.regex.Matcher;
94 import java.util.regex.Pattern;
95
96 /**
97 * A time-based amount of time, such as '34.5 seconds'.
98 * <p>
99 * This class models a quantity or amount of time in terms of seconds and nanoseconds.
100 * It can be accessed using other duration-based units, such as minutes and hours.
101 * In addition, the {@link ChronoUnit#DAYS DAYS} unit can be used and is treated as
102 * exactly equal to 24 hours, thus ignoring daylight savings effects.
103 * See {@link Period} for the date-based equivalent to this class.
104 * <p>
105 * A physical duration could be of infinite length.
106 * For practicality, the duration is stored with constraints similar to {@link Instant}.
107 * The duration uses nanosecond resolution with a maximum value of the seconds that can
108 * be held in a {@code long}. This is greater than the current estimated age of the universe.
109 * <p>
110 * The range of a duration requires the storage of a number larger than a {@code long}.
111 * To achieve this, the class stores a {@code long} representing seconds and an {@code int}
112 * representing nanosecond-of-second, which will always be between 0 and 999,999,999.
113 * The model is of a directed duration, meaning that the duration may be negative.
114 * <p>
115 * The duration is measured in "seconds", but these are not necessarily identical to
116 * the scientific "SI second" definition based on atomic clocks.
117 * This difference only impacts durations measured near a leap-second and should not affect
118 * most applications.
119 * See {@link Instant} for a discussion as to the meaning of the second and time-scales.
120 * <p>
121 * This is a <a href="{@docRoot}/java.base/java/lang/doc-files/ValueBased.html">value-based</a>
122 * class; programmers should treat instances that are
123 * {@linkplain #equals(Object) equal} as interchangeable and should not
124 * use instances for synchronization, or unpredictable behavior may
125 * occur. For example, in a future release, synchronization may fail.
126 * The {@code equals} method should be used for comparisons.
127 *
128 * @implSpec
129 * This class is immutable and thread-safe.
130 *
131 * @since 1.8
132 */
133 @jdk.internal.ValueBased
134 public final class Duration
135 implements TemporalAmount, Comparable<Duration>, Serializable {
136
137 /**
138 * Constant for a duration of zero.
139 */
140 public static final Duration ZERO = new Duration(0, 0);
141 /**
142 * Serialization version.
143 */
144 @java.io.Serial
145 private static final long serialVersionUID = 3078945930695997490L;
146 /**
147 * Constant for nanos per second.
148 */
149 private static final BigInteger BI_NANOS_PER_SECOND = BigInteger.valueOf(NANOS_PER_SECOND);
150 /**
151 * The pattern for parsing.
152 */
153 private static class Lazy {
154 static final Pattern PATTERN =
155 Pattern.compile("([-+]?)P(?:([-+]?[0-9]+)D)?" +
156 "(T(?:([-+]?[0-9]+)H)?(?:([-+]?[0-9]+)M)?(?:([-+]?[0-9]+)(?:[.,]([0-9]{0,9}))?S)?)?",
157 Pattern.CASE_INSENSITIVE);
158 }
159
160 /**
161 * The number of seconds in the duration.
162 */
163 private final long seconds;
164 /**
165 * The number of nanoseconds in the duration, expressed as a fraction of the
166 * number of seconds. This is always positive, and never exceeds 999,999,999.
167 */
168 private final int nanos;
169
170 //-----------------------------------------------------------------------
171 /**
172 * Obtains a {@code Duration} representing a number of standard 24 hour days.
173 * <p>
174 * The seconds are calculated based on the standard definition of a day,
175 * where each day is 86400 seconds which implies a 24 hour day.
176 * The nanosecond in second field is set to zero.
177 *
178 * @param days the number of days, positive or negative
179 * @return a {@code Duration}, not null
180 * @throws ArithmeticException if the input days exceeds the capacity of {@code Duration}
181 */
182 public static Duration ofDays(long days) {
183 return create(Math.multiplyExact(days, SECONDS_PER_DAY), 0);
184 }
185
186 /**
187 * Obtains a {@code Duration} representing a number of standard hours.
188 * <p>
189 * The seconds are calculated based on the standard definition of an hour,
190 * where each hour is 3600 seconds.
191 * The nanosecond in second field is set to zero.
192 *
193 * @param hours the number of hours, positive or negative
194 * @return a {@code Duration}, not null
195 * @throws ArithmeticException if the input hours exceeds the capacity of {@code Duration}
196 */
197 public static Duration ofHours(long hours) {
198 return create(Math.multiplyExact(hours, SECONDS_PER_HOUR), 0);
199 }
200
201 /**
202 * Obtains a {@code Duration} representing a number of standard minutes.
203 * <p>
204 * The seconds are calculated based on the standard definition of a minute,
205 * where each minute is 60 seconds.
206 * The nanosecond in second field is set to zero.
207 *
208 * @param minutes the number of minutes, positive or negative
209 * @return a {@code Duration}, not null
210 * @throws ArithmeticException if the input minutes exceeds the capacity of {@code Duration}
211 */
212 public static Duration ofMinutes(long minutes) {
213 return create(Math.multiplyExact(minutes, SECONDS_PER_MINUTE), 0);
214 }
215
216 //-----------------------------------------------------------------------
217 /**
218 * Obtains a {@code Duration} representing a number of seconds.
219 * <p>
220 * The nanosecond in second field is set to zero.
221 *
222 * @param seconds the number of seconds, positive or negative
223 * @return a {@code Duration}, not null
224 */
225 public static Duration ofSeconds(long seconds) {
226 return create(seconds, 0);
227 }
228
229 /**
230 * Obtains a {@code Duration} representing a number of seconds and an
231 * adjustment in nanoseconds.
232 * <p>
233 * This method allows an arbitrary number of nanoseconds to be passed in.
234 * The factory will alter the values of the second and nanosecond in order
235 * to ensure that the stored nanosecond is in the range 0 to 999,999,999.
236 * For example, the following will result in exactly the same duration:
237 * <pre>
238 * Duration.ofSeconds(3, 1);
239 * Duration.ofSeconds(4, -999_999_999);
240 * Duration.ofSeconds(2, 1000_000_001);
241 * </pre>
242 *
243 * @param seconds the number of seconds, positive or negative
244 * @param nanoAdjustment the nanosecond adjustment to the number of seconds, positive or negative
245 * @return a {@code Duration}, not null
246 * @throws ArithmeticException if the adjustment causes the seconds to exceed the capacity of {@code Duration}
247 */
248 public static Duration ofSeconds(long seconds, long nanoAdjustment) {
249 long secs = Math.addExact(seconds, Math.floorDiv(nanoAdjustment, NANOS_PER_SECOND));
250 int nos = (int) Math.floorMod(nanoAdjustment, NANOS_PER_SECOND);
251 return create(secs, nos);
252 }
253
254 //-----------------------------------------------------------------------
255 /**
256 * Obtains a {@code Duration} representing a number of milliseconds.
257 * <p>
258 * The seconds and nanoseconds are extracted from the specified milliseconds.
259 *
260 * @param millis the number of milliseconds, positive or negative
261 * @return a {@code Duration}, not null
262 */
263 public static Duration ofMillis(long millis) {
264 long secs = millis / 1000;
265 int mos = (int) (millis % 1000);
266 if (mos < 0) {
267 mos += 1000;
268 secs--;
269 }
270 return create(secs, mos * 1000_000);
271 }
272
273 //-----------------------------------------------------------------------
274 /**
275 * Obtains a {@code Duration} representing a number of nanoseconds.
276 * <p>
277 * The seconds and nanoseconds are extracted from the specified nanoseconds.
278 *
279 * @param nanos the number of nanoseconds, positive or negative
280 * @return a {@code Duration}, not null
281 */
282 public static Duration ofNanos(long nanos) {
283 long secs = nanos / NANOS_PER_SECOND;
284 int nos = (int) (nanos % NANOS_PER_SECOND);
285 if (nos < 0) {
286 nos += (int) NANOS_PER_SECOND;
287 secs--;
288 }
289 return create(secs, nos);
290 }
291
292 //-----------------------------------------------------------------------
293 /**
294 * Obtains a {@code Duration} representing an amount in the specified unit.
295 * <p>
296 * The parameters represent the two parts of a phrase like '6 Hours'. For example:
297 * <pre>
298 * Duration.of(3, SECONDS);
299 * Duration.of(465, HOURS);
300 * </pre>
301 * Only a subset of units are accepted by this method.
302 * The unit must either have an {@linkplain TemporalUnit#isDurationEstimated() exact duration} or
303 * be {@link ChronoUnit#DAYS} which is treated as 24 hours. Other units throw an exception.
304 *
305 * @param amount the amount of the duration, measured in terms of the unit, positive or negative
306 * @param unit the unit that the duration is measured in, must have an exact duration, not null
307 * @return a {@code Duration}, not null
308 * @throws DateTimeException if the unit has an estimated duration
309 * @throws ArithmeticException if a numeric overflow occurs
310 */
311 public static Duration of(long amount, TemporalUnit unit) {
312 return ZERO.plus(amount, unit);
313 }
314
315 //-----------------------------------------------------------------------
316 /**
317 * Obtains an instance of {@code Duration} from a temporal amount.
318 * <p>
319 * This obtains a duration based on the specified amount.
320 * A {@code TemporalAmount} represents an amount of time, which may be
321 * date-based or time-based, which this factory extracts to a duration.
322 * <p>
323 * The conversion loops around the set of units from the amount and uses
324 * the {@linkplain TemporalUnit#getDuration() duration} of the unit to
325 * calculate the total {@code Duration}.
326 * Only a subset of units are accepted by this method. The unit must either
327 * have an {@linkplain TemporalUnit#isDurationEstimated() exact duration}
328 * or be {@link ChronoUnit#DAYS} which is treated as 24 hours.
329 * If any other units are found then an exception is thrown.
330 *
331 * @param amount the temporal amount to convert, not null
332 * @return the equivalent duration, not null
333 * @throws DateTimeException if unable to convert to a {@code Duration}
334 * @throws ArithmeticException if numeric overflow occurs
335 */
336 public static Duration from(TemporalAmount amount) {
337 Objects.requireNonNull(amount, "amount");
338 Duration duration = ZERO;
339 for (TemporalUnit unit : amount.getUnits()) {
340 duration = duration.plus(amount.get(unit), unit);
341 }
342 return duration;
343 }
344
345 //-----------------------------------------------------------------------
346 /**
347 * Obtains a {@code Duration} from a text string such as {@code PnDTnHnMn.nS}.
348 * <p>
349 * This will parse a textual representation of a duration, including the
350 * string produced by {@code toString()}. The formats accepted are based
351 * on the ISO-8601 duration format {@code PnDTnHnMn.nS} with days
352 * considered to be exactly 24 hours.
353 * <p>
354 * The string starts with an optional sign, denoted by the ASCII negative
355 * or positive symbol. If negative, the whole duration is negated.
356 * The ASCII letter "P" is next in upper or lower case.
357 * There are then four sections, each consisting of a number and a suffix.
358 * The sections have suffixes in ASCII of "D", "H", "M" and "S" for
359 * days, hours, minutes and seconds, accepted in upper or lower case.
360 * The suffixes must occur in order. The ASCII letter "T" must occur before
361 * the first occurrence, if any, of an hour, minute or second section.
362 * At least one of the four sections must be present, and if "T" is present
363 * there must be at least one section after the "T".
364 * The number part of each section must consist of one or more ASCII digits.
365 * The number may be prefixed by the ASCII negative or positive symbol.
366 * The number of days, hours and minutes must parse to a {@code long}.
367 * The number of seconds must parse to a {@code long} with optional fraction.
368 * The decimal point may be either a dot or a comma.
369 * The fractional part may have from zero to 9 digits.
370 * <p>
371 * The leading plus/minus sign, and negative values for other units are
372 * not part of the ISO-8601 standard.
373 * <p>
374 * Examples:
375 * <pre>
376 * "PT20.345S" -- parses as "20.345 seconds"
377 * "PT15M" -- parses as "15 minutes" (where a minute is 60 seconds)
378 * "PT10H" -- parses as "10 hours" (where an hour is 3600 seconds)
379 * "P2D" -- parses as "2 days" (where a day is 24 hours or 86400 seconds)
380 * "P2DT3H4M" -- parses as "2 days, 3 hours and 4 minutes"
381 * "PT-6H3M" -- parses as "-6 hours and +3 minutes"
382 * "-PT6H3M" -- parses as "-6 hours and -3 minutes"
383 * "-PT-6H+3M" -- parses as "+6 hours and -3 minutes"
384 * </pre>
385 *
386 * @param text the text to parse, not null
387 * @return the parsed duration, not null
388 * @throws DateTimeParseException if the text cannot be parsed to a duration
389 */
390 public static Duration parse(CharSequence text) {
391 Objects.requireNonNull(text, "text");
392 Matcher matcher = Lazy.PATTERN.matcher(text);
393 if (matcher.matches()) {
394 // check for letter T but no time sections
395 if (!charMatch(text, matcher.start(3), matcher.end(3), 'T')) {
396 boolean negate = charMatch(text, matcher.start(1), matcher.end(1), '-');
397
398 int dayStart = matcher.start(2), dayEnd = matcher.end(2);
399 int hourStart = matcher.start(4), hourEnd = matcher.end(4);
400 int minuteStart = matcher.start(5), minuteEnd = matcher.end(5);
401 int secondStart = matcher.start(6), secondEnd = matcher.end(6);
402 int fractionStart = matcher.start(7), fractionEnd = matcher.end(7);
403
404 if (dayStart >= 0 || hourStart >= 0 || minuteStart >= 0 || secondStart >= 0) {
405 long daysAsSecs = parseNumber(text, dayStart, dayEnd, SECONDS_PER_DAY, "days");
406 long hoursAsSecs = parseNumber(text, hourStart, hourEnd, SECONDS_PER_HOUR, "hours");
407 long minsAsSecs = parseNumber(text, minuteStart, minuteEnd, SECONDS_PER_MINUTE, "minutes");
408 long seconds = parseNumber(text, secondStart, secondEnd, 1, "seconds");
409 boolean negativeSecs = secondStart >= 0 && text.charAt(secondStart) == '-';
410 int nanos = parseFraction(text, fractionStart, fractionEnd, negativeSecs ? -1 : 1);
411 try {
412 return create(negate, daysAsSecs, hoursAsSecs, minsAsSecs, seconds, nanos);
413 } catch (ArithmeticException ex) {
414 throw new DateTimeParseException("Text cannot be parsed to a Duration: overflow", text, 0, ex);
415 }
416 }
417 }
418 }
419 throw new DateTimeParseException("Text cannot be parsed to a Duration", text, 0);
420 }
421
422 private static boolean charMatch(CharSequence text, int start, int end, char c) {
423 return (start >= 0 && end == start + 1 && text.charAt(start) == c);
424 }
425
426 private static long parseNumber(CharSequence text, int start, int end, int multiplier, String errorText) {
427 // regex limits to [-+]?[0-9]+
428 if (start < 0 || end < 0) {
429 return 0;
430 }
431 try {
432 long val = Long.parseLong(text, start, end, 10);
433 return Math.multiplyExact(val, multiplier);
434 } catch (NumberFormatException | ArithmeticException ex) {
435 throw new DateTimeParseException("Text cannot be parsed to a Duration: " + errorText, text, 0, ex);
436 }
437 }
438
439 private static int parseFraction(CharSequence text, int start, int end, int negate) {
440 // regex limits to [0-9]{0,9}
441 if (start < 0 || end < 0 || end - start == 0) {
442 return 0;
443 }
444 try {
445 int fraction = Integer.parseInt(text, start, end, 10);
446
447 // for number strings smaller than 9 digits, interpret as if there
448 // were trailing zeros
449 for (int i = end - start; i < 9; i++) {
450 fraction *= 10;
451 }
452 return fraction * negate;
453 } catch (NumberFormatException | ArithmeticException ex) {
454 throw new DateTimeParseException("Text cannot be parsed to a Duration: fraction", text, 0, ex);
455 }
456 }
457
458 private static Duration create(boolean negate, long daysAsSecs, long hoursAsSecs, long minsAsSecs, long secs, int nanos) {
459 long seconds = Math.addExact(daysAsSecs, Math.addExact(hoursAsSecs, Math.addExact(minsAsSecs, secs)));
460 if (negate) {
461 return ofSeconds(seconds, nanos).negated();
462 }
463 return ofSeconds(seconds, nanos);
464 }
465
466 //-----------------------------------------------------------------------
467 /**
468 * Obtains a {@code Duration} representing the duration between two temporal objects.
469 * <p>
470 * This calculates the duration between two temporal objects. If the objects
471 * are of different types, then the duration is calculated based on the type
472 * of the first object. For example, if the first argument is a {@code LocalTime}
473 * then the second argument is converted to a {@code LocalTime}.
474 * <p>
475 * The specified temporal objects must support the {@link ChronoUnit#SECONDS SECONDS} unit.
476 * For full accuracy, either the {@link ChronoUnit#NANOS NANOS} unit or the
477 * {@link ChronoField#NANO_OF_SECOND NANO_OF_SECOND} field should be supported.
478 * <p>
479 * The result of this method can be a negative duration if the end is before the start.
480 * To guarantee to obtain a positive duration call {@link #abs()} on the result.
481 *
482 * @param startInclusive the start instant, inclusive, not null
483 * @param endExclusive the end instant, exclusive, not null
484 * @return a {@code Duration}, not null
485 * @throws DateTimeException if the seconds between the temporals cannot be obtained
486 * @throws ArithmeticException if the calculation exceeds the capacity of {@code Duration}
487 */
488 public static Duration between(Temporal startInclusive, Temporal endExclusive) {
489 long secs = startInclusive.until(endExclusive, SECONDS);
490 if (secs == 0) {
491 // We don't know which Temporal is earlier, so the adjustment below would not work.
492 // But we do know that there's no danger of until(NANOS) overflowing in that case.
493 return ofNanos(startInclusive.until(endExclusive, NANOS));
494 }
495 long nanos;
496 try {
497 nanos = endExclusive.getLong(NANO_OF_SECOND) - startInclusive.getLong(NANO_OF_SECOND);
498 } catch (DateTimeException ex2) {
499 nanos = 0;
500 }
501 if (nanos < 0 && secs > 0) {
502 // ofSeconds will subtract one even though until(SECONDS) already gave the correct
503 // number of seconds. So compensate. Similarly for the secs < 0 case below.
504 secs++;
505 } else if (nanos > 0 && secs < 0) {
506 secs--;
507 }
508 return ofSeconds(secs, nanos);
509 }
510
511 //-----------------------------------------------------------------------
512 /**
513 * Obtains an instance of {@code Duration} using seconds and nanoseconds.
514 *
515 * @param seconds the length of the duration in seconds, positive or negative
516 * @param nanoAdjustment the nanosecond adjustment within the second, from 0 to 999,999,999
517 */
518 private static Duration create(long seconds, int nanoAdjustment) {
519 if ((seconds | nanoAdjustment) == 0) {
520 return ZERO;
521 }
522 return new Duration(seconds, nanoAdjustment);
523 }
524
525 /**
526 * Constructs an instance of {@code Duration} using seconds and nanoseconds.
527 *
528 * @param seconds the length of the duration in seconds, positive or negative
529 * @param nanos the nanoseconds within the second, from 0 to 999,999,999
530 */
531 private Duration(long seconds, int nanos) {
532 this.seconds = seconds;
533 this.nanos = nanos;
534 }
535
536 //-----------------------------------------------------------------------
537 /**
538 * Gets the value of the requested unit.
539 * <p>
540 * This returns a value for each of the two supported units,
541 * {@link ChronoUnit#SECONDS SECONDS} and {@link ChronoUnit#NANOS NANOS}.
542 * All other units throw an exception.
543 *
544 * @param unit the {@code TemporalUnit} for which to return the value
545 * @return the long value of the unit
546 * @throws DateTimeException if the unit is not supported
547 * @throws UnsupportedTemporalTypeException if the unit is not supported
548 */
549 @Override
550 public long get(TemporalUnit unit) {
551 if (unit == SECONDS) {
552 return seconds;
553 } else if (unit == NANOS) {
554 return nanos;
555 } else {
556 throw new UnsupportedTemporalTypeException("Unsupported unit: " + unit);
557 }
558 }
559
560 /**
561 * Gets the set of units supported by this duration.
562 * <p>
563 * The supported units are {@link ChronoUnit#SECONDS SECONDS},
564 * and {@link ChronoUnit#NANOS NANOS}.
565 * They are returned in the order seconds, nanos.
566 * <p>
567 * This set can be used in conjunction with {@link #get(TemporalUnit)}
568 * to access the entire state of the duration.
569 *
570 * @return a list containing the seconds and nanos units, not null
571 */
572 @Override
573 public List<TemporalUnit> getUnits() {
574 return DurationUnits.UNITS;
575 }
576
577 /**
578 * Private class to delay initialization of this list until needed.
579 * The circular dependency between Duration and ChronoUnit prevents
580 * the simple initialization in Duration.
581 */
582 private static class DurationUnits {
583 static final List<TemporalUnit> UNITS = List.of(SECONDS, NANOS);
584 }
585
586 //-----------------------------------------------------------------------
587 /**
588 * Checks if this duration is positive, excluding zero.
589 * <p>
590 * A {@code Duration} represents a directed distance between two points on
591 * the time-line and can therefore be positive, zero or negative.
592 * This method checks whether the length is greater than zero.
593 *
594 * @return true if this duration has a total length greater than zero
595 * @since 18
596 */
597 public boolean isPositive() {
598 return (seconds | nanos) > 0;
599 }
600
601 /**
602 * Checks if this duration is zero length.
603 * <p>
604 * A {@code Duration} represents a directed distance between two points on
605 * the time-line and can therefore be positive, zero or negative.
606 * This method checks whether the length is zero.
607 *
608 * @return true if this duration has a total length equal to zero
609 */
610 public boolean isZero() {
611 return (seconds | nanos) == 0;
612 }
613
614 /**
615 * Checks if this duration is negative, excluding zero.
616 * <p>
617 * A {@code Duration} represents a directed distance between two points on
618 * the time-line and can therefore be positive, zero or negative.
619 * This method checks whether the length is less than zero.
620 *
621 * @return true if this duration has a total length less than zero
622 */
623 public boolean isNegative() {
624 return seconds < 0;
625 }
626
627 //-----------------------------------------------------------------------
628 /**
629 * Gets the number of seconds in this duration.
630 * <p>
631 * The length of the duration is stored using two fields - seconds and nanoseconds.
632 * The nanoseconds part is a value from 0 to 999,999,999 that is an adjustment to
633 * the length in seconds.
634 * The total duration is defined by calling this method and {@link #getNano()}.
635 * <p>
636 * A {@code Duration} represents a directed distance between two points on the time-line.
637 * A negative duration is expressed by the negative sign of the seconds part.
638 * A duration of -1 nanosecond is stored as -1 seconds plus 999,999,999 nanoseconds.
639 *
640 * @return the whole seconds part of the length of the duration, positive or negative
641 */
642 public long getSeconds() {
643 return seconds;
644 }
645
646 /**
647 * Gets the number of nanoseconds within the second in this duration.
648 * <p>
649 * The length of the duration is stored using two fields - seconds and nanoseconds.
650 * The nanoseconds part is a value from 0 to 999,999,999 that is an adjustment to
651 * the length in seconds.
652 * The total duration is defined by calling this method and {@link #getSeconds()}.
653 * <p>
654 * A {@code Duration} represents a directed distance between two points on the time-line.
655 * A negative duration is expressed by the negative sign of the seconds part.
656 * A duration of -1 nanosecond is stored as -1 seconds plus 999,999,999 nanoseconds.
657 *
658 * @return the nanoseconds within the second part of the length of the duration, from 0 to 999,999,999
659 */
660 public int getNano() {
661 return nanos;
662 }
663
664 //-----------------------------------------------------------------------
665 /**
666 * Returns a copy of this duration with the specified amount of seconds.
667 * <p>
668 * This returns a duration with the specified seconds, retaining the
669 * nano-of-second part of this duration.
670 * <p>
671 * This instance is immutable and unaffected by this method call.
672 *
673 * @param seconds the seconds to represent, may be negative
674 * @return a {@code Duration} based on this duration with the requested seconds, not null
675 */
676 public Duration withSeconds(long seconds) {
677 return create(seconds, nanos);
678 }
679
680 /**
681 * Returns a copy of this duration with the specified nano-of-second.
682 * <p>
683 * This returns a duration with the specified nano-of-second, retaining the
684 * seconds part of this duration.
685 * <p>
686 * This instance is immutable and unaffected by this method call.
687 *
688 * @param nanoOfSecond the nano-of-second to represent, from 0 to 999,999,999
689 * @return a {@code Duration} based on this duration with the requested nano-of-second, not null
690 * @throws DateTimeException if the nano-of-second is invalid
691 */
692 public Duration withNanos(int nanoOfSecond) {
693 NANO_OF_SECOND.checkValidIntValue(nanoOfSecond);
694 return create(seconds, nanoOfSecond);
695 }
696
697 //-----------------------------------------------------------------------
698 /**
699 * Returns a copy of this duration with the specified duration added.
700 * <p>
701 * This instance is immutable and unaffected by this method call.
702 *
703 * @param duration the duration to add, positive or negative, not null
704 * @return a {@code Duration} based on this duration with the specified duration added, not null
705 * @throws ArithmeticException if numeric overflow occurs
706 */
707 public Duration plus(Duration duration) {
708 return plus(duration.getSeconds(), duration.getNano());
709 }
710
711 /**
712 * Returns a copy of this duration with the specified duration added.
713 * <p>
714 * The duration amount is measured in terms of the specified unit.
715 * Only a subset of units are accepted by this method.
716 * The unit must either have an {@linkplain TemporalUnit#isDurationEstimated() exact duration} or
717 * be {@link ChronoUnit#DAYS} which is treated as 24 hours. Other units throw an exception.
718 * <p>
719 * This instance is immutable and unaffected by this method call.
720 *
721 * @param amountToAdd the amount to add, measured in terms of the unit, positive or negative
722 * @param unit the unit that the amount is measured in, must have an exact duration, not null
723 * @return a {@code Duration} based on this duration with the specified duration added, not null
724 * @throws UnsupportedTemporalTypeException if the unit is not supported
725 * @throws ArithmeticException if numeric overflow occurs
726 */
727 public Duration plus(long amountToAdd, TemporalUnit unit) {
728 Objects.requireNonNull(unit, "unit");
729 if (unit == DAYS) {
730 return plus(Math.multiplyExact(amountToAdd, SECONDS_PER_DAY), 0);
731 }
732 if (unit.isDurationEstimated()) {
733 throw new UnsupportedTemporalTypeException("Unit must not have an estimated duration");
734 }
735 if (amountToAdd == 0) {
736 return this;
737 }
738 if (unit instanceof ChronoUnit chronoUnit) {
739 return switch (chronoUnit) {
740 case NANOS -> plusNanos(amountToAdd);
741 case MICROS -> plusSeconds((amountToAdd / (1000_000L * 1000)) * 1000).plusNanos((amountToAdd % (1000_000L * 1000)) * 1000);
742 case MILLIS -> plusMillis(amountToAdd);
743 case SECONDS -> plusSeconds(amountToAdd);
744 default -> plusSeconds(Math.multiplyExact(unit.getDuration().seconds, amountToAdd));
745 };
746 }
747 Duration duration = unit.getDuration().multipliedBy(amountToAdd);
748 return plusSeconds(duration.getSeconds()).plusNanos(duration.getNano());
749 }
750
751 //-----------------------------------------------------------------------
752 /**
753 * Returns a copy of this duration with the specified duration in standard 24 hour days added.
754 * <p>
755 * The number of days is multiplied by 86400 to obtain the number of seconds to add.
756 * This is based on the standard definition of a day as 24 hours.
757 * <p>
758 * This instance is immutable and unaffected by this method call.
759 *
760 * @param daysToAdd the days to add, positive or negative
761 * @return a {@code Duration} based on this duration with the specified days added, not null
762 * @throws ArithmeticException if numeric overflow occurs
763 */
764 public Duration plusDays(long daysToAdd) {
765 return plus(Math.multiplyExact(daysToAdd, SECONDS_PER_DAY), 0);
766 }
767
768 /**
769 * Returns a copy of this duration with the specified duration in hours added.
770 * <p>
771 * This instance is immutable and unaffected by this method call.
772 *
773 * @param hoursToAdd the hours to add, positive or negative
774 * @return a {@code Duration} based on this duration with the specified hours added, not null
775 * @throws ArithmeticException if numeric overflow occurs
776 */
777 public Duration plusHours(long hoursToAdd) {
778 return plus(Math.multiplyExact(hoursToAdd, SECONDS_PER_HOUR), 0);
779 }
780
781 /**
782 * Returns a copy of this duration with the specified duration in minutes added.
783 * <p>
784 * This instance is immutable and unaffected by this method call.
785 *
786 * @param minutesToAdd the minutes to add, positive or negative
787 * @return a {@code Duration} based on this duration with the specified minutes added, not null
788 * @throws ArithmeticException if numeric overflow occurs
789 */
790 public Duration plusMinutes(long minutesToAdd) {
791 return plus(Math.multiplyExact(minutesToAdd, SECONDS_PER_MINUTE), 0);
792 }
793
794 /**
795 * Returns a copy of this duration with the specified duration in seconds added.
796 * <p>
797 * This instance is immutable and unaffected by this method call.
798 *
799 * @param secondsToAdd the seconds to add, positive or negative
800 * @return a {@code Duration} based on this duration with the specified seconds added, not null
801 * @throws ArithmeticException if numeric overflow occurs
802 */
803 public Duration plusSeconds(long secondsToAdd) {
804 return plus(secondsToAdd, 0);
805 }
806
807 /**
808 * Returns a copy of this duration with the specified duration in milliseconds added.
809 * <p>
810 * This instance is immutable and unaffected by this method call.
811 *
812 * @param millisToAdd the milliseconds to add, positive or negative
813 * @return a {@code Duration} based on this duration with the specified milliseconds added, not null
814 * @throws ArithmeticException if numeric overflow occurs
815 */
816 public Duration plusMillis(long millisToAdd) {
817 return plus(millisToAdd / 1000, (millisToAdd % 1000) * 1000_000);
818 }
819
820 /**
821 * Returns a copy of this duration with the specified duration in nanoseconds added.
822 * <p>
823 * This instance is immutable and unaffected by this method call.
824 *
825 * @param nanosToAdd the nanoseconds to add, positive or negative
826 * @return a {@code Duration} based on this duration with the specified nanoseconds added, not null
827 * @throws ArithmeticException if numeric overflow occurs
828 */
829 public Duration plusNanos(long nanosToAdd) {
830 return plus(0, nanosToAdd);
831 }
832
833 /**
834 * Returns a copy of this duration with the specified duration added.
835 * <p>
836 * This instance is immutable and unaffected by this method call.
837 *
838 * @param secondsToAdd the seconds to add, positive or negative
839 * @param nanosToAdd the nanos to add, positive or negative
840 * @return a {@code Duration} based on this duration with the specified seconds added, not null
841 * @throws ArithmeticException if numeric overflow occurs
842 */
843 private Duration plus(long secondsToAdd, long nanosToAdd) {
844 if ((secondsToAdd | nanosToAdd) == 0) {
845 return this;
846 }
847 long epochSec = Math.addExact(seconds, secondsToAdd);
848 epochSec = Math.addExact(epochSec, nanosToAdd / NANOS_PER_SECOND);
849 nanosToAdd = nanosToAdd % NANOS_PER_SECOND;
850 long nanoAdjustment = nanos + nanosToAdd; // safe int+NANOS_PER_SECOND
851 return ofSeconds(epochSec, nanoAdjustment);
852 }
853
854 //-----------------------------------------------------------------------
855 /**
856 * Returns a copy of this duration with the specified duration subtracted.
857 * <p>
858 * This instance is immutable and unaffected by this method call.
859 *
860 * @param duration the duration to subtract, positive or negative, not null
861 * @return a {@code Duration} based on this duration with the specified duration subtracted, not null
862 * @throws ArithmeticException if numeric overflow occurs
863 */
864 public Duration minus(Duration duration) {
865 long secsToSubtract = duration.getSeconds();
866 int nanosToSubtract = duration.getNano();
867 if (secsToSubtract == Long.MIN_VALUE) {
868 return plus(Long.MAX_VALUE, -nanosToSubtract).plus(1, 0);
869 }
870 return plus(-secsToSubtract, -nanosToSubtract);
871 }
872
873 /**
874 * Returns a copy of this duration with the specified duration subtracted.
875 * <p>
876 * The duration amount is measured in terms of the specified unit.
877 * Only a subset of units are accepted by this method.
878 * The unit must either have an {@linkplain TemporalUnit#isDurationEstimated() exact duration} or
879 * be {@link ChronoUnit#DAYS} which is treated as 24 hours. Other units throw an exception.
880 * <p>
881 * This instance is immutable and unaffected by this method call.
882 *
883 * @param amountToSubtract the amount to subtract, measured in terms of the unit, positive or negative
884 * @param unit the unit that the amount is measured in, must have an exact duration, not null
885 * @return a {@code Duration} based on this duration with the specified duration subtracted, not null
886 * @throws ArithmeticException if numeric overflow occurs
887 */
888 public Duration minus(long amountToSubtract, TemporalUnit unit) {
889 return (amountToSubtract == Long.MIN_VALUE ? plus(Long.MAX_VALUE, unit).plus(1, unit) : plus(-amountToSubtract, unit));
890 }
891
892 //-----------------------------------------------------------------------
893 /**
894 * Returns a copy of this duration with the specified duration in standard 24 hour days subtracted.
895 * <p>
896 * The number of days is multiplied by 86400 to obtain the number of seconds to subtract.
897 * This is based on the standard definition of a day as 24 hours.
898 * <p>
899 * This instance is immutable and unaffected by this method call.
900 *
901 * @param daysToSubtract the days to subtract, positive or negative
902 * @return a {@code Duration} based on this duration with the specified days subtracted, not null
903 * @throws ArithmeticException if numeric overflow occurs
904 */
905 public Duration minusDays(long daysToSubtract) {
906 return (daysToSubtract == Long.MIN_VALUE ? plusDays(Long.MAX_VALUE).plusDays(1) : plusDays(-daysToSubtract));
907 }
908
909 /**
910 * Returns a copy of this duration with the specified duration in hours subtracted.
911 * <p>
912 * The number of hours is multiplied by 3600 to obtain the number of seconds to subtract.
913 * <p>
914 * This instance is immutable and unaffected by this method call.
915 *
916 * @param hoursToSubtract the hours to subtract, positive or negative
917 * @return a {@code Duration} based on this duration with the specified hours subtracted, not null
918 * @throws ArithmeticException if numeric overflow occurs
919 */
920 public Duration minusHours(long hoursToSubtract) {
921 return (hoursToSubtract == Long.MIN_VALUE ? plusHours(Long.MAX_VALUE).plusHours(1) : plusHours(-hoursToSubtract));
922 }
923
924 /**
925 * Returns a copy of this duration with the specified duration in minutes subtracted.
926 * <p>
927 * The number of hours is multiplied by 60 to obtain the number of seconds to subtract.
928 * <p>
929 * This instance is immutable and unaffected by this method call.
930 *
931 * @param minutesToSubtract the minutes to subtract, positive or negative
932 * @return a {@code Duration} based on this duration with the specified minutes subtracted, not null
933 * @throws ArithmeticException if numeric overflow occurs
934 */
935 public Duration minusMinutes(long minutesToSubtract) {
936 return (minutesToSubtract == Long.MIN_VALUE ? plusMinutes(Long.MAX_VALUE).plusMinutes(1) : plusMinutes(-minutesToSubtract));
937 }
938
939 /**
940 * Returns a copy of this duration with the specified duration in seconds subtracted.
941 * <p>
942 * This instance is immutable and unaffected by this method call.
943 *
944 * @param secondsToSubtract the seconds to subtract, positive or negative
945 * @return a {@code Duration} based on this duration with the specified seconds subtracted, not null
946 * @throws ArithmeticException if numeric overflow occurs
947 */
948 public Duration minusSeconds(long secondsToSubtract) {
949 return (secondsToSubtract == Long.MIN_VALUE ? plusSeconds(Long.MAX_VALUE).plusSeconds(1) : plusSeconds(-secondsToSubtract));
950 }
951
952 /**
953 * Returns a copy of this duration with the specified duration in milliseconds subtracted.
954 * <p>
955 * This instance is immutable and unaffected by this method call.
956 *
957 * @param millisToSubtract the milliseconds to subtract, positive or negative
958 * @return a {@code Duration} based on this duration with the specified milliseconds subtracted, not null
959 * @throws ArithmeticException if numeric overflow occurs
960 */
961 public Duration minusMillis(long millisToSubtract) {
962 return (millisToSubtract == Long.MIN_VALUE ? plusMillis(Long.MAX_VALUE).plusMillis(1) : plusMillis(-millisToSubtract));
963 }
964
965 /**
966 * Returns a copy of this duration with the specified duration in nanoseconds subtracted.
967 * <p>
968 * This instance is immutable and unaffected by this method call.
969 *
970 * @param nanosToSubtract the nanoseconds to subtract, positive or negative
971 * @return a {@code Duration} based on this duration with the specified nanoseconds subtracted, not null
972 * @throws ArithmeticException if numeric overflow occurs
973 */
974 public Duration minusNanos(long nanosToSubtract) {
975 return (nanosToSubtract == Long.MIN_VALUE ? plusNanos(Long.MAX_VALUE).plusNanos(1) : plusNanos(-nanosToSubtract));
976 }
977
978 //-----------------------------------------------------------------------
979 /**
980 * Returns a copy of this duration multiplied by the scalar.
981 * <p>
982 * This instance is immutable and unaffected by this method call.
983 *
984 * @param multiplicand the value to multiply the duration by, positive or negative
985 * @return a {@code Duration} based on this duration multiplied by the specified scalar, not null
986 * @throws ArithmeticException if numeric overflow occurs
987 */
988 public Duration multipliedBy(long multiplicand) {
989 if (multiplicand == 0) {
990 return ZERO;
991 }
992 if (multiplicand == 1) {
993 return this;
994 }
995 return create(toBigDecimalSeconds().multiply(BigDecimal.valueOf(multiplicand)));
996 }
997
998 /**
999 * Returns a copy of this duration divided by the specified value.
1000 * <p>
1001 * This instance is immutable and unaffected by this method call.
1002 *
1003 * @param divisor the value to divide the duration by, positive or negative, not zero
1004 * @return a {@code Duration} based on this duration divided by the specified divisor, not null
1005 * @throws ArithmeticException if the divisor is zero or if numeric overflow occurs
1006 */
1007 public Duration dividedBy(long divisor) {
1008 if (divisor == 0) {
1009 throw new ArithmeticException("Cannot divide by zero");
1010 }
1011 if (divisor == 1) {
1012 return this;
1013 }
1014 return create(toBigDecimalSeconds().divide(BigDecimal.valueOf(divisor), RoundingMode.DOWN));
1015 }
1016
1017 /**
1018 * Returns number of whole times a specified Duration occurs within this Duration.
1019 * <p>
1020 * This instance is immutable and unaffected by this method call.
1021 *
1022 * @param divisor the value to divide the duration by, positive or negative, not null
1023 * @return number of whole times, rounded toward zero, a specified
1024 * {@code Duration} occurs within this Duration, may be negative
1025 * @throws ArithmeticException if the divisor is zero, or if numeric overflow occurs
1026 * @since 9
1027 */
1028 public long dividedBy(Duration divisor) {
1029 Objects.requireNonNull(divisor, "divisor");
1030 BigDecimal dividendBigD = toBigDecimalSeconds();
1031 BigDecimal divisorBigD = divisor.toBigDecimalSeconds();
1032 return dividendBigD.divideToIntegralValue(divisorBigD).longValueExact();
1033 }
1034
1035 /**
1036 * Converts this duration to the total length in seconds and
1037 * fractional nanoseconds expressed as a {@code BigDecimal}.
1038 *
1039 * @return the total length of the duration in seconds, with a scale of 9, not null
1040 */
1041 private BigDecimal toBigDecimalSeconds() {
1042 return BigDecimal.valueOf(seconds).add(BigDecimal.valueOf(nanos, 9));
1043 }
1044
1045 /**
1046 * Creates an instance of {@code Duration} from a number of seconds.
1047 *
1048 * @param seconds the number of seconds, up to scale 9, positive or negative
1049 * @return a {@code Duration}, not null
1050 * @throws ArithmeticException if numeric overflow occurs
1051 */
1052 private static Duration create(BigDecimal seconds) {
1053 BigInteger nanos = seconds.movePointRight(9).toBigIntegerExact();
1054 BigInteger[] divRem = nanos.divideAndRemainder(BI_NANOS_PER_SECOND);
1055 if (divRem[0].bitLength() > 63) {
1056 throw new ArithmeticException("Exceeds capacity of Duration: " + nanos);
1057 }
1058 return ofSeconds(divRem[0].longValue(), divRem[1].intValue());
1059 }
1060
1061 //-----------------------------------------------------------------------
1062 /**
1063 * Returns a copy of this duration with the length negated.
1064 * <p>
1065 * This method swaps the sign of the total length of this duration.
1066 * For example, {@code PT1.3S} will be returned as {@code PT-1.3S}.
1067 * <p>
1068 * This instance is immutable and unaffected by this method call.
1069 *
1070 * @return a {@code Duration} based on this duration with the amount negated, not null
1071 * @throws ArithmeticException if numeric overflow occurs
1072 */
1073 public Duration negated() {
1074 return multipliedBy(-1);
1075 }
1076
1077 /**
1078 * Returns a copy of this duration with a positive length.
1079 * <p>
1080 * This method returns a positive duration by effectively removing the sign from any negative total length.
1081 * For example, {@code PT-1.3S} will be returned as {@code PT1.3S}.
1082 * <p>
1083 * This instance is immutable and unaffected by this method call.
1084 *
1085 * @return a {@code Duration} based on this duration with an absolute length, not null
1086 * @throws ArithmeticException if numeric overflow occurs
1087 */
1088 public Duration abs() {
1089 return isNegative() ? negated() : this;
1090 }
1091
1092 //-------------------------------------------------------------------------
1093 /**
1094 * Adds this duration to the specified temporal object.
1095 * <p>
1096 * This returns a temporal object of the same observable type as the input
1097 * with this duration added.
1098 * <p>
1099 * In most cases, it is clearer to reverse the calling pattern by using
1100 * {@link Temporal#plus(TemporalAmount)}.
1101 * <pre>
1102 * // these two lines are equivalent, but the second approach is recommended
1103 * dateTime = thisDuration.addTo(dateTime);
1104 * dateTime = dateTime.plus(thisDuration);
1105 * </pre>
1106 * <p>
1107 * The calculation will add the seconds, then nanos.
1108 * Only non-zero amounts will be added.
1109 * <p>
1110 * This instance is immutable and unaffected by this method call.
1111 *
1112 * @param temporal the temporal object to adjust, not null
1113 * @return an object of the same type with the adjustment made, not null
1114 * @throws DateTimeException if unable to add
1115 * @throws ArithmeticException if numeric overflow occurs
1116 */
1117 @Override
1118 public Temporal addTo(Temporal temporal) {
1119 if (seconds != 0) {
1120 temporal = temporal.plus(seconds, SECONDS);
1121 }
1122 if (nanos != 0) {
1123 temporal = temporal.plus(nanos, NANOS);
1124 }
1125 return temporal;
1126 }
1127
1128 /**
1129 * Subtracts this duration from the specified temporal object.
1130 * <p>
1131 * This returns a temporal object of the same observable type as the input
1132 * with this duration subtracted.
1133 * <p>
1134 * In most cases, it is clearer to reverse the calling pattern by using
1135 * {@link Temporal#minus(TemporalAmount)}.
1136 * <pre>
1137 * // these two lines are equivalent, but the second approach is recommended
1138 * dateTime = thisDuration.subtractFrom(dateTime);
1139 * dateTime = dateTime.minus(thisDuration);
1140 * </pre>
1141 * <p>
1142 * The calculation will subtract the seconds, then nanos.
1143 * Only non-zero amounts will be added.
1144 * <p>
1145 * This instance is immutable and unaffected by this method call.
1146 *
1147 * @param temporal the temporal object to adjust, not null
1148 * @return an object of the same type with the adjustment made, not null
1149 * @throws DateTimeException if unable to subtract
1150 * @throws ArithmeticException if numeric overflow occurs
1151 */
1152 @Override
1153 public Temporal subtractFrom(Temporal temporal) {
1154 if (seconds != 0) {
1155 temporal = temporal.minus(seconds, SECONDS);
1156 }
1157 if (nanos != 0) {
1158 temporal = temporal.minus(nanos, NANOS);
1159 }
1160 return temporal;
1161 }
1162
1163 //-----------------------------------------------------------------------
1164 /**
1165 * Gets the number of days in this duration.
1166 * <p>
1167 * This returns the total number of days in the duration by dividing the
1168 * number of seconds by 86400.
1169 * This is based on the standard definition of a day as 24 hours.
1170 * <p>
1171 * This instance is immutable and unaffected by this method call.
1172 *
1173 * @return the number of days in the duration, may be negative
1174 */
1175 public long toDays() {
1176 return seconds / SECONDS_PER_DAY;
1177 }
1178
1179 /**
1180 * Gets the number of hours in this duration.
1181 * <p>
1182 * This returns the total number of hours in the duration by dividing the
1183 * number of seconds by 3600.
1184 * <p>
1185 * This instance is immutable and unaffected by this method call.
1186 *
1187 * @return the number of hours in the duration, may be negative
1188 */
1189 public long toHours() {
1190 return seconds / SECONDS_PER_HOUR;
1191 }
1192
1193 /**
1194 * Gets the number of minutes in this duration.
1195 * <p>
1196 * This returns the total number of minutes in the duration by dividing the
1197 * number of seconds by 60.
1198 * <p>
1199 * This instance is immutable and unaffected by this method call.
1200 *
1201 * @return the number of minutes in the duration, may be negative
1202 */
1203 public long toMinutes() {
1204 return seconds / SECONDS_PER_MINUTE;
1205 }
1206
1207 /**
1208 * Gets the number of seconds in this duration.
1209 * <p>
1210 * This returns the total number of whole seconds in the duration.
1211 * <p>
1212 * This instance is immutable and unaffected by this method call.
1213 *
1214 * @return the whole seconds part of the length of the duration, positive or negative
1215 * @since 9
1216 */
1217 public long toSeconds() {
1218 return seconds;
1219 }
1220
1221 /**
1222 * Converts this duration to the total length in milliseconds.
1223 * <p>
1224 * If this duration is too large to fit in a {@code long} milliseconds, then an
1225 * exception is thrown.
1226 * <p>
1227 * If this duration has greater than millisecond precision, then the conversion
1228 * will drop any excess precision information as though the amount in nanoseconds
1229 * was subject to integer division by one million.
1230 *
1231 * @return the total length of the duration in milliseconds
1232 * @throws ArithmeticException if numeric overflow occurs
1233 */
1234 public long toMillis() {
1235 long tempSeconds = seconds;
1236 long tempNanos = nanos;
1237 if (tempSeconds < 0) {
1238 // change the seconds and nano value to
1239 // handle Long.MIN_VALUE case
1240 tempSeconds = tempSeconds + 1;
1241 tempNanos = tempNanos - NANOS_PER_SECOND;
1242 }
1243 long millis = Math.multiplyExact(tempSeconds, 1000);
1244 millis = Math.addExact(millis, tempNanos / NANOS_PER_MILLI);
1245 return millis;
1246 }
1247
1248 /**
1249 * Converts this duration to the total length in nanoseconds expressed as a {@code long}.
1250 * <p>
1251 * If this duration is too large to fit in a {@code long} nanoseconds, then an
1252 * exception is thrown.
1253 *
1254 * @return the total length of the duration in nanoseconds
1255 * @throws ArithmeticException if numeric overflow occurs
1256 */
1257 public long toNanos() {
1258 long tempSeconds = seconds;
1259 long tempNanos = nanos;
1260 if (tempSeconds < 0) {
1261 // change the seconds and nano value to
1262 // handle Long.MIN_VALUE case
1263 tempSeconds = tempSeconds + 1;
1264 tempNanos = tempNanos - NANOS_PER_SECOND;
1265 }
1266 long totalNanos = Math.multiplyExact(tempSeconds, NANOS_PER_SECOND);
1267 totalNanos = Math.addExact(totalNanos, tempNanos);
1268 return totalNanos;
1269 }
1270
1271 /**
1272 * Extracts the number of days in the duration.
1273 * <p>
1274 * This returns the total number of days in the duration by dividing the
1275 * number of seconds by 86400.
1276 * This is based on the standard definition of a day as 24 hours.
1277 * <p>
1278 * This instance is immutable and unaffected by this method call.
1279 * @apiNote
1280 * This method behaves exactly the same way as {@link #toDays()}.
1281 *
1282 * @return the number of days in the duration, may be negative
1283 * @since 9
1284 */
1285 public long toDaysPart(){
1286 return seconds / SECONDS_PER_DAY;
1287 }
1288
1289 /**
1290 * Extracts the number of hours part in the duration.
1291 * <p>
1292 * This returns the number of remaining hours when dividing {@link #toHours}
1293 * by hours in a day.
1294 * This is based on the standard definition of a day as 24 hours.
1295 * <p>
1296 * This instance is immutable and unaffected by this method call.
1297 *
1298 * @return the number of hours part in the duration, may be negative
1299 * @since 9
1300 */
1301 public int toHoursPart(){
1302 return (int) (toHours() % 24);
1303 }
1304
1305 /**
1306 * Extracts the number of minutes part in the duration.
1307 * <p>
1308 * This returns the number of remaining minutes when dividing {@link #toMinutes}
1309 * by minutes in an hour.
1310 * This is based on the standard definition of an hour as 60 minutes.
1311 * <p>
1312 * This instance is immutable and unaffected by this method call.
1313 *
1314 * @return the number of minutes parts in the duration, may be negative
1315 * @since 9
1316 */
1317 public int toMinutesPart(){
1318 return (int) (toMinutes() % MINUTES_PER_HOUR);
1319 }
1320
1321 /**
1322 * Extracts the number of seconds part in the duration.
1323 * <p>
1324 * This returns the remaining seconds when dividing {@link #toSeconds}
1325 * by seconds in a minute.
1326 * This is based on the standard definition of a minute as 60 seconds.
1327 * <p>
1328 * This instance is immutable and unaffected by this method call.
1329 *
1330 * @return the number of seconds parts in the duration, may be negative
1331 * @since 9
1332 */
1333 public int toSecondsPart(){
1334 return (int) (seconds % SECONDS_PER_MINUTE);
1335 }
1336
1337 /**
1338 * Extracts the number of milliseconds part of the duration.
1339 * <p>
1340 * This returns the milliseconds part by dividing the number of nanoseconds by 1,000,000.
1341 * The length of the duration is stored using two fields - seconds and nanoseconds.
1342 * The nanoseconds part is a value from 0 to 999,999,999 that is an adjustment to
1343 * the length in seconds.
1344 * The total duration is defined by calling {@link #getNano()} and {@link #getSeconds()}.
1345 * <p>
1346 * This instance is immutable and unaffected by this method call.
1347 *
1348 * @return the number of milliseconds part of the duration.
1349 * @since 9
1350 */
1351 public int toMillisPart(){
1352 return nanos / 1000_000;
1353 }
1354
1355 /**
1356 * Get the nanoseconds part within seconds of the duration.
1357 * <p>
1358 * The length of the duration is stored using two fields - seconds and nanoseconds.
1359 * The nanoseconds part is a value from 0 to 999,999,999 that is an adjustment to
1360 * the length in seconds.
1361 * The total duration is defined by calling {@link #getNano()} and {@link #getSeconds()}.
1362 * <p>
1363 * This instance is immutable and unaffected by this method call.
1364 *
1365 * @return the nanoseconds within the second part of the length of the duration, from 0 to 999,999,999
1366 * @since 9
1367 */
1368 public int toNanosPart(){
1369 return nanos;
1370 }
1371
1372
1373 //-----------------------------------------------------------------------
1374 /**
1375 * Returns a copy of this {@code Duration} truncated to the specified unit.
1376 * <p>
1377 * Truncating the duration returns a copy of the original with conceptual fields
1378 * smaller than the specified unit set to zero.
1379 * For example, truncating with the {@link ChronoUnit#MINUTES MINUTES} unit will
1380 * round down towards zero to the nearest minute, setting the seconds and
1381 * nanoseconds to zero.
1382 * <p>
1383 * The unit must have a {@linkplain TemporalUnit#getDuration() duration}
1384 * that divides into the length of a standard day without remainder.
1385 * This includes all
1386 * {@linkplain ChronoUnit#isTimeBased() time-based units on {@code ChronoUnit}}
1387 * and {@link ChronoUnit#DAYS DAYS}. Other ChronoUnits throw an exception.
1388 * <p>
1389 * This instance is immutable and unaffected by this method call.
1390 *
1391 * @param unit the unit to truncate to, not null
1392 * @return a {@code Duration} based on this duration with the time truncated, not null
1393 * @throws DateTimeException if the unit is invalid for truncation
1394 * @throws UnsupportedTemporalTypeException if the unit is not supported
1395 * @since 9
1396 */
1397 public Duration truncatedTo(TemporalUnit unit) {
1398 Objects.requireNonNull(unit, "unit");
1399 if (unit == ChronoUnit.SECONDS && (seconds >= 0 || nanos == 0)) {
1400 return new Duration(seconds, 0);
1401 } else if (unit == ChronoUnit.NANOS) {
1402 return this;
1403 }
1404 Duration unitDur = unit.getDuration();
1405 if (unitDur.getSeconds() > LocalTime.SECONDS_PER_DAY) {
1406 throw new UnsupportedTemporalTypeException("Unit is too large to be used for truncation");
1407 }
1408 long dur = unitDur.toNanos();
1409 if ((LocalTime.NANOS_PER_DAY % dur) != 0) {
1410 throw new UnsupportedTemporalTypeException("Unit must divide into a standard day without remainder");
1411 }
1412 long nod = (seconds % LocalTime.SECONDS_PER_DAY) * LocalTime.NANOS_PER_SECOND + nanos;
1413 long result = (nod / dur) * dur;
1414 return plusNanos(result - nod);
1415 }
1416
1417 //-----------------------------------------------------------------------
1418 /**
1419 * Compares this duration to the specified {@code Duration}.
1420 * <p>
1421 * The comparison is based on the total length of the durations.
1422 * It is "consistent with equals", as defined by {@link Comparable}.
1423 *
1424 * @param otherDuration the other duration to compare to, not null
1425 * @return the comparator value, that is less than zero if this duration is less than {@code otherDuration},
1426 * zero if they are equal, greater than zero if this duration is greater than {@code otherDuration}
1427 */
1428 @Override
1429 public int compareTo(Duration otherDuration) {
1430 int cmp = Long.compare(seconds, otherDuration.seconds);
1431 if (cmp != 0) {
1432 return cmp;
1433 }
1434 return nanos - otherDuration.nanos;
1435 }
1436
1437 //-----------------------------------------------------------------------
1438 /**
1439 * Checks if this duration is equal to the specified {@code Duration}.
1440 * <p>
1441 * The comparison is based on the total length of the durations.
1442 *
1443 * @param other the other duration, null returns false
1444 * @return true if the other duration is equal to this one
1445 */
1446 @Override
1447 public boolean equals(Object other) {
1448 if (this == other) {
1449 return true;
1450 }
1451 return (other instanceof Duration otherDuration)
1452 && this.seconds == otherDuration.seconds
1453 && this.nanos == otherDuration.nanos;
1454 }
1455
1456 /**
1457 * A hash code for this duration.
1458 *
1459 * @return a suitable hash code
1460 */
1461 @Override
1462 public int hashCode() {
1463 return ((int) (seconds ^ (seconds >>> 32))) + (51 * nanos);
1464 }
1465
1466 //-----------------------------------------------------------------------
1467 /**
1468 * A string representation of this duration using ISO-8601 seconds
1469 * based representation, such as {@code PT8H6M12.345S}.
1470 * <p>
1471 * The format of the returned string will be {@code PTnHnMnS}, where n is
1472 * the relevant hours, minutes or seconds part of the duration.
1473 * Any fractional seconds are placed after a decimal point in the seconds section.
1474 * If a section has a zero value, it is omitted.
1475 * The hours, minutes and seconds will all have the same sign.
1476 * <p>
1477 * Examples:
1478 * <pre>
1479 * "20.345 seconds" -- "PT20.345S
1480 * "15 minutes" (15 * 60 seconds) -- "PT15M"
1481 * "10 hours" (10 * 3600 seconds) -- "PT10H"
1482 * "2 days" (2 * 86400 seconds) -- "PT48H"
1483 * </pre>
1484 * Note that multiples of 24 hours are not output as days to avoid confusion
1485 * with {@code Period}.
1486 *
1487 * @return an ISO-8601 representation of this duration, not null
1488 */
1489 @Override
1490 public String toString() {
1491 if (this == ZERO) {
1492 return "PT0S";
1493 }
1494 long effectiveTotalSecs = seconds;
1495 if (seconds < 0 && nanos > 0) {
1496 effectiveTotalSecs++;
1497 }
1498 long hours = effectiveTotalSecs / SECONDS_PER_HOUR;
1499 int minutes = (int) ((effectiveTotalSecs % SECONDS_PER_HOUR) / SECONDS_PER_MINUTE);
1500 int secs = (int) (effectiveTotalSecs % SECONDS_PER_MINUTE);
1501 StringBuilder buf = new StringBuilder(24);
1502 buf.append("PT");
1503 if (hours != 0) {
1504 buf.append(hours).append('H');
1505 }
1506 if (minutes != 0) {
1507 buf.append(minutes).append('M');
1508 }
1509 if (secs == 0 && nanos == 0 && buf.length() > 2) {
1510 return buf.toString();
1511 }
1512 if (seconds < 0 && nanos > 0) {
1513 if (secs == 0) {
1514 buf.append("-0");
1515 } else {
1516 buf.append(secs);
1517 }
1518 } else {
1519 buf.append(secs);
1520 }
1521 if (nanos > 0) {
1522 int pos = buf.length();
1523 if (seconds < 0) {
1524 buf.append(2 * NANOS_PER_SECOND - nanos);
1525 } else {
1526 buf.append(nanos + NANOS_PER_SECOND);
1527 }
1528 while (buf.charAt(buf.length() - 1) == '0') {
1529 buf.setLength(buf.length() - 1);
1530 }
1531 buf.setCharAt(pos, '.');
1532 }
1533 buf.append('S');
1534 return buf.toString();
1535 }
1536
1537 //-----------------------------------------------------------------------
1538 /**
1539 * Writes the object using a
1540 * <a href="{@docRoot}/serialized-form.html#java.time.Ser">dedicated serialized form</a>.
1541 * @serialData
1542 * <pre>
1543 * out.writeByte(1); // identifies a Duration
1544 * out.writeLong(seconds);
1545 * out.writeInt(nanos);
1546 * </pre>
1547 *
1548 * @return the instance of {@code Ser}, not null
1549 */
1550 @java.io.Serial
1551 private Object writeReplace() {
1552 return new Ser(Ser.DURATION_TYPE, this);
1553 }
1554
1555 /**
1556 * Defend against malicious streams.
1557 *
1558 * @param s the stream to read
1559 * @throws InvalidObjectException always
1560 */
1561 @java.io.Serial
1562 private void readObject(ObjectInputStream s) throws InvalidObjectException {
1563 throw new InvalidObjectException("Deserialization via serialization delegate");
1564 }
1565
1566 void writeExternal(DataOutput out) throws IOException {
1567 out.writeLong(seconds);
1568 out.writeInt(nanos);
1569 }
1570
1571 static Duration readExternal(DataInput in) throws IOException {
1572 long seconds = in.readLong();
1573 int nanos = in.readInt();
1574 return Duration.ofSeconds(seconds, nanos);
1575 }
1576
1577 }