1 /*
   2  * Copyright (c) 2012, 2016, 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  *
 121  * <p>
 122  * This is a <a href="{@docRoot}/java/lang/doc-files/ValueBased.html">value-based</a>
 123  * class; use of identity-sensitive operations (including reference equality
 124  * ({@code ==}), identity hash code, or synchronization) on instances of
 125  * {@code Duration} may have unpredictable results and should be avoided.
 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 public final class Duration
 134         implements TemporalAmount, Comparable<Duration>, Serializable {
 135 
 136     /**
 137      * Constant for a duration of zero.
 138      */
 139     public static final Duration ZERO = new Duration(0, 0);
 140     /**
 141      * Serialization version.
 142      */
 143     private static final long serialVersionUID = 3078945930695997490L;
 144     /**
 145      * Constant for nanos per second.
 146      */
 147     private static final BigInteger BI_NANOS_PER_SECOND = BigInteger.valueOf(NANOS_PER_SECOND);
 148     /**
 149      * The pattern for parsing.
 150      */
 151     private static class Lazy {
 152         static final Pattern PATTERN =
 153             Pattern.compile("([-+]?)P(?:([-+]?[0-9]+)D)?" +
 154                     "(T(?:([-+]?[0-9]+)H)?(?:([-+]?[0-9]+)M)?(?:([-+]?[0-9]+)(?:[.,]([0-9]{0,9}))?S)?)?",
 155                     Pattern.CASE_INSENSITIVE);
 156     }
 157 
 158     /**
 159      * The number of seconds in the duration.
 160      */
 161     private final long seconds;
 162     /**
 163      * The number of nanoseconds in the duration, expressed as a fraction of the
 164      * number of seconds. This is always positive, and never exceeds 999,999,999.
 165      */
 166     private final int nanos;
 167 
 168     //-----------------------------------------------------------------------
 169     /**
 170      * Obtains a {@code Duration} representing a number of standard 24 hour days.
 171      * <p>
 172      * The seconds are calculated based on the standard definition of a day,
 173      * where each day is 86400 seconds which implies a 24 hour day.
 174      * The nanosecond in second field is set to zero.
 175      *
 176      * @param days  the number of days, positive or negative
 177      * @return a {@code Duration}, not null
 178      * @throws ArithmeticException if the input days exceeds the capacity of {@code Duration}
 179      */
 180     public static Duration ofDays(long days) {
 181         return create(Math.multiplyExact(days, SECONDS_PER_DAY), 0);
 182     }
 183 
 184     /**
 185      * Obtains a {@code Duration} representing a number of standard hours.
 186      * <p>
 187      * The seconds are calculated based on the standard definition of an hour,
 188      * where each hour is 3600 seconds.
 189      * The nanosecond in second field is set to zero.
 190      *
 191      * @param hours  the number of hours, positive or negative
 192      * @return a {@code Duration}, not null
 193      * @throws ArithmeticException if the input hours exceeds the capacity of {@code Duration}
 194      */
 195     public static Duration ofHours(long hours) {
 196         return create(Math.multiplyExact(hours, SECONDS_PER_HOUR), 0);
 197     }
 198 
 199     /**
 200      * Obtains a {@code Duration} representing a number of standard minutes.
 201      * <p>
 202      * The seconds are calculated based on the standard definition of a minute,
 203      * where each minute is 60 seconds.
 204      * The nanosecond in second field is set to zero.
 205      *
 206      * @param minutes  the number of minutes, positive or negative
 207      * @return a {@code Duration}, not null
 208      * @throws ArithmeticException if the input minutes exceeds the capacity of {@code Duration}
 209      */
 210     public static Duration ofMinutes(long minutes) {
 211         return create(Math.multiplyExact(minutes, SECONDS_PER_MINUTE), 0);
 212     }
 213 
 214     //-----------------------------------------------------------------------
 215     /**
 216      * Obtains a {@code Duration} representing a number of seconds.
 217      * <p>
 218      * The nanosecond in second field is set to zero.
 219      *
 220      * @param seconds  the number of seconds, positive or negative
 221      * @return a {@code Duration}, not null
 222      */
 223     public static Duration ofSeconds(long seconds) {
 224         return create(seconds, 0);
 225     }
 226 
 227     /**
 228      * Obtains a {@code Duration} representing a number of seconds and an
 229      * adjustment in nanoseconds.
 230      * <p>
 231      * This method allows an arbitrary number of nanoseconds to be passed in.
 232      * The factory will alter the values of the second and nanosecond in order
 233      * to ensure that the stored nanosecond is in the range 0 to 999,999,999.
 234      * For example, the following will result in the exactly the same duration:
 235      * <pre>
 236      *  Duration.ofSeconds(3, 1);
 237      *  Duration.ofSeconds(4, -999_999_999);
 238      *  Duration.ofSeconds(2, 1000_000_001);
 239      * </pre>
 240      *
 241      * @param seconds  the number of seconds, positive or negative
 242      * @param nanoAdjustment  the nanosecond adjustment to the number of seconds, positive or negative
 243      * @return a {@code Duration}, not null
 244      * @throws ArithmeticException if the adjustment causes the seconds to exceed the capacity of {@code Duration}
 245      */
 246     public static Duration ofSeconds(long seconds, long nanoAdjustment) {
 247         long secs = Math.addExact(seconds, Math.floorDiv(nanoAdjustment, NANOS_PER_SECOND));
 248         int nos = (int) Math.floorMod(nanoAdjustment, NANOS_PER_SECOND);
 249         return create(secs, nos);
 250     }
 251 
 252     //-----------------------------------------------------------------------
 253     /**
 254      * Obtains a {@code Duration} representing a number of milliseconds.
 255      * <p>
 256      * The seconds and nanoseconds are extracted from the specified milliseconds.
 257      *
 258      * @param millis  the number of milliseconds, positive or negative
 259      * @return a {@code Duration}, not null
 260      */
 261     public static Duration ofMillis(long millis) {
 262         long secs = millis / 1000;
 263         int mos = (int) (millis % 1000);
 264         if (mos < 0) {
 265             mos += 1000;
 266             secs--;
 267         }
 268         return create(secs, mos * 1000_000);
 269     }
 270 
 271     //-----------------------------------------------------------------------
 272     /**
 273      * Obtains a {@code Duration} representing a number of nanoseconds.
 274      * <p>
 275      * The seconds and nanoseconds are extracted from the specified nanoseconds.
 276      *
 277      * @param nanos  the number of nanoseconds, positive or negative
 278      * @return a {@code Duration}, not null
 279      */
 280     public static Duration ofNanos(long nanos) {
 281         long secs = nanos / NANOS_PER_SECOND;
 282         int nos = (int) (nanos % NANOS_PER_SECOND);
 283         if (nos < 0) {
 284             nos += NANOS_PER_SECOND;
 285             secs--;
 286         }
 287         return create(secs, nos);
 288     }
 289 
 290     //-----------------------------------------------------------------------
 291     /**
 292      * Obtains a {@code Duration} representing an amount in the specified unit.
 293      * <p>
 294      * The parameters represent the two parts of a phrase like '6 Hours'. For example:
 295      * <pre>
 296      *  Duration.of(3, SECONDS);
 297      *  Duration.of(465, HOURS);
 298      * </pre>
 299      * Only a subset of units are accepted by this method.
 300      * The unit must either have an {@linkplain TemporalUnit#isDurationEstimated() exact duration} or
 301      * be {@link ChronoUnit#DAYS} which is treated as 24 hours. Other units throw an exception.
 302      *
 303      * @param amount  the amount of the duration, measured in terms of the unit, positive or negative
 304      * @param unit  the unit that the duration is measured in, must have an exact duration, not null
 305      * @return a {@code Duration}, not null
 306      * @throws DateTimeException if the period unit has an estimated duration
 307      * @throws ArithmeticException if a numeric overflow occurs
 308      */
 309     public static Duration of(long amount, TemporalUnit unit) {
 310         return ZERO.plus(amount, unit);
 311     }
 312 
 313     //-----------------------------------------------------------------------
 314     /**
 315      * Obtains an instance of {@code Duration} from a temporal amount.
 316      * <p>
 317      * This obtains a duration based on the specified amount.
 318      * A {@code TemporalAmount} represents an  amount of time, which may be
 319      * date-based or time-based, which this factory extracts to a duration.
 320      * <p>
 321      * The conversion loops around the set of units from the amount and uses
 322      * the {@linkplain TemporalUnit#getDuration() duration} of the unit to
 323      * calculate the total {@code Duration}.
 324      * Only a subset of units are accepted by this method. The unit must either
 325      * have an {@linkplain TemporalUnit#isDurationEstimated() exact duration}
 326      * or be {@link ChronoUnit#DAYS} which is treated as 24 hours.
 327      * If any other units are found then an exception is thrown.
 328      *
 329      * @param amount  the temporal amount to convert, not null
 330      * @return the equivalent duration, not null
 331      * @throws DateTimeException if unable to convert to a {@code Duration}
 332      * @throws ArithmeticException if numeric overflow occurs
 333      */
 334     public static Duration from(TemporalAmount amount) {
 335         Objects.requireNonNull(amount, "amount");
 336         Duration duration = ZERO;
 337         for (TemporalUnit unit : amount.getUnits()) {
 338             duration = duration.plus(amount.get(unit), unit);
 339         }
 340         return duration;
 341     }
 342 
 343     //-----------------------------------------------------------------------
 344     /**
 345      * Obtains a {@code Duration} from a text string such as {@code PnDTnHnMn.nS}.
 346      * <p>
 347      * This will parse a textual representation of a duration, including the
 348      * string produced by {@code toString()}. The formats accepted are based
 349      * on the ISO-8601 duration format {@code PnDTnHnMn.nS} with days
 350      * considered to be exactly 24 hours.
 351      * <p>
 352      * The string starts with an optional sign, denoted by the ASCII negative
 353      * or positive symbol. If negative, the whole period is negated.
 354      * The ASCII letter "P" is next in upper or lower case.
 355      * There are then four sections, each consisting of a number and a suffix.
 356      * The sections have suffixes in ASCII of "D", "H", "M" and "S" for
 357      * days, hours, minutes and seconds, accepted in upper or lower case.
 358      * The suffixes must occur in order. The ASCII letter "T" must occur before
 359      * the first occurrence, if any, of an hour, minute or second section.
 360      * At least one of the four sections must be present, and if "T" is present
 361      * there must be at least one section after the "T".
 362      * The number part of each section must consist of one or more ASCII digits.
 363      * The number may be prefixed by the ASCII negative or positive symbol.
 364      * The number of days, hours and minutes must parse to a {@code long}.
 365      * The number of seconds must parse to a {@code long} with optional fraction.
 366      * The decimal point may be either a dot or a comma.
 367      * The fractional part may have from zero to 9 digits.
 368      * <p>
 369      * The leading plus/minus sign, and negative values for other units are
 370      * not part of the ISO-8601 standard.
 371      * <p>
 372      * Examples:
 373      * <pre>
 374      *    "PT20.345S" -- parses as "20.345 seconds"
 375      *    "PT15M"     -- parses as "15 minutes" (where a minute is 60 seconds)
 376      *    "PT10H"     -- parses as "10 hours" (where an hour is 3600 seconds)
 377      *    "P2D"       -- parses as "2 days" (where a day is 24 hours or 86400 seconds)
 378      *    "P2DT3H4M"  -- parses as "2 days, 3 hours and 4 minutes"
 379      *    "PT-6H3M"    -- parses as "-6 hours and +3 minutes"
 380      *    "-PT6H3M"    -- parses as "-6 hours and -3 minutes"
 381      *    "-PT-6H+3M"  -- parses as "+6 hours and -3 minutes"
 382      * </pre>
 383      *
 384      * @param text  the text to parse, not null
 385      * @return the parsed duration, not null
 386      * @throws DateTimeParseException if the text cannot be parsed to a duration
 387      */
 388     public static Duration parse(CharSequence text) {
 389         Objects.requireNonNull(text, "text");
 390         Matcher matcher = Lazy.PATTERN.matcher(text);
 391         if (matcher.matches()) {
 392             // check for letter T but no time sections
 393             if (!charMatch(text, matcher.start(3), matcher.end(3), 'T')) {
 394                 boolean negate = charMatch(text, matcher.start(1), matcher.end(1), '-');
 395 
 396                 int dayStart = matcher.start(2), dayEnd = matcher.end(2);
 397                 int hourStart = matcher.start(4), hourEnd = matcher.end(4);
 398                 int minuteStart = matcher.start(5), minuteEnd = matcher.end(5);
 399                 int secondStart = matcher.start(6), secondEnd = matcher.end(6);
 400                 int fractionStart = matcher.start(7), fractionEnd = matcher.end(7);
 401 
 402                 if (dayStart >= 0 || hourStart >= 0 || minuteStart >= 0 || secondStart >= 0) {
 403                     long daysAsSecs = parseNumber(text, dayStart, dayEnd, SECONDS_PER_DAY, "days");
 404                     long hoursAsSecs = parseNumber(text, hourStart, hourEnd, SECONDS_PER_HOUR, "hours");
 405                     long minsAsSecs = parseNumber(text, minuteStart, minuteEnd, SECONDS_PER_MINUTE, "minutes");
 406                     long seconds = parseNumber(text, secondStart, secondEnd, 1, "seconds");
 407                     boolean negativeSecs = secondStart >= 0 && text.charAt(secondStart) == '-';
 408                     int nanos = parseFraction(text, fractionStart, fractionEnd, negativeSecs ? -1 : 1);
 409                     try {
 410                         return create(negate, daysAsSecs, hoursAsSecs, minsAsSecs, seconds, nanos);
 411                     } catch (ArithmeticException ex) {
 412                         throw (DateTimeParseException) new DateTimeParseException("Text cannot be parsed to a Duration: overflow", text, 0).initCause(ex);
 413                     }
 414                 }
 415             }
 416         }
 417         throw new DateTimeParseException("Text cannot be parsed to a Duration", text, 0);
 418     }
 419 
 420     private static boolean charMatch(CharSequence text, int start, int end, char c) {
 421         return (start >= 0 && end == start + 1 && text.charAt(start) == c);
 422     }
 423 
 424     private static long parseNumber(CharSequence text, int start, int end, int multiplier, String errorText) {
 425         // regex limits to [-+]?[0-9]+
 426         if (start < 0 || end < 0) {
 427             return 0;
 428         }
 429         try {
 430             long val = Long.parseLong(text, start, end, 10);
 431             return Math.multiplyExact(val, multiplier);
 432         } catch (NumberFormatException | ArithmeticException ex) {
 433             throw (DateTimeParseException) new DateTimeParseException("Text cannot be parsed to a Duration: " + errorText, text, 0).initCause(ex);
 434         }
 435     }
 436 
 437     private static int parseFraction(CharSequence text, int start, int end, int negate) {
 438         // regex limits to [0-9]{0,9}
 439         if (start < 0 || end < 0 || end - start == 0) {
 440             return 0;
 441         }
 442         try {
 443             int fraction = Integer.parseInt(text, start, end, 10);
 444 
 445             // for number strings smaller than 9 digits, interpret as if there
 446             // were trailing zeros
 447             for (int i = end - start; i < 9; i++) {
 448                 fraction *= 10;
 449             }
 450             return fraction * negate;
 451         } catch (NumberFormatException | ArithmeticException ex) {
 452             throw (DateTimeParseException) new DateTimeParseException("Text cannot be parsed to a Duration: fraction", text, 0).initCause(ex);
 453         }
 454     }
 455 
 456     private static Duration create(boolean negate, long daysAsSecs, long hoursAsSecs, long minsAsSecs, long secs, int nanos) {
 457         long seconds = Math.addExact(daysAsSecs, Math.addExact(hoursAsSecs, Math.addExact(minsAsSecs, secs)));
 458         if (negate) {
 459             return ofSeconds(seconds, nanos).negated();
 460         }
 461         return ofSeconds(seconds, nanos);
 462     }
 463 
 464     //-----------------------------------------------------------------------
 465     /**
 466      * Obtains a {@code Duration} representing the duration between two temporal objects.
 467      * <p>
 468      * This calculates the duration between two temporal objects. If the objects
 469      * are of different types, then the duration is calculated based on the type
 470      * of the first object. For example, if the first argument is a {@code LocalTime}
 471      * then the second argument is converted to a {@code LocalTime}.
 472      * <p>
 473      * The specified temporal objects must support the {@link ChronoUnit#SECONDS SECONDS} unit.
 474      * For full accuracy, either the {@link ChronoUnit#NANOS NANOS} unit or the
 475      * {@link ChronoField#NANO_OF_SECOND NANO_OF_SECOND} field should be supported.
 476      * <p>
 477      * The result of this method can be a negative period if the end is before the start.
 478      * To guarantee to obtain a positive duration call {@link #abs()} on the result.
 479      *
 480      * @param startInclusive  the start instant, inclusive, not null
 481      * @param endExclusive  the end instant, exclusive, not null
 482      * @return a {@code Duration}, not null
 483      * @throws DateTimeException if the seconds between the temporals cannot be obtained
 484      * @throws ArithmeticException if the calculation exceeds the capacity of {@code Duration}
 485      */
 486     public static Duration between(Temporal startInclusive, Temporal endExclusive) {
 487         try {
 488             return ofNanos(startInclusive.until(endExclusive, NANOS));
 489         } catch (DateTimeException | ArithmeticException ex) {
 490             long secs = startInclusive.until(endExclusive, SECONDS);
 491             long nanos;
 492             try {
 493                 nanos = endExclusive.getLong(NANO_OF_SECOND) - startInclusive.getLong(NANO_OF_SECOND);
 494                 if (secs > 0 && nanos < 0) {
 495                     secs++;
 496                 } else if (secs < 0 && nanos > 0) {
 497                     secs--;
 498                 }
 499             } catch (DateTimeException ex2) {
 500                 nanos = 0;
 501             }
 502             return ofSeconds(secs, nanos);
 503         }
 504     }
 505 
 506     //-----------------------------------------------------------------------
 507     /**
 508      * Obtains an instance of {@code Duration} using seconds and nanoseconds.
 509      *
 510      * @param seconds  the length of the duration in seconds, positive or negative
 511      * @param nanoAdjustment  the nanosecond adjustment within the second, from 0 to 999,999,999
 512      */
 513     private static Duration create(long seconds, int nanoAdjustment) {
 514         if ((seconds | nanoAdjustment) == 0) {
 515             return ZERO;
 516         }
 517         return new Duration(seconds, nanoAdjustment);
 518     }
 519 
 520     /**
 521      * Constructs an instance of {@code Duration} using seconds and nanoseconds.
 522      *
 523      * @param seconds  the length of the duration in seconds, positive or negative
 524      * @param nanos  the nanoseconds within the second, from 0 to 999,999,999
 525      */
 526     private Duration(long seconds, int nanos) {
 527         super();
 528         this.seconds = seconds;
 529         this.nanos = nanos;
 530     }
 531 
 532     //-----------------------------------------------------------------------
 533     /**
 534      * Gets the value of the requested unit.
 535      * <p>
 536      * This returns a value for each of the two supported units,
 537      * {@link ChronoUnit#SECONDS SECONDS} and {@link ChronoUnit#NANOS NANOS}.
 538      * All other units throw an exception.
 539      *
 540      * @param unit the {@code TemporalUnit} for which to return the value
 541      * @return the long value of the unit
 542      * @throws DateTimeException if the unit is not supported
 543      * @throws UnsupportedTemporalTypeException if the unit is not supported
 544      */
 545     @Override
 546     public long get(TemporalUnit unit) {
 547         if (unit == SECONDS) {
 548             return seconds;
 549         } else if (unit == NANOS) {
 550             return nanos;
 551         } else {
 552             throw new UnsupportedTemporalTypeException("Unsupported unit: " + unit);
 553         }
 554     }
 555 
 556     /**
 557      * Gets the set of units supported by this duration.
 558      * <p>
 559      * The supported units are {@link ChronoUnit#SECONDS SECONDS},
 560      * and {@link ChronoUnit#NANOS NANOS}.
 561      * They are returned in the order seconds, nanos.
 562      * <p>
 563      * This set can be used in conjunction with {@link #get(TemporalUnit)}
 564      * to access the entire state of the duration.
 565      *
 566      * @return a list containing the seconds and nanos units, not null
 567      */
 568     @Override
 569     public List<TemporalUnit> getUnits() {
 570         return DurationUnits.UNITS;
 571     }
 572 
 573     /**
 574      * Private class to delay initialization of this list until needed.
 575      * The circular dependency between Duration and ChronoUnit prevents
 576      * the simple initialization in Duration.
 577      */
 578     private static class DurationUnits {
 579         static final List<TemporalUnit> UNITS = List.of(SECONDS, NANOS);
 580     }
 581 
 582     //-----------------------------------------------------------------------
 583     /**
 584      * Checks if this duration is zero length.
 585      * <p>
 586      * A {@code Duration} represents a directed distance between two points on
 587      * the time-line and can therefore be positive, zero or negative.
 588      * This method checks whether the length is zero.
 589      *
 590      * @return true if this duration has a total length equal to zero
 591      */
 592     public boolean isZero() {
 593         return (seconds | nanos) == 0;
 594     }
 595 
 596     /**
 597      * Checks if this duration is negative, excluding zero.
 598      * <p>
 599      * A {@code Duration} represents a directed distance between two points on
 600      * the time-line and can therefore be positive, zero or negative.
 601      * This method checks whether the length is less than zero.
 602      *
 603      * @return true if this duration has a total length less than zero
 604      */
 605     public boolean isNegative() {
 606         return seconds < 0;
 607     }
 608 
 609     //-----------------------------------------------------------------------
 610     /**
 611      * Gets the number of seconds in this duration.
 612      * <p>
 613      * The length of the duration is stored using two fields - seconds and nanoseconds.
 614      * The nanoseconds part is a value from 0 to 999,999,999 that is an adjustment to
 615      * the length in seconds.
 616      * The total duration is defined by calling this method and {@link #getNano()}.
 617      * <p>
 618      * A {@code Duration} represents a directed distance between two points on the time-line.
 619      * A negative duration is expressed by the negative sign of the seconds part.
 620      * A duration of -1 nanosecond is stored as -1 seconds plus 999,999,999 nanoseconds.
 621      *
 622      * @return the whole seconds part of the length of the duration, positive or negative
 623      */
 624     public long getSeconds() {
 625         return seconds;
 626     }
 627 
 628     /**
 629      * Gets the number of nanoseconds within the second 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 #getSeconds()}.
 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 nanoseconds within the second part of the length of the duration, from 0 to 999,999,999
 641      */
 642     public int getNano() {
 643         return nanos;
 644     }
 645 
 646     //-----------------------------------------------------------------------
 647     /**
 648      * Returns a copy of this duration with the specified amount of seconds.
 649      * <p>
 650      * This returns a duration with the specified seconds, retaining the
 651      * nano-of-second part of this duration.
 652      * <p>
 653      * This instance is immutable and unaffected by this method call.
 654      *
 655      * @param seconds  the seconds to represent, may be negative
 656      * @return a {@code Duration} based on this period with the requested seconds, not null
 657      */
 658     public Duration withSeconds(long seconds) {
 659         return create(seconds, nanos);
 660     }
 661 
 662     /**
 663      * Returns a copy of this duration with the specified nano-of-second.
 664      * <p>
 665      * This returns a duration with the specified nano-of-second, retaining the
 666      * seconds part of this duration.
 667      * <p>
 668      * This instance is immutable and unaffected by this method call.
 669      *
 670      * @param nanoOfSecond  the nano-of-second to represent, from 0 to 999,999,999
 671      * @return a {@code Duration} based on this period with the requested nano-of-second, not null
 672      * @throws DateTimeException if the nano-of-second is invalid
 673      */
 674     public Duration withNanos(int nanoOfSecond) {
 675         NANO_OF_SECOND.checkValidIntValue(nanoOfSecond);
 676         return create(seconds, nanoOfSecond);
 677     }
 678 
 679     //-----------------------------------------------------------------------
 680     /**
 681      * Returns a copy of this duration with the specified duration added.
 682      * <p>
 683      * This instance is immutable and unaffected by this method call.
 684      *
 685      * @param duration  the duration to add, positive or negative, not null
 686      * @return a {@code Duration} based on this duration with the specified duration added, not null
 687      * @throws ArithmeticException if numeric overflow occurs
 688      */
 689     public Duration plus(Duration duration) {
 690         return plus(duration.getSeconds(), duration.getNano());
 691      }
 692 
 693     /**
 694      * Returns a copy of this duration with the specified duration added.
 695      * <p>
 696      * The duration amount is measured in terms of the specified unit.
 697      * Only a subset of units are accepted by this method.
 698      * The unit must either have an {@linkplain TemporalUnit#isDurationEstimated() exact duration} or
 699      * be {@link ChronoUnit#DAYS} which is treated as 24 hours. Other units throw an exception.
 700      * <p>
 701      * This instance is immutable and unaffected by this method call.
 702      *
 703      * @param amountToAdd  the amount to add, measured in terms of the unit, positive or negative
 704      * @param unit  the unit that the amount is measured in, must have an exact duration, not null
 705      * @return a {@code Duration} based on this duration with the specified duration added, not null
 706      * @throws UnsupportedTemporalTypeException if the unit is not supported
 707      * @throws ArithmeticException if numeric overflow occurs
 708      */
 709     public Duration plus(long amountToAdd, TemporalUnit unit) {
 710         Objects.requireNonNull(unit, "unit");
 711         if (unit == DAYS) {
 712             return plus(Math.multiplyExact(amountToAdd, SECONDS_PER_DAY), 0);
 713         }
 714         if (unit.isDurationEstimated()) {
 715             throw new UnsupportedTemporalTypeException("Unit must not have an estimated duration");
 716         }
 717         if (amountToAdd == 0) {
 718             return this;
 719         }
 720         if (unit instanceof ChronoUnit) {
 721             switch ((ChronoUnit) unit) {
 722                 case NANOS: return plusNanos(amountToAdd);
 723                 case MICROS: return plusSeconds((amountToAdd / (1000_000L * 1000)) * 1000).plusNanos((amountToAdd % (1000_000L * 1000)) * 1000);
 724                 case MILLIS: return plusMillis(amountToAdd);
 725                 case SECONDS: return plusSeconds(amountToAdd);
 726             }
 727             return plusSeconds(Math.multiplyExact(unit.getDuration().seconds, amountToAdd));
 728         }
 729         Duration duration = unit.getDuration().multipliedBy(amountToAdd);
 730         return plusSeconds(duration.getSeconds()).plusNanos(duration.getNano());
 731     }
 732 
 733     //-----------------------------------------------------------------------
 734     /**
 735      * Returns a copy of this duration with the specified duration in standard 24 hour days added.
 736      * <p>
 737      * The number of days is multiplied by 86400 to obtain the number of seconds to add.
 738      * This is based on the standard definition of a day as 24 hours.
 739      * <p>
 740      * This instance is immutable and unaffected by this method call.
 741      *
 742      * @param daysToAdd  the days to add, positive or negative
 743      * @return a {@code Duration} based on this duration with the specified days added, not null
 744      * @throws ArithmeticException if numeric overflow occurs
 745      */
 746     public Duration plusDays(long daysToAdd) {
 747         return plus(Math.multiplyExact(daysToAdd, SECONDS_PER_DAY), 0);
 748     }
 749 
 750     /**
 751      * Returns a copy of this duration with the specified duration in hours added.
 752      * <p>
 753      * This instance is immutable and unaffected by this method call.
 754      *
 755      * @param hoursToAdd  the hours to add, positive or negative
 756      * @return a {@code Duration} based on this duration with the specified hours added, not null
 757      * @throws ArithmeticException if numeric overflow occurs
 758      */
 759     public Duration plusHours(long hoursToAdd) {
 760         return plus(Math.multiplyExact(hoursToAdd, SECONDS_PER_HOUR), 0);
 761     }
 762 
 763     /**
 764      * Returns a copy of this duration with the specified duration in minutes added.
 765      * <p>
 766      * This instance is immutable and unaffected by this method call.
 767      *
 768      * @param minutesToAdd  the minutes to add, positive or negative
 769      * @return a {@code Duration} based on this duration with the specified minutes added, not null
 770      * @throws ArithmeticException if numeric overflow occurs
 771      */
 772     public Duration plusMinutes(long minutesToAdd) {
 773         return plus(Math.multiplyExact(minutesToAdd, SECONDS_PER_MINUTE), 0);
 774     }
 775 
 776     /**
 777      * Returns a copy of this duration with the specified duration in seconds added.
 778      * <p>
 779      * This instance is immutable and unaffected by this method call.
 780      *
 781      * @param secondsToAdd  the seconds to add, positive or negative
 782      * @return a {@code Duration} based on this duration with the specified seconds added, not null
 783      * @throws ArithmeticException if numeric overflow occurs
 784      */
 785     public Duration plusSeconds(long secondsToAdd) {
 786         return plus(secondsToAdd, 0);
 787     }
 788 
 789     /**
 790      * Returns a copy of this duration with the specified duration in milliseconds added.
 791      * <p>
 792      * This instance is immutable and unaffected by this method call.
 793      *
 794      * @param millisToAdd  the milliseconds to add, positive or negative
 795      * @return a {@code Duration} based on this duration with the specified milliseconds added, not null
 796      * @throws ArithmeticException if numeric overflow occurs
 797      */
 798     public Duration plusMillis(long millisToAdd) {
 799         return plus(millisToAdd / 1000, (millisToAdd % 1000) * 1000_000);
 800     }
 801 
 802     /**
 803      * Returns a copy of this duration with the specified duration in nanoseconds added.
 804      * <p>
 805      * This instance is immutable and unaffected by this method call.
 806      *
 807      * @param nanosToAdd  the nanoseconds to add, positive or negative
 808      * @return a {@code Duration} based on this duration with the specified nanoseconds added, not null
 809      * @throws ArithmeticException if numeric overflow occurs
 810      */
 811     public Duration plusNanos(long nanosToAdd) {
 812         return plus(0, nanosToAdd);
 813     }
 814 
 815     /**
 816      * Returns a copy of this duration with the specified duration added.
 817      * <p>
 818      * This instance is immutable and unaffected by this method call.
 819      *
 820      * @param secondsToAdd  the seconds to add, positive or negative
 821      * @param nanosToAdd  the nanos to add, positive or negative
 822      * @return a {@code Duration} based on this duration with the specified seconds added, not null
 823      * @throws ArithmeticException if numeric overflow occurs
 824      */
 825     private Duration plus(long secondsToAdd, long nanosToAdd) {
 826         if ((secondsToAdd | nanosToAdd) == 0) {
 827             return this;
 828         }
 829         long epochSec = Math.addExact(seconds, secondsToAdd);
 830         epochSec = Math.addExact(epochSec, nanosToAdd / NANOS_PER_SECOND);
 831         nanosToAdd = nanosToAdd % NANOS_PER_SECOND;
 832         long nanoAdjustment = nanos + nanosToAdd;  // safe int+NANOS_PER_SECOND
 833         return ofSeconds(epochSec, nanoAdjustment);
 834     }
 835 
 836     //-----------------------------------------------------------------------
 837     /**
 838      * Returns a copy of this duration with the specified duration subtracted.
 839      * <p>
 840      * This instance is immutable and unaffected by this method call.
 841      *
 842      * @param duration  the duration to subtract, positive or negative, not null
 843      * @return a {@code Duration} based on this duration with the specified duration subtracted, not null
 844      * @throws ArithmeticException if numeric overflow occurs
 845      */
 846     public Duration minus(Duration duration) {
 847         long secsToSubtract = duration.getSeconds();
 848         int nanosToSubtract = duration.getNano();
 849         if (secsToSubtract == Long.MIN_VALUE) {
 850             return plus(Long.MAX_VALUE, -nanosToSubtract).plus(1, 0);
 851         }
 852         return plus(-secsToSubtract, -nanosToSubtract);
 853      }
 854 
 855     /**
 856      * Returns a copy of this duration with the specified duration subtracted.
 857      * <p>
 858      * The duration amount is measured in terms of the specified unit.
 859      * Only a subset of units are accepted by this method.
 860      * The unit must either have an {@linkplain TemporalUnit#isDurationEstimated() exact duration} or
 861      * be {@link ChronoUnit#DAYS} which is treated as 24 hours. Other units throw an exception.
 862      * <p>
 863      * This instance is immutable and unaffected by this method call.
 864      *
 865      * @param amountToSubtract  the amount to subtract, measured in terms of the unit, positive or negative
 866      * @param unit  the unit that the amount is measured in, must have an exact duration, not null
 867      * @return a {@code Duration} based on this duration with the specified duration subtracted, not null
 868      * @throws ArithmeticException if numeric overflow occurs
 869      */
 870     public Duration minus(long amountToSubtract, TemporalUnit unit) {
 871         return (amountToSubtract == Long.MIN_VALUE ? plus(Long.MAX_VALUE, unit).plus(1, unit) : plus(-amountToSubtract, unit));
 872     }
 873 
 874     //-----------------------------------------------------------------------
 875     /**
 876      * Returns a copy of this duration with the specified duration in standard 24 hour days subtracted.
 877      * <p>
 878      * The number of days is multiplied by 86400 to obtain the number of seconds to subtract.
 879      * This is based on the standard definition of a day as 24 hours.
 880      * <p>
 881      * This instance is immutable and unaffected by this method call.
 882      *
 883      * @param daysToSubtract  the days to subtract, positive or negative
 884      * @return a {@code Duration} based on this duration with the specified days subtracted, not null
 885      * @throws ArithmeticException if numeric overflow occurs
 886      */
 887     public Duration minusDays(long daysToSubtract) {
 888         return (daysToSubtract == Long.MIN_VALUE ? plusDays(Long.MAX_VALUE).plusDays(1) : plusDays(-daysToSubtract));
 889     }
 890 
 891     /**
 892      * Returns a copy of this duration with the specified duration in hours subtracted.
 893      * <p>
 894      * The number of hours is multiplied by 3600 to obtain the number of seconds to subtract.
 895      * <p>
 896      * This instance is immutable and unaffected by this method call.
 897      *
 898      * @param hoursToSubtract  the hours to subtract, positive or negative
 899      * @return a {@code Duration} based on this duration with the specified hours subtracted, not null
 900      * @throws ArithmeticException if numeric overflow occurs
 901      */
 902     public Duration minusHours(long hoursToSubtract) {
 903         return (hoursToSubtract == Long.MIN_VALUE ? plusHours(Long.MAX_VALUE).plusHours(1) : plusHours(-hoursToSubtract));
 904     }
 905 
 906     /**
 907      * Returns a copy of this duration with the specified duration in minutes subtracted.
 908      * <p>
 909      * The number of hours is multiplied by 60 to obtain the number of seconds to subtract.
 910      * <p>
 911      * This instance is immutable and unaffected by this method call.
 912      *
 913      * @param minutesToSubtract  the minutes to subtract, positive or negative
 914      * @return a {@code Duration} based on this duration with the specified minutes subtracted, not null
 915      * @throws ArithmeticException if numeric overflow occurs
 916      */
 917     public Duration minusMinutes(long minutesToSubtract) {
 918         return (minutesToSubtract == Long.MIN_VALUE ? plusMinutes(Long.MAX_VALUE).plusMinutes(1) : plusMinutes(-minutesToSubtract));
 919     }
 920 
 921     /**
 922      * Returns a copy of this duration with the specified duration in seconds subtracted.
 923      * <p>
 924      * This instance is immutable and unaffected by this method call.
 925      *
 926      * @param secondsToSubtract  the seconds to subtract, positive or negative
 927      * @return a {@code Duration} based on this duration with the specified seconds subtracted, not null
 928      * @throws ArithmeticException if numeric overflow occurs
 929      */
 930     public Duration minusSeconds(long secondsToSubtract) {
 931         return (secondsToSubtract == Long.MIN_VALUE ? plusSeconds(Long.MAX_VALUE).plusSeconds(1) : plusSeconds(-secondsToSubtract));
 932     }
 933 
 934     /**
 935      * Returns a copy of this duration with the specified duration in milliseconds subtracted.
 936      * <p>
 937      * This instance is immutable and unaffected by this method call.
 938      *
 939      * @param millisToSubtract  the milliseconds to subtract, positive or negative
 940      * @return a {@code Duration} based on this duration with the specified milliseconds subtracted, not null
 941      * @throws ArithmeticException if numeric overflow occurs
 942      */
 943     public Duration minusMillis(long millisToSubtract) {
 944         return (millisToSubtract == Long.MIN_VALUE ? plusMillis(Long.MAX_VALUE).plusMillis(1) : plusMillis(-millisToSubtract));
 945     }
 946 
 947     /**
 948      * Returns a copy of this duration with the specified duration in nanoseconds subtracted.
 949      * <p>
 950      * This instance is immutable and unaffected by this method call.
 951      *
 952      * @param nanosToSubtract  the nanoseconds to subtract, positive or negative
 953      * @return a {@code Duration} based on this duration with the specified nanoseconds subtracted, not null
 954      * @throws ArithmeticException if numeric overflow occurs
 955      */
 956     public Duration minusNanos(long nanosToSubtract) {
 957         return (nanosToSubtract == Long.MIN_VALUE ? plusNanos(Long.MAX_VALUE).plusNanos(1) : plusNanos(-nanosToSubtract));
 958     }
 959 
 960     //-----------------------------------------------------------------------
 961     /**
 962      * Returns a copy of this duration multiplied by the scalar.
 963      * <p>
 964      * This instance is immutable and unaffected by this method call.
 965      *
 966      * @param multiplicand  the value to multiply the duration by, positive or negative
 967      * @return a {@code Duration} based on this duration multiplied by the specified scalar, not null
 968      * @throws ArithmeticException if numeric overflow occurs
 969      */
 970     public Duration multipliedBy(long multiplicand) {
 971         if (multiplicand == 0) {
 972             return ZERO;
 973         }
 974         if (multiplicand == 1) {
 975             return this;
 976         }
 977         return create(toBigDecimalSeconds().multiply(BigDecimal.valueOf(multiplicand)));
 978      }
 979 
 980     /**
 981      * Returns a copy of this duration divided by the specified value.
 982      * <p>
 983      * This instance is immutable and unaffected by this method call.
 984      *
 985      * @param divisor  the value to divide the duration by, positive or negative, not zero
 986      * @return a {@code Duration} based on this duration divided by the specified divisor, not null
 987      * @throws ArithmeticException if the divisor is zero or if numeric overflow occurs
 988      */
 989     public Duration dividedBy(long divisor) {
 990         if (divisor == 0) {
 991             throw new ArithmeticException("Cannot divide by zero");
 992         }
 993         if (divisor == 1) {
 994             return this;
 995         }
 996         return create(toBigDecimalSeconds().divide(BigDecimal.valueOf(divisor), RoundingMode.DOWN));
 997      }
 998 
 999     /**
1000      * Returns number of whole times a specified Duration occurs within this Duration.
1001      * <p>
1002      * This instance is immutable and unaffected by this method call.
1003      *
1004      * @param divisor the value to divide the duration by, positive or negative, not null
1005      * @return number of whole times, rounded toward zero, a specified
1006      *         {@code Duration} occurs within this Duration, may be negative
1007      * @throws ArithmeticException if the divisor is zero, or if numeric overflow occurs
1008      * @since 9
1009      */
1010     public long dividedBy(Duration divisor) {
1011         Objects.requireNonNull(divisor, "divisor");
1012         BigDecimal dividendBigD = toBigDecimalSeconds();
1013         BigDecimal divisorBigD = divisor.toBigDecimalSeconds();
1014         return dividendBigD.divideToIntegralValue(divisorBigD).longValueExact();
1015     }
1016 
1017     /**
1018      * Converts this duration to the total length in seconds and
1019      * fractional nanoseconds expressed as a {@code BigDecimal}.
1020      *
1021      * @return the total length of the duration in seconds, with a scale of 9, not null
1022      */
1023     private BigDecimal toBigDecimalSeconds() {
1024         return BigDecimal.valueOf(seconds).add(BigDecimal.valueOf(nanos, 9));
1025     }
1026 
1027     /**
1028      * Creates an instance of {@code Duration} from a number of seconds.
1029      *
1030      * @param seconds  the number of seconds, up to scale 9, positive or negative
1031      * @return a {@code Duration}, not null
1032      * @throws ArithmeticException if numeric overflow occurs
1033      */
1034     private static Duration create(BigDecimal seconds) {
1035         BigInteger nanos = seconds.movePointRight(9).toBigIntegerExact();
1036         BigInteger[] divRem = nanos.divideAndRemainder(BI_NANOS_PER_SECOND);
1037         if (divRem[0].bitLength() > 63) {
1038             throw new ArithmeticException("Exceeds capacity of Duration: " + nanos);
1039         }
1040         return ofSeconds(divRem[0].longValue(), divRem[1].intValue());
1041     }
1042 
1043     //-----------------------------------------------------------------------
1044     /**
1045      * Returns a copy of this duration with the length negated.
1046      * <p>
1047      * This method swaps the sign of the total length of this duration.
1048      * For example, {@code PT1.3S} will be returned as {@code PT-1.3S}.
1049      * <p>
1050      * This instance is immutable and unaffected by this method call.
1051      *
1052      * @return a {@code Duration} based on this duration with the amount negated, not null
1053      * @throws ArithmeticException if numeric overflow occurs
1054      */
1055     public Duration negated() {
1056         return multipliedBy(-1);
1057     }
1058 
1059     /**
1060      * Returns a copy of this duration with a positive length.
1061      * <p>
1062      * This method returns a positive duration by effectively removing the sign from any negative total length.
1063      * For example, {@code PT-1.3S} will be returned as {@code PT1.3S}.
1064      * <p>
1065      * This instance is immutable and unaffected by this method call.
1066      *
1067      * @return a {@code Duration} based on this duration with an absolute length, not null
1068      * @throws ArithmeticException if numeric overflow occurs
1069      */
1070     public Duration abs() {
1071         return isNegative() ? negated() : this;
1072     }
1073 
1074     //-------------------------------------------------------------------------
1075     /**
1076      * Adds this duration to the specified temporal object.
1077      * <p>
1078      * This returns a temporal object of the same observable type as the input
1079      * with this duration added.
1080      * <p>
1081      * In most cases, it is clearer to reverse the calling pattern by using
1082      * {@link Temporal#plus(TemporalAmount)}.
1083      * <pre>
1084      *   // these two lines are equivalent, but the second approach is recommended
1085      *   dateTime = thisDuration.addTo(dateTime);
1086      *   dateTime = dateTime.plus(thisDuration);
1087      * </pre>
1088      * <p>
1089      * The calculation will add the seconds, then nanos.
1090      * Only non-zero amounts will be added.
1091      * <p>
1092      * This instance is immutable and unaffected by this method call.
1093      *
1094      * @param temporal  the temporal object to adjust, not null
1095      * @return an object of the same type with the adjustment made, not null
1096      * @throws DateTimeException if unable to add
1097      * @throws ArithmeticException if numeric overflow occurs
1098      */
1099     @Override
1100     public Temporal addTo(Temporal temporal) {
1101         if (seconds != 0) {
1102             temporal = temporal.plus(seconds, SECONDS);
1103         }
1104         if (nanos != 0) {
1105             temporal = temporal.plus(nanos, NANOS);
1106         }
1107         return temporal;
1108     }
1109 
1110     /**
1111      * Subtracts this duration from the specified temporal object.
1112      * <p>
1113      * This returns a temporal object of the same observable type as the input
1114      * with this duration subtracted.
1115      * <p>
1116      * In most cases, it is clearer to reverse the calling pattern by using
1117      * {@link Temporal#minus(TemporalAmount)}.
1118      * <pre>
1119      *   // these two lines are equivalent, but the second approach is recommended
1120      *   dateTime = thisDuration.subtractFrom(dateTime);
1121      *   dateTime = dateTime.minus(thisDuration);
1122      * </pre>
1123      * <p>
1124      * The calculation will subtract the seconds, then nanos.
1125      * Only non-zero amounts will be added.
1126      * <p>
1127      * This instance is immutable and unaffected by this method call.
1128      *
1129      * @param temporal  the temporal object to adjust, not null
1130      * @return an object of the same type with the adjustment made, not null
1131      * @throws DateTimeException if unable to subtract
1132      * @throws ArithmeticException if numeric overflow occurs
1133      */
1134     @Override
1135     public Temporal subtractFrom(Temporal temporal) {
1136         if (seconds != 0) {
1137             temporal = temporal.minus(seconds, SECONDS);
1138         }
1139         if (nanos != 0) {
1140             temporal = temporal.minus(nanos, NANOS);
1141         }
1142         return temporal;
1143     }
1144 
1145     //-----------------------------------------------------------------------
1146     /**
1147      * Gets the number of days in this duration.
1148      * <p>
1149      * This returns the total number of days in the duration by dividing the
1150      * number of seconds by 86400.
1151      * This is based on the standard definition of a day as 24 hours.
1152      * <p>
1153      * This instance is immutable and unaffected by this method call.
1154      *
1155      * @return the number of days in the duration, may be negative
1156      */
1157     public long toDays() {
1158         return seconds / SECONDS_PER_DAY;
1159     }
1160 
1161     /**
1162      * Gets the number of hours in this duration.
1163      * <p>
1164      * This returns the total number of hours in the duration by dividing the
1165      * number of seconds by 3600.
1166      * <p>
1167      * This instance is immutable and unaffected by this method call.
1168      *
1169      * @return the number of hours in the duration, may be negative
1170      */
1171     public long toHours() {
1172         return seconds / SECONDS_PER_HOUR;
1173     }
1174 
1175     /**
1176      * Gets the number of minutes in this duration.
1177      * <p>
1178      * This returns the total number of minutes in the duration by dividing the
1179      * number of seconds by 60.
1180      * <p>
1181      * This instance is immutable and unaffected by this method call.
1182      *
1183      * @return the number of minutes in the duration, may be negative
1184      */
1185     public long toMinutes() {
1186         return seconds / SECONDS_PER_MINUTE;
1187     }
1188 
1189     /**
1190      * Gets the number of seconds in this duration.
1191      * <p>
1192      * This returns the total number of whole seconds in the duration.
1193      * <p>
1194      * This instance is immutable and unaffected by this method call.
1195      *
1196      * @return the whole seconds part of the length of the duration, positive or negative
1197      * @since 9
1198      */
1199     public long toSeconds() {
1200         return seconds;
1201     }
1202 
1203     /**
1204      * Converts this duration to the total length in milliseconds.
1205      * <p>
1206      * If this duration is too large to fit in a {@code long} milliseconds, then an
1207      * exception is thrown.
1208      * <p>
1209      * If this duration has greater than millisecond precision, then the conversion
1210      * will drop any excess precision information as though the amount in nanoseconds
1211      * was subject to integer division by one million.
1212      *
1213      * @return the total length of the duration in milliseconds
1214      * @throws ArithmeticException if numeric overflow occurs
1215      */
1216     public long toMillis() {
1217         long tempSeconds = seconds;
1218         long tempNanos = nanos;
1219         if (tempSeconds < 0) {
1220             // change the seconds and nano value to
1221             // handle Long.MIN_VALUE case
1222             tempSeconds = tempSeconds + 1;
1223             tempNanos = tempNanos - NANOS_PER_SECOND;
1224         }
1225         long millis = Math.multiplyExact(tempSeconds, 1000);
1226         millis = Math.addExact(millis, tempNanos / NANOS_PER_MILLI);
1227         return millis;
1228     }
1229 
1230     /**
1231      * Converts this duration to the total length in nanoseconds expressed as a {@code long}.
1232      * <p>
1233      * If this duration is too large to fit in a {@code long} nanoseconds, then an
1234      * exception is thrown.
1235      *
1236      * @return the total length of the duration in nanoseconds
1237      * @throws ArithmeticException if numeric overflow occurs
1238      */
1239     public long toNanos() {
1240         long tempSeconds = seconds;
1241         long tempNanos = nanos;
1242         if (tempSeconds < 0) {
1243             // change the seconds and nano value to
1244             // handle Long.MIN_VALUE case
1245             tempSeconds = tempSeconds + 1;
1246             tempNanos = tempNanos - NANOS_PER_SECOND;
1247         }
1248         long totalNanos = Math.multiplyExact(tempSeconds, NANOS_PER_SECOND);
1249         totalNanos = Math.addExact(totalNanos, tempNanos);
1250         return totalNanos;
1251     }
1252 
1253     /**
1254      * Extracts the number of days in the duration.
1255      * <p>
1256      * This returns the total number of days in the duration by dividing the
1257      * number of seconds by 86400.
1258      * This is based on the standard definition of a day as 24 hours.
1259      * <p>
1260      * This instance is immutable and unaffected by this method call.
1261      *
1262      * @return the number of days in the duration, may be negative
1263      * @since 9
1264      */
1265     public long toDaysPart(){
1266         return seconds / SECONDS_PER_DAY;
1267     }
1268 
1269     /**
1270      * Extracts the number of hours part in the duration.
1271      * <p>
1272      * This returns the number of remaining hours when dividing {@link #toHours}
1273      * by hours in a day.
1274      * This is based on the standard definition of a day as 24 hours.
1275      * <p>
1276      * This instance is immutable and unaffected by this method call.
1277      *
1278      * @return the number of hours part in the duration, may be negative
1279      * @since 9
1280      */
1281     public int toHoursPart(){
1282         return (int) (toHours() % 24);
1283     }
1284 
1285     /**
1286      * Extracts the number of minutes part in the duration.
1287      * <p>
1288      * This returns the number of remaining minutes when dividing {@link #toMinutes}
1289      * by minutes in an hour.
1290      * This is based on the standard definition of an hour as 60 minutes.
1291      * <p>
1292      * This instance is immutable and unaffected by this method call.
1293      *
1294      * @return the number of minutes parts in the duration, may be negative
1295      * @since 9
1296      */
1297     public int toMinutesPart(){
1298         return (int) (toMinutes() % MINUTES_PER_HOUR);
1299     }
1300 
1301     /**
1302      * Extracts the number of seconds part in the duration.
1303      * <p>
1304      * This returns the remaining seconds when dividing {@link #toSeconds}
1305      * by seconds in a minute.
1306      * This is based on the standard definition of a minute as 60 seconds.
1307      * <p>
1308      * This instance is immutable and unaffected by this method call.
1309      *
1310      * @return the number of seconds parts in the duration, may be negative
1311      * @since 9
1312      */
1313     public int toSecondsPart(){
1314         return (int) (seconds % SECONDS_PER_MINUTE);
1315     }
1316 
1317     /**
1318      * Extracts the number of milliseconds part of the duration.
1319      * <p>
1320      * This returns the milliseconds part by dividing the number of nanoseconds by 1,000,000.
1321      * The length of the duration is stored using two fields - seconds and nanoseconds.
1322      * The nanoseconds part is a value from 0 to 999,999,999 that is an adjustment to
1323      * the length in seconds.
1324      * The total duration is defined by calling {@link #getNano()} and {@link #getSeconds()}.
1325      * <p>
1326      * This instance is immutable and unaffected by this method call.
1327      *
1328      * @return the number of milliseconds part of the duration.
1329      * @since 9
1330      */
1331     public int toMillisPart(){
1332         return nanos / 1000_000;
1333     }
1334 
1335     /**
1336      * Get the nanoseconds part within seconds of the duration.
1337      * <p>
1338      * The length of the duration is stored using two fields - seconds and nanoseconds.
1339      * The nanoseconds part is a value from 0 to 999,999,999 that is an adjustment to
1340      * the length in seconds.
1341      * The total duration is defined by calling {@link #getNano()} and {@link #getSeconds()}.
1342      * <p>
1343      * This instance is immutable and unaffected by this method call.
1344      *
1345      * @return the nanoseconds within the second part of the length of the duration, from 0 to 999,999,999
1346      * @since 9
1347      */
1348     public int toNanosPart(){
1349         return nanos;
1350     }
1351 
1352 
1353     //-----------------------------------------------------------------------
1354     /**
1355      * Returns a copy of this {@code Duration} truncated to the specified unit.
1356      * <p>
1357      * Truncating the duration returns a copy of the original with conceptual fields
1358      * smaller than the specified unit set to zero.
1359      * For example, truncating with the {@link ChronoUnit#MINUTES MINUTES} unit will
1360      * round down to the nearest minute, setting the seconds and nanoseconds to zero.
1361      * <p>
1362      * The unit must have a {@linkplain TemporalUnit#getDuration() duration}
1363      * that divides into the length of a standard day without remainder.
1364      * This includes all supplied time units on {@link ChronoUnit} and
1365      * {@link ChronoUnit#DAYS DAYS}. Other ChronoUnits throw an exception.
1366      * <p>
1367      * This instance is immutable and unaffected by this method call.
1368      *
1369      * @param unit the unit to truncate to, not null
1370      * @return a {@code Duration} based on this duration with the time truncated, not null
1371      * @throws DateTimeException if the unit is invalid for truncation
1372      * @throws UnsupportedTemporalTypeException if the unit is not supported

1373      */
1374     public Duration truncatedTo(TemporalUnit unit) {
1375         Objects.requireNonNull(unit, "unit");
1376         if (unit == ChronoUnit.SECONDS && (seconds >= 0 || nanos == 0)) {
1377             return new Duration(seconds, 0);
1378         } else if (unit == ChronoUnit.NANOS) {
1379             return this;
1380         }
1381         Duration unitDur = unit.getDuration();
1382         if (unitDur.getSeconds() > LocalTime.SECONDS_PER_DAY) {
1383             throw new UnsupportedTemporalTypeException("Unit is too large to be used for truncation");
1384         }
1385         long dur = unitDur.toNanos();
1386         if ((LocalTime.NANOS_PER_DAY % dur) != 0) {
1387             throw new UnsupportedTemporalTypeException("Unit must divide into a standard day without remainder");
1388         }
1389         long nod = (seconds % LocalTime.SECONDS_PER_DAY) * LocalTime.NANOS_PER_SECOND + nanos;
1390         long result = (nod / dur) * dur ;
1391         return plusNanos(result - nod);
1392     }
1393 
1394     //-----------------------------------------------------------------------
1395     /**
1396      * Compares this duration to the specified {@code Duration}.
1397      * <p>
1398      * The comparison is based on the total length of the durations.
1399      * It is "consistent with equals", as defined by {@link Comparable}.
1400      *
1401      * @param otherDuration the other duration to compare to, not null
1402      * @return the comparator value, negative if less, positive if greater
1403      */
1404     @Override
1405     public int compareTo(Duration otherDuration) {
1406         int cmp = Long.compare(seconds, otherDuration.seconds);
1407         if (cmp != 0) {
1408             return cmp;
1409         }
1410         return nanos - otherDuration.nanos;
1411     }
1412 
1413     //-----------------------------------------------------------------------
1414     /**
1415      * Checks if this duration is equal to the specified {@code Duration}.
1416      * <p>
1417      * The comparison is based on the total length of the durations.
1418      *
1419      * @param otherDuration the other duration, null returns false
1420      * @return true if the other duration is equal to this one
1421      */
1422     @Override
1423     public boolean equals(Object otherDuration) {
1424         if (this == otherDuration) {
1425             return true;
1426         }
1427         if (otherDuration instanceof Duration) {
1428             Duration other = (Duration) otherDuration;
1429             return this.seconds == other.seconds &&
1430                    this.nanos == other.nanos;
1431         }
1432         return false;
1433     }
1434 
1435     /**
1436      * A hash code for this duration.
1437      *
1438      * @return a suitable hash code
1439      */
1440     @Override
1441     public int hashCode() {
1442         return ((int) (seconds ^ (seconds >>> 32))) + (51 * nanos);
1443     }
1444 
1445     //-----------------------------------------------------------------------
1446     /**
1447      * A string representation of this duration using ISO-8601 seconds
1448      * based representation, such as {@code PT8H6M12.345S}.
1449      * <p>
1450      * The format of the returned string will be {@code PTnHnMnS}, where n is
1451      * the relevant hours, minutes or seconds part of the duration.
1452      * Any fractional seconds are placed after a decimal point in the seconds section.
1453      * If a section has a zero value, it is omitted.
1454      * The hours, minutes and seconds will all have the same sign.
1455      * <p>
1456      * Examples:
1457      * <pre>
1458      *    "20.345 seconds"                 -- "PT20.345S
1459      *    "15 minutes" (15 * 60 seconds)   -- "PT15M"
1460      *    "10 hours" (10 * 3600 seconds)   -- "PT10H"
1461      *    "2 days" (2 * 86400 seconds)     -- "PT48H"
1462      * </pre>
1463      * Note that multiples of 24 hours are not output as days to avoid confusion
1464      * with {@code Period}.
1465      *
1466      * @return an ISO-8601 representation of this duration, not null
1467      */
1468     @Override
1469     public String toString() {
1470         if (this == ZERO) {
1471             return "PT0S";
1472         }
1473         long effectiveTotalSecs = seconds;
1474         if (seconds < 0 && nanos > 0) {
1475             effectiveTotalSecs++;
1476         }
1477         long hours = effectiveTotalSecs / SECONDS_PER_HOUR;
1478         int minutes = (int) ((effectiveTotalSecs % SECONDS_PER_HOUR) / SECONDS_PER_MINUTE);
1479         int secs = (int) (effectiveTotalSecs % SECONDS_PER_MINUTE);
1480         StringBuilder buf = new StringBuilder(24);
1481         buf.append("PT");
1482         if (hours != 0) {
1483             buf.append(hours).append('H');
1484         }
1485         if (minutes != 0) {
1486             buf.append(minutes).append('M');
1487         }
1488         if (secs == 0 && nanos == 0 && buf.length() > 2) {
1489             return buf.toString();
1490         }
1491         if (seconds < 0 && nanos > 0) {
1492             if (secs == 0) {
1493                 buf.append("-0");
1494             } else {
1495                 buf.append(secs);
1496             }
1497         } else {
1498             buf.append(secs);
1499         }
1500         if (nanos > 0) {
1501             int pos = buf.length();
1502             if (seconds < 0) {
1503                 buf.append(2 * NANOS_PER_SECOND - nanos);
1504             } else {
1505                 buf.append(nanos + NANOS_PER_SECOND);
1506             }
1507             while (buf.charAt(buf.length() - 1) == '0') {
1508                 buf.setLength(buf.length() - 1);
1509             }
1510             buf.setCharAt(pos, '.');
1511         }
1512         buf.append('S');
1513         return buf.toString();
1514     }
1515 
1516     //-----------------------------------------------------------------------
1517     /**
1518      * Writes the object using a
1519      * <a href="../../serialized-form.html#java.time.Ser">dedicated serialized form</a>.
1520      * @serialData
1521      * <pre>
1522      *  out.writeByte(1);  // identifies a Duration
1523      *  out.writeLong(seconds);
1524      *  out.writeInt(nanos);
1525      * </pre>
1526      *
1527      * @return the instance of {@code Ser}, not null
1528      */
1529     private Object writeReplace() {
1530         return new Ser(Ser.DURATION_TYPE, this);
1531     }
1532 
1533     /**
1534      * Defend against malicious streams.
1535      *
1536      * @param s the stream to read
1537      * @throws InvalidObjectException always
1538      */
1539     private void readObject(ObjectInputStream s) throws InvalidObjectException {
1540         throw new InvalidObjectException("Deserialization via serialization delegate");
1541     }
1542 
1543     void writeExternal(DataOutput out) throws IOException {
1544         out.writeLong(seconds);
1545         out.writeInt(nanos);
1546     }
1547 
1548     static Duration readExternal(DataInput in) throws IOException {
1549         long seconds = in.readLong();
1550         int nanos = in.readInt();
1551         return Duration.ofSeconds(seconds, nanos);
1552     }
1553 
1554 }
--- EOF ---