1 /* 2 * Copyright (c) 2012, 2022, 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 period 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 period 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 period 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 try { 490 return ofNanos(startInclusive.until(endExclusive, NANOS)); 491 } catch (DateTimeException | ArithmeticException ex) { 492 long secs = startInclusive.until(endExclusive, SECONDS); 493 long nanos; 494 try { 495 nanos = endExclusive.getLong(NANO_OF_SECOND) - startInclusive.getLong(NANO_OF_SECOND); 496 if (secs > 0 && nanos < 0) { 497 secs++; 498 } else if (secs < 0 && nanos > 0) { 499 secs--; 500 } 501 } catch (DateTimeException ex2) { 502 nanos = 0; 503 } 504 return ofSeconds(secs, nanos); 505 } 506 } 507 508 //----------------------------------------------------------------------- 509 /** 510 * Obtains an instance of {@code Duration} using seconds and nanoseconds. 511 * 512 * @param seconds the length of the duration in seconds, positive or negative 513 * @param nanoAdjustment the nanosecond adjustment within the second, from 0 to 999,999,999 514 */ 515 private static Duration create(long seconds, int nanoAdjustment) { 516 if ((seconds | nanoAdjustment) == 0) { 517 return ZERO; 518 } 519 return new Duration(seconds, nanoAdjustment); 520 } 521 522 /** 523 * Constructs an instance of {@code Duration} using seconds and nanoseconds. 524 * 525 * @param seconds the length of the duration in seconds, positive or negative 526 * @param nanos the nanoseconds within the second, from 0 to 999,999,999 527 */ 528 private Duration(long seconds, int nanos) { 529 super(); 530 this.seconds = seconds; 531 this.nanos = nanos; 532 } 533 534 //----------------------------------------------------------------------- 535 /** 536 * Gets the value of the requested unit. 537 * <p> 538 * This returns a value for each of the two supported units, 539 * {@link ChronoUnit#SECONDS SECONDS} and {@link ChronoUnit#NANOS NANOS}. 540 * All other units throw an exception. 541 * 542 * @param unit the {@code TemporalUnit} for which to return the value 543 * @return the long value of the unit 544 * @throws DateTimeException if the unit is not supported 545 * @throws UnsupportedTemporalTypeException if the unit is not supported 546 */ 547 @Override 548 public long get(TemporalUnit unit) { 549 if (unit == SECONDS) { 550 return seconds; 551 } else if (unit == NANOS) { 552 return nanos; 553 } else { 554 throw new UnsupportedTemporalTypeException("Unsupported unit: " + unit); 555 } 556 } 557 558 /** 559 * Gets the set of units supported by this duration. 560 * <p> 561 * The supported units are {@link ChronoUnit#SECONDS SECONDS}, 562 * and {@link ChronoUnit#NANOS NANOS}. 563 * They are returned in the order seconds, nanos. 564 * <p> 565 * This set can be used in conjunction with {@link #get(TemporalUnit)} 566 * to access the entire state of the duration. 567 * 568 * @return a list containing the seconds and nanos units, not null 569 */ 570 @Override 571 public List<TemporalUnit> getUnits() { 572 return DurationUnits.UNITS; 573 } 574 575 /** 576 * Private class to delay initialization of this list until needed. 577 * The circular dependency between Duration and ChronoUnit prevents 578 * the simple initialization in Duration. 579 */ 580 private static class DurationUnits { 581 static final List<TemporalUnit> UNITS = List.of(SECONDS, NANOS); 582 } 583 584 //----------------------------------------------------------------------- 585 /** 586 * Checks if this duration is positive, excluding zero. 587 * <p> 588 * A {@code Duration} represents a directed distance between two points on 589 * the time-line and can therefore be positive, zero or negative. 590 * This method checks whether the length is greater than zero. 591 * 592 * @return true if this duration has a total length greater than zero 593 * @since 18 594 */ 595 public boolean isPositive() { 596 return (seconds | nanos) > 0; 597 } 598 599 /** 600 * Checks if this duration is zero length. 601 * <p> 602 * A {@code Duration} represents a directed distance between two points on 603 * the time-line and can therefore be positive, zero or negative. 604 * This method checks whether the length is zero. 605 * 606 * @return true if this duration has a total length equal to zero 607 */ 608 public boolean isZero() { 609 return (seconds | nanos) == 0; 610 } 611 612 /** 613 * Checks if this duration is negative, excluding zero. 614 * <p> 615 * A {@code Duration} represents a directed distance between two points on 616 * the time-line and can therefore be positive, zero or negative. 617 * This method checks whether the length is less than zero. 618 * 619 * @return true if this duration has a total length less than zero 620 */ 621 public boolean isNegative() { 622 return seconds < 0; 623 } 624 625 //----------------------------------------------------------------------- 626 /** 627 * Gets the number of seconds in this duration. 628 * <p> 629 * The length of the duration is stored using two fields - seconds and nanoseconds. 630 * The nanoseconds part is a value from 0 to 999,999,999 that is an adjustment to 631 * the length in seconds. 632 * The total duration is defined by calling this method and {@link #getNano()}. 633 * <p> 634 * A {@code Duration} represents a directed distance between two points on the time-line. 635 * A negative duration is expressed by the negative sign of the seconds part. 636 * A duration of -1 nanosecond is stored as -1 seconds plus 999,999,999 nanoseconds. 637 * 638 * @return the whole seconds part of the length of the duration, positive or negative 639 */ 640 public long getSeconds() { 641 return seconds; 642 } 643 644 /** 645 * Gets the number of nanoseconds within the second in this duration. 646 * <p> 647 * The length of the duration is stored using two fields - seconds and nanoseconds. 648 * The nanoseconds part is a value from 0 to 999,999,999 that is an adjustment to 649 * the length in seconds. 650 * The total duration is defined by calling this method and {@link #getSeconds()}. 651 * <p> 652 * A {@code Duration} represents a directed distance between two points on the time-line. 653 * A negative duration is expressed by the negative sign of the seconds part. 654 * A duration of -1 nanosecond is stored as -1 seconds plus 999,999,999 nanoseconds. 655 * 656 * @return the nanoseconds within the second part of the length of the duration, from 0 to 999,999,999 657 */ 658 public int getNano() { 659 return nanos; 660 } 661 662 //----------------------------------------------------------------------- 663 /** 664 * Returns a copy of this duration with the specified amount of seconds. 665 * <p> 666 * This returns a duration with the specified seconds, retaining the 667 * nano-of-second part of this duration. 668 * <p> 669 * This instance is immutable and unaffected by this method call. 670 * 671 * @param seconds the seconds to represent, may be negative 672 * @return a {@code Duration} based on this period with the requested seconds, not null 673 */ 674 public Duration withSeconds(long seconds) { 675 return create(seconds, nanos); 676 } 677 678 /** 679 * Returns a copy of this duration with the specified nano-of-second. 680 * <p> 681 * This returns a duration with the specified nano-of-second, retaining the 682 * seconds part of this duration. 683 * <p> 684 * This instance is immutable and unaffected by this method call. 685 * 686 * @param nanoOfSecond the nano-of-second to represent, from 0 to 999,999,999 687 * @return a {@code Duration} based on this period with the requested nano-of-second, not null 688 * @throws DateTimeException if the nano-of-second is invalid 689 */ 690 public Duration withNanos(int nanoOfSecond) { 691 NANO_OF_SECOND.checkValidIntValue(nanoOfSecond); 692 return create(seconds, nanoOfSecond); 693 } 694 695 //----------------------------------------------------------------------- 696 /** 697 * Returns a copy of this duration with the specified duration added. 698 * <p> 699 * This instance is immutable and unaffected by this method call. 700 * 701 * @param duration the duration to add, positive or negative, not null 702 * @return a {@code Duration} based on this duration with the specified duration added, not null 703 * @throws ArithmeticException if numeric overflow occurs 704 */ 705 public Duration plus(Duration duration) { 706 return plus(duration.getSeconds(), duration.getNano()); 707 } 708 709 /** 710 * Returns a copy of this duration with the specified duration added. 711 * <p> 712 * The duration amount is measured in terms of the specified unit. 713 * Only a subset of units are accepted by this method. 714 * The unit must either have an {@linkplain TemporalUnit#isDurationEstimated() exact duration} or 715 * be {@link ChronoUnit#DAYS} which is treated as 24 hours. Other units throw an exception. 716 * <p> 717 * This instance is immutable and unaffected by this method call. 718 * 719 * @param amountToAdd the amount to add, measured in terms of the unit, positive or negative 720 * @param unit the unit that the amount is measured in, must have an exact duration, not null 721 * @return a {@code Duration} based on this duration with the specified duration added, not null 722 * @throws UnsupportedTemporalTypeException if the unit is not supported 723 * @throws ArithmeticException if numeric overflow occurs 724 */ 725 public Duration plus(long amountToAdd, TemporalUnit unit) { 726 Objects.requireNonNull(unit, "unit"); 727 if (unit == DAYS) { 728 return plus(Math.multiplyExact(amountToAdd, SECONDS_PER_DAY), 0); 729 } 730 if (unit.isDurationEstimated()) { 731 throw new UnsupportedTemporalTypeException("Unit must not have an estimated duration"); 732 } 733 if (amountToAdd == 0) { 734 return this; 735 } 736 if (unit instanceof ChronoUnit chronoUnit) { 737 return switch (chronoUnit) { 738 case NANOS -> plusNanos(amountToAdd); 739 case MICROS -> plusSeconds((amountToAdd / (1000_000L * 1000)) * 1000).plusNanos((amountToAdd % (1000_000L * 1000)) * 1000); 740 case MILLIS -> plusMillis(amountToAdd); 741 case SECONDS -> plusSeconds(amountToAdd); 742 default -> plusSeconds(Math.multiplyExact(unit.getDuration().seconds, amountToAdd)); 743 }; 744 } 745 Duration duration = unit.getDuration().multipliedBy(amountToAdd); 746 return plusSeconds(duration.getSeconds()).plusNanos(duration.getNano()); 747 } 748 749 //----------------------------------------------------------------------- 750 /** 751 * Returns a copy of this duration with the specified duration in standard 24 hour days added. 752 * <p> 753 * The number of days is multiplied by 86400 to obtain the number of seconds to add. 754 * This is based on the standard definition of a day as 24 hours. 755 * <p> 756 * This instance is immutable and unaffected by this method call. 757 * 758 * @param daysToAdd the days to add, positive or negative 759 * @return a {@code Duration} based on this duration with the specified days added, not null 760 * @throws ArithmeticException if numeric overflow occurs 761 */ 762 public Duration plusDays(long daysToAdd) { 763 return plus(Math.multiplyExact(daysToAdd, SECONDS_PER_DAY), 0); 764 } 765 766 /** 767 * Returns a copy of this duration with the specified duration in hours added. 768 * <p> 769 * This instance is immutable and unaffected by this method call. 770 * 771 * @param hoursToAdd the hours to add, positive or negative 772 * @return a {@code Duration} based on this duration with the specified hours added, not null 773 * @throws ArithmeticException if numeric overflow occurs 774 */ 775 public Duration plusHours(long hoursToAdd) { 776 return plus(Math.multiplyExact(hoursToAdd, SECONDS_PER_HOUR), 0); 777 } 778 779 /** 780 * Returns a copy of this duration with the specified duration in minutes added. 781 * <p> 782 * This instance is immutable and unaffected by this method call. 783 * 784 * @param minutesToAdd the minutes to add, positive or negative 785 * @return a {@code Duration} based on this duration with the specified minutes added, not null 786 * @throws ArithmeticException if numeric overflow occurs 787 */ 788 public Duration plusMinutes(long minutesToAdd) { 789 return plus(Math.multiplyExact(minutesToAdd, SECONDS_PER_MINUTE), 0); 790 } 791 792 /** 793 * Returns a copy of this duration with the specified duration in seconds added. 794 * <p> 795 * This instance is immutable and unaffected by this method call. 796 * 797 * @param secondsToAdd the seconds to add, positive or negative 798 * @return a {@code Duration} based on this duration with the specified seconds added, not null 799 * @throws ArithmeticException if numeric overflow occurs 800 */ 801 public Duration plusSeconds(long secondsToAdd) { 802 return plus(secondsToAdd, 0); 803 } 804 805 /** 806 * Returns a copy of this duration with the specified duration in milliseconds added. 807 * <p> 808 * This instance is immutable and unaffected by this method call. 809 * 810 * @param millisToAdd the milliseconds to add, positive or negative 811 * @return a {@code Duration} based on this duration with the specified milliseconds added, not null 812 * @throws ArithmeticException if numeric overflow occurs 813 */ 814 public Duration plusMillis(long millisToAdd) { 815 return plus(millisToAdd / 1000, (millisToAdd % 1000) * 1000_000); 816 } 817 818 /** 819 * Returns a copy of this duration with the specified duration in nanoseconds added. 820 * <p> 821 * This instance is immutable and unaffected by this method call. 822 * 823 * @param nanosToAdd the nanoseconds to add, positive or negative 824 * @return a {@code Duration} based on this duration with the specified nanoseconds added, not null 825 * @throws ArithmeticException if numeric overflow occurs 826 */ 827 public Duration plusNanos(long nanosToAdd) { 828 return plus(0, nanosToAdd); 829 } 830 831 /** 832 * Returns a copy of this duration with the specified duration added. 833 * <p> 834 * This instance is immutable and unaffected by this method call. 835 * 836 * @param secondsToAdd the seconds to add, positive or negative 837 * @param nanosToAdd the nanos to add, positive or negative 838 * @return a {@code Duration} based on this duration with the specified seconds added, not null 839 * @throws ArithmeticException if numeric overflow occurs 840 */ 841 private Duration plus(long secondsToAdd, long nanosToAdd) { 842 if ((secondsToAdd | nanosToAdd) == 0) { 843 return this; 844 } 845 long epochSec = Math.addExact(seconds, secondsToAdd); 846 epochSec = Math.addExact(epochSec, nanosToAdd / NANOS_PER_SECOND); 847 nanosToAdd = nanosToAdd % NANOS_PER_SECOND; 848 long nanoAdjustment = nanos + nanosToAdd; // safe int+NANOS_PER_SECOND 849 return ofSeconds(epochSec, nanoAdjustment); 850 } 851 852 //----------------------------------------------------------------------- 853 /** 854 * Returns a copy of this duration with the specified duration subtracted. 855 * <p> 856 * This instance is immutable and unaffected by this method call. 857 * 858 * @param duration the duration to subtract, positive or negative, not null 859 * @return a {@code Duration} based on this duration with the specified duration subtracted, not null 860 * @throws ArithmeticException if numeric overflow occurs 861 */ 862 public Duration minus(Duration duration) { 863 long secsToSubtract = duration.getSeconds(); 864 int nanosToSubtract = duration.getNano(); 865 if (secsToSubtract == Long.MIN_VALUE) { 866 return plus(Long.MAX_VALUE, -nanosToSubtract).plus(1, 0); 867 } 868 return plus(-secsToSubtract, -nanosToSubtract); 869 } 870 871 /** 872 * Returns a copy of this duration with the specified duration subtracted. 873 * <p> 874 * The duration amount is measured in terms of the specified unit. 875 * Only a subset of units are accepted by this method. 876 * The unit must either have an {@linkplain TemporalUnit#isDurationEstimated() exact duration} or 877 * be {@link ChronoUnit#DAYS} which is treated as 24 hours. Other units throw an exception. 878 * <p> 879 * This instance is immutable and unaffected by this method call. 880 * 881 * @param amountToSubtract the amount to subtract, measured in terms of the unit, positive or negative 882 * @param unit the unit that the amount is measured in, must have an exact duration, not null 883 * @return a {@code Duration} based on this duration with the specified duration subtracted, not null 884 * @throws ArithmeticException if numeric overflow occurs 885 */ 886 public Duration minus(long amountToSubtract, TemporalUnit unit) { 887 return (amountToSubtract == Long.MIN_VALUE ? plus(Long.MAX_VALUE, unit).plus(1, unit) : plus(-amountToSubtract, unit)); 888 } 889 890 //----------------------------------------------------------------------- 891 /** 892 * Returns a copy of this duration with the specified duration in standard 24 hour days subtracted. 893 * <p> 894 * The number of days is multiplied by 86400 to obtain the number of seconds to subtract. 895 * This is based on the standard definition of a day as 24 hours. 896 * <p> 897 * This instance is immutable and unaffected by this method call. 898 * 899 * @param daysToSubtract the days to subtract, positive or negative 900 * @return a {@code Duration} based on this duration with the specified days subtracted, not null 901 * @throws ArithmeticException if numeric overflow occurs 902 */ 903 public Duration minusDays(long daysToSubtract) { 904 return (daysToSubtract == Long.MIN_VALUE ? plusDays(Long.MAX_VALUE).plusDays(1) : plusDays(-daysToSubtract)); 905 } 906 907 /** 908 * Returns a copy of this duration with the specified duration in hours subtracted. 909 * <p> 910 * The number of hours is multiplied by 3600 to obtain the number of seconds to subtract. 911 * <p> 912 * This instance is immutable and unaffected by this method call. 913 * 914 * @param hoursToSubtract the hours to subtract, positive or negative 915 * @return a {@code Duration} based on this duration with the specified hours subtracted, not null 916 * @throws ArithmeticException if numeric overflow occurs 917 */ 918 public Duration minusHours(long hoursToSubtract) { 919 return (hoursToSubtract == Long.MIN_VALUE ? plusHours(Long.MAX_VALUE).plusHours(1) : plusHours(-hoursToSubtract)); 920 } 921 922 /** 923 * Returns a copy of this duration with the specified duration in minutes subtracted. 924 * <p> 925 * The number of hours is multiplied by 60 to obtain the number of seconds to subtract. 926 * <p> 927 * This instance is immutable and unaffected by this method call. 928 * 929 * @param minutesToSubtract the minutes to subtract, positive or negative 930 * @return a {@code Duration} based on this duration with the specified minutes subtracted, not null 931 * @throws ArithmeticException if numeric overflow occurs 932 */ 933 public Duration minusMinutes(long minutesToSubtract) { 934 return (minutesToSubtract == Long.MIN_VALUE ? plusMinutes(Long.MAX_VALUE).plusMinutes(1) : plusMinutes(-minutesToSubtract)); 935 } 936 937 /** 938 * Returns a copy of this duration with the specified duration in seconds subtracted. 939 * <p> 940 * This instance is immutable and unaffected by this method call. 941 * 942 * @param secondsToSubtract the seconds to subtract, positive or negative 943 * @return a {@code Duration} based on this duration with the specified seconds subtracted, not null 944 * @throws ArithmeticException if numeric overflow occurs 945 */ 946 public Duration minusSeconds(long secondsToSubtract) { 947 return (secondsToSubtract == Long.MIN_VALUE ? plusSeconds(Long.MAX_VALUE).plusSeconds(1) : plusSeconds(-secondsToSubtract)); 948 } 949 950 /** 951 * Returns a copy of this duration with the specified duration in milliseconds subtracted. 952 * <p> 953 * This instance is immutable and unaffected by this method call. 954 * 955 * @param millisToSubtract the milliseconds to subtract, positive or negative 956 * @return a {@code Duration} based on this duration with the specified milliseconds subtracted, not null 957 * @throws ArithmeticException if numeric overflow occurs 958 */ 959 public Duration minusMillis(long millisToSubtract) { 960 return (millisToSubtract == Long.MIN_VALUE ? plusMillis(Long.MAX_VALUE).plusMillis(1) : plusMillis(-millisToSubtract)); 961 } 962 963 /** 964 * Returns a copy of this duration with the specified duration in nanoseconds subtracted. 965 * <p> 966 * This instance is immutable and unaffected by this method call. 967 * 968 * @param nanosToSubtract the nanoseconds to subtract, positive or negative 969 * @return a {@code Duration} based on this duration with the specified nanoseconds subtracted, not null 970 * @throws ArithmeticException if numeric overflow occurs 971 */ 972 public Duration minusNanos(long nanosToSubtract) { 973 return (nanosToSubtract == Long.MIN_VALUE ? plusNanos(Long.MAX_VALUE).plusNanos(1) : plusNanos(-nanosToSubtract)); 974 } 975 976 //----------------------------------------------------------------------- 977 /** 978 * Returns a copy of this duration multiplied by the scalar. 979 * <p> 980 * This instance is immutable and unaffected by this method call. 981 * 982 * @param multiplicand the value to multiply the duration by, positive or negative 983 * @return a {@code Duration} based on this duration multiplied by the specified scalar, not null 984 * @throws ArithmeticException if numeric overflow occurs 985 */ 986 public Duration multipliedBy(long multiplicand) { 987 if (multiplicand == 0) { 988 return ZERO; 989 } 990 if (multiplicand == 1) { 991 return this; 992 } 993 return create(toBigDecimalSeconds().multiply(BigDecimal.valueOf(multiplicand))); 994 } 995 996 /** 997 * Returns a copy of this duration divided by the specified value. 998 * <p> 999 * This instance is immutable and unaffected by this method call. 1000 * 1001 * @param divisor the value to divide the duration by, positive or negative, not zero 1002 * @return a {@code Duration} based on this duration divided by the specified divisor, not null 1003 * @throws ArithmeticException if the divisor is zero or if numeric overflow occurs 1004 */ 1005 public Duration dividedBy(long divisor) { 1006 if (divisor == 0) { 1007 throw new ArithmeticException("Cannot divide by zero"); 1008 } 1009 if (divisor == 1) { 1010 return this; 1011 } 1012 return create(toBigDecimalSeconds().divide(BigDecimal.valueOf(divisor), RoundingMode.DOWN)); 1013 } 1014 1015 /** 1016 * Returns number of whole times a specified Duration occurs within this Duration. 1017 * <p> 1018 * This instance is immutable and unaffected by this method call. 1019 * 1020 * @param divisor the value to divide the duration by, positive or negative, not null 1021 * @return number of whole times, rounded toward zero, a specified 1022 * {@code Duration} occurs within this Duration, may be negative 1023 * @throws ArithmeticException if the divisor is zero, or if numeric overflow occurs 1024 * @since 9 1025 */ 1026 public long dividedBy(Duration divisor) { 1027 Objects.requireNonNull(divisor, "divisor"); 1028 BigDecimal dividendBigD = toBigDecimalSeconds(); 1029 BigDecimal divisorBigD = divisor.toBigDecimalSeconds(); 1030 return dividendBigD.divideToIntegralValue(divisorBigD).longValueExact(); 1031 } 1032 1033 /** 1034 * Converts this duration to the total length in seconds and 1035 * fractional nanoseconds expressed as a {@code BigDecimal}. 1036 * 1037 * @return the total length of the duration in seconds, with a scale of 9, not null 1038 */ 1039 private BigDecimal toBigDecimalSeconds() { 1040 return BigDecimal.valueOf(seconds).add(BigDecimal.valueOf(nanos, 9)); 1041 } 1042 1043 /** 1044 * Creates an instance of {@code Duration} from a number of seconds. 1045 * 1046 * @param seconds the number of seconds, up to scale 9, positive or negative 1047 * @return a {@code Duration}, not null 1048 * @throws ArithmeticException if numeric overflow occurs 1049 */ 1050 private static Duration create(BigDecimal seconds) { 1051 BigInteger nanos = seconds.movePointRight(9).toBigIntegerExact(); 1052 BigInteger[] divRem = nanos.divideAndRemainder(BI_NANOS_PER_SECOND); 1053 if (divRem[0].bitLength() > 63) { 1054 throw new ArithmeticException("Exceeds capacity of Duration: " + nanos); 1055 } 1056 return ofSeconds(divRem[0].longValue(), divRem[1].intValue()); 1057 } 1058 1059 //----------------------------------------------------------------------- 1060 /** 1061 * Returns a copy of this duration with the length negated. 1062 * <p> 1063 * This method swaps the sign of the total length of this duration. 1064 * For example, {@code PT1.3S} will be returned as {@code PT-1.3S}. 1065 * <p> 1066 * This instance is immutable and unaffected by this method call. 1067 * 1068 * @return a {@code Duration} based on this duration with the amount negated, not null 1069 * @throws ArithmeticException if numeric overflow occurs 1070 */ 1071 public Duration negated() { 1072 return multipliedBy(-1); 1073 } 1074 1075 /** 1076 * Returns a copy of this duration with a positive length. 1077 * <p> 1078 * This method returns a positive duration by effectively removing the sign from any negative total length. 1079 * For example, {@code PT-1.3S} will be returned as {@code PT1.3S}. 1080 * <p> 1081 * This instance is immutable and unaffected by this method call. 1082 * 1083 * @return a {@code Duration} based on this duration with an absolute length, not null 1084 * @throws ArithmeticException if numeric overflow occurs 1085 */ 1086 public Duration abs() { 1087 return isNegative() ? negated() : this; 1088 } 1089 1090 //------------------------------------------------------------------------- 1091 /** 1092 * Adds this duration to the specified temporal object. 1093 * <p> 1094 * This returns a temporal object of the same observable type as the input 1095 * with this duration added. 1096 * <p> 1097 * In most cases, it is clearer to reverse the calling pattern by using 1098 * {@link Temporal#plus(TemporalAmount)}. 1099 * <pre> 1100 * // these two lines are equivalent, but the second approach is recommended 1101 * dateTime = thisDuration.addTo(dateTime); 1102 * dateTime = dateTime.plus(thisDuration); 1103 * </pre> 1104 * <p> 1105 * The calculation will add the seconds, then nanos. 1106 * Only non-zero amounts will be added. 1107 * <p> 1108 * This instance is immutable and unaffected by this method call. 1109 * 1110 * @param temporal the temporal object to adjust, not null 1111 * @return an object of the same type with the adjustment made, not null 1112 * @throws DateTimeException if unable to add 1113 * @throws ArithmeticException if numeric overflow occurs 1114 */ 1115 @Override 1116 public Temporal addTo(Temporal temporal) { 1117 if (seconds != 0) { 1118 temporal = temporal.plus(seconds, SECONDS); 1119 } 1120 if (nanos != 0) { 1121 temporal = temporal.plus(nanos, NANOS); 1122 } 1123 return temporal; 1124 } 1125 1126 /** 1127 * Subtracts this duration from the specified temporal object. 1128 * <p> 1129 * This returns a temporal object of the same observable type as the input 1130 * with this duration subtracted. 1131 * <p> 1132 * In most cases, it is clearer to reverse the calling pattern by using 1133 * {@link Temporal#minus(TemporalAmount)}. 1134 * <pre> 1135 * // these two lines are equivalent, but the second approach is recommended 1136 * dateTime = thisDuration.subtractFrom(dateTime); 1137 * dateTime = dateTime.minus(thisDuration); 1138 * </pre> 1139 * <p> 1140 * The calculation will subtract the seconds, then nanos. 1141 * Only non-zero amounts will be added. 1142 * <p> 1143 * This instance is immutable and unaffected by this method call. 1144 * 1145 * @param temporal the temporal object to adjust, not null 1146 * @return an object of the same type with the adjustment made, not null 1147 * @throws DateTimeException if unable to subtract 1148 * @throws ArithmeticException if numeric overflow occurs 1149 */ 1150 @Override 1151 public Temporal subtractFrom(Temporal temporal) { 1152 if (seconds != 0) { 1153 temporal = temporal.minus(seconds, SECONDS); 1154 } 1155 if (nanos != 0) { 1156 temporal = temporal.minus(nanos, NANOS); 1157 } 1158 return temporal; 1159 } 1160 1161 //----------------------------------------------------------------------- 1162 /** 1163 * Gets the number of days in this duration. 1164 * <p> 1165 * This returns the total number of days in the duration by dividing the 1166 * number of seconds by 86400. 1167 * This is based on the standard definition of a day as 24 hours. 1168 * <p> 1169 * This instance is immutable and unaffected by this method call. 1170 * 1171 * @return the number of days in the duration, may be negative 1172 */ 1173 public long toDays() { 1174 return seconds / SECONDS_PER_DAY; 1175 } 1176 1177 /** 1178 * Gets the number of hours in this duration. 1179 * <p> 1180 * This returns the total number of hours in the duration by dividing the 1181 * number of seconds by 3600. 1182 * <p> 1183 * This instance is immutable and unaffected by this method call. 1184 * 1185 * @return the number of hours in the duration, may be negative 1186 */ 1187 public long toHours() { 1188 return seconds / SECONDS_PER_HOUR; 1189 } 1190 1191 /** 1192 * Gets the number of minutes in this duration. 1193 * <p> 1194 * This returns the total number of minutes in the duration by dividing the 1195 * number of seconds by 60. 1196 * <p> 1197 * This instance is immutable and unaffected by this method call. 1198 * 1199 * @return the number of minutes in the duration, may be negative 1200 */ 1201 public long toMinutes() { 1202 return seconds / SECONDS_PER_MINUTE; 1203 } 1204 1205 /** 1206 * Gets the number of seconds in this duration. 1207 * <p> 1208 * This returns the total number of whole seconds in the duration. 1209 * <p> 1210 * This instance is immutable and unaffected by this method call. 1211 * 1212 * @return the whole seconds part of the length of the duration, positive or negative 1213 * @since 9 1214 */ 1215 public long toSeconds() { 1216 return seconds; 1217 } 1218 1219 /** 1220 * Converts this duration to the total length in milliseconds. 1221 * <p> 1222 * If this duration is too large to fit in a {@code long} milliseconds, then an 1223 * exception is thrown. 1224 * <p> 1225 * If this duration has greater than millisecond precision, then the conversion 1226 * will drop any excess precision information as though the amount in nanoseconds 1227 * was subject to integer division by one million. 1228 * 1229 * @return the total length of the duration in milliseconds 1230 * @throws ArithmeticException if numeric overflow occurs 1231 */ 1232 public long toMillis() { 1233 long tempSeconds = seconds; 1234 long tempNanos = nanos; 1235 if (tempSeconds < 0) { 1236 // change the seconds and nano value to 1237 // handle Long.MIN_VALUE case 1238 tempSeconds = tempSeconds + 1; 1239 tempNanos = tempNanos - NANOS_PER_SECOND; 1240 } 1241 long millis = Math.multiplyExact(tempSeconds, 1000); 1242 millis = Math.addExact(millis, tempNanos / NANOS_PER_MILLI); 1243 return millis; 1244 } 1245 1246 /** 1247 * Converts this duration to the total length in nanoseconds expressed as a {@code long}. 1248 * <p> 1249 * If this duration is too large to fit in a {@code long} nanoseconds, then an 1250 * exception is thrown. 1251 * 1252 * @return the total length of the duration in nanoseconds 1253 * @throws ArithmeticException if numeric overflow occurs 1254 */ 1255 public long toNanos() { 1256 long tempSeconds = seconds; 1257 long tempNanos = nanos; 1258 if (tempSeconds < 0) { 1259 // change the seconds and nano value to 1260 // handle Long.MIN_VALUE case 1261 tempSeconds = tempSeconds + 1; 1262 tempNanos = tempNanos - NANOS_PER_SECOND; 1263 } 1264 long totalNanos = Math.multiplyExact(tempSeconds, NANOS_PER_SECOND); 1265 totalNanos = Math.addExact(totalNanos, tempNanos); 1266 return totalNanos; 1267 } 1268 1269 /** 1270 * Extracts the number of days in the duration. 1271 * <p> 1272 * This returns the total number of days in the duration by dividing the 1273 * number of seconds by 86400. 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 * @apiNote 1278 * This method behaves exactly the same way as {@link #toDays()}. 1279 * 1280 * @return the number of days in the duration, may be negative 1281 * @since 9 1282 */ 1283 public long toDaysPart(){ 1284 return seconds / SECONDS_PER_DAY; 1285 } 1286 1287 /** 1288 * Extracts the number of hours part in the duration. 1289 * <p> 1290 * This returns the number of remaining hours when dividing {@link #toHours} 1291 * by hours in a day. 1292 * This is based on the standard definition of a day as 24 hours. 1293 * <p> 1294 * This instance is immutable and unaffected by this method call. 1295 * 1296 * @return the number of hours part in the duration, may be negative 1297 * @since 9 1298 */ 1299 public int toHoursPart(){ 1300 return (int) (toHours() % 24); 1301 } 1302 1303 /** 1304 * Extracts the number of minutes part in the duration. 1305 * <p> 1306 * This returns the number of remaining minutes when dividing {@link #toMinutes} 1307 * by minutes in an hour. 1308 * This is based on the standard definition of an hour as 60 minutes. 1309 * <p> 1310 * This instance is immutable and unaffected by this method call. 1311 * 1312 * @return the number of minutes parts in the duration, may be negative 1313 * @since 9 1314 */ 1315 public int toMinutesPart(){ 1316 return (int) (toMinutes() % MINUTES_PER_HOUR); 1317 } 1318 1319 /** 1320 * Extracts the number of seconds part in the duration. 1321 * <p> 1322 * This returns the remaining seconds when dividing {@link #toSeconds} 1323 * by seconds in a minute. 1324 * This is based on the standard definition of a minute as 60 seconds. 1325 * <p> 1326 * This instance is immutable and unaffected by this method call. 1327 * 1328 * @return the number of seconds parts in the duration, may be negative 1329 * @since 9 1330 */ 1331 public int toSecondsPart(){ 1332 return (int) (seconds % SECONDS_PER_MINUTE); 1333 } 1334 1335 /** 1336 * Extracts the number of milliseconds part of the duration. 1337 * <p> 1338 * This returns the milliseconds part by dividing the number of nanoseconds by 1,000,000. 1339 * The length of the duration is stored using two fields - seconds and nanoseconds. 1340 * The nanoseconds part is a value from 0 to 999,999,999 that is an adjustment to 1341 * the length in seconds. 1342 * The total duration is defined by calling {@link #getNano()} and {@link #getSeconds()}. 1343 * <p> 1344 * This instance is immutable and unaffected by this method call. 1345 * 1346 * @return the number of milliseconds part of the duration. 1347 * @since 9 1348 */ 1349 public int toMillisPart(){ 1350 return nanos / 1000_000; 1351 } 1352 1353 /** 1354 * Get the nanoseconds part within seconds of the duration. 1355 * <p> 1356 * The length of the duration is stored using two fields - seconds and nanoseconds. 1357 * The nanoseconds part is a value from 0 to 999,999,999 that is an adjustment to 1358 * the length in seconds. 1359 * The total duration is defined by calling {@link #getNano()} and {@link #getSeconds()}. 1360 * <p> 1361 * This instance is immutable and unaffected by this method call. 1362 * 1363 * @return the nanoseconds within the second part of the length of the duration, from 0 to 999,999,999 1364 * @since 9 1365 */ 1366 public int toNanosPart(){ 1367 return nanos; 1368 } 1369 1370 1371 //----------------------------------------------------------------------- 1372 /** 1373 * Returns a copy of this {@code Duration} truncated to the specified unit. 1374 * <p> 1375 * Truncating the duration returns a copy of the original with conceptual fields 1376 * smaller than the specified unit set to zero. 1377 * For example, truncating with the {@link ChronoUnit#MINUTES MINUTES} unit will 1378 * round down towards zero to the nearest minute, setting the seconds and 1379 * nanoseconds to zero. 1380 * <p> 1381 * The unit must have a {@linkplain TemporalUnit#getDuration() duration} 1382 * that divides into the length of a standard day without remainder. 1383 * This includes all 1384 * {@linkplain ChronoUnit#isTimeBased() time-based units on {@code ChronoUnit}} 1385 * and {@link ChronoUnit#DAYS DAYS}. Other ChronoUnits throw an exception. 1386 * <p> 1387 * This instance is immutable and unaffected by this method call. 1388 * 1389 * @param unit the unit to truncate to, not null 1390 * @return a {@code Duration} based on this duration with the time truncated, not null 1391 * @throws DateTimeException if the unit is invalid for truncation 1392 * @throws UnsupportedTemporalTypeException if the unit is not supported 1393 * @since 9 1394 */ 1395 public Duration truncatedTo(TemporalUnit unit) { 1396 Objects.requireNonNull(unit, "unit"); 1397 if (unit == ChronoUnit.SECONDS && (seconds >= 0 || nanos == 0)) { 1398 return new Duration(seconds, 0); 1399 } else if (unit == ChronoUnit.NANOS) { 1400 return this; 1401 } 1402 Duration unitDur = unit.getDuration(); 1403 if (unitDur.getSeconds() > LocalTime.SECONDS_PER_DAY) { 1404 throw new UnsupportedTemporalTypeException("Unit is too large to be used for truncation"); 1405 } 1406 long dur = unitDur.toNanos(); 1407 if ((LocalTime.NANOS_PER_DAY % dur) != 0) { 1408 throw new UnsupportedTemporalTypeException("Unit must divide into a standard day without remainder"); 1409 } 1410 long nod = (seconds % LocalTime.SECONDS_PER_DAY) * LocalTime.NANOS_PER_SECOND + nanos; 1411 long result = (nod / dur) * dur; 1412 return plusNanos(result - nod); 1413 } 1414 1415 //----------------------------------------------------------------------- 1416 /** 1417 * Compares this duration to the specified {@code Duration}. 1418 * <p> 1419 * The comparison is based on the total length of the durations. 1420 * It is "consistent with equals", as defined by {@link Comparable}. 1421 * 1422 * @param otherDuration the other duration to compare to, not null 1423 * @return the comparator value, negative if less, positive if greater 1424 */ 1425 @Override 1426 public int compareTo(Duration otherDuration) { 1427 int cmp = Long.compare(seconds, otherDuration.seconds); 1428 if (cmp != 0) { 1429 return cmp; 1430 } 1431 return nanos - otherDuration.nanos; 1432 } 1433 1434 //----------------------------------------------------------------------- 1435 /** 1436 * Checks if this duration is equal to the specified {@code Duration}. 1437 * <p> 1438 * The comparison is based on the total length of the durations. 1439 * 1440 * @param other the other duration, null returns false 1441 * @return true if the other duration is equal to this one 1442 */ 1443 @Override 1444 public boolean equals(Object other) { 1445 if (this == other) { 1446 return true; 1447 } 1448 return (other instanceof Duration otherDuration) 1449 && this.seconds == otherDuration.seconds 1450 && this.nanos == otherDuration.nanos; 1451 } 1452 1453 /** 1454 * A hash code for this duration. 1455 * 1456 * @return a suitable hash code 1457 */ 1458 @Override 1459 public int hashCode() { 1460 return ((int) (seconds ^ (seconds >>> 32))) + (51 * nanos); 1461 } 1462 1463 //----------------------------------------------------------------------- 1464 /** 1465 * A string representation of this duration using ISO-8601 seconds 1466 * based representation, such as {@code PT8H6M12.345S}. 1467 * <p> 1468 * The format of the returned string will be {@code PTnHnMnS}, where n is 1469 * the relevant hours, minutes or seconds part of the duration. 1470 * Any fractional seconds are placed after a decimal point in the seconds section. 1471 * If a section has a zero value, it is omitted. 1472 * The hours, minutes and seconds will all have the same sign. 1473 * <p> 1474 * Examples: 1475 * <pre> 1476 * "20.345 seconds" -- "PT20.345S 1477 * "15 minutes" (15 * 60 seconds) -- "PT15M" 1478 * "10 hours" (10 * 3600 seconds) -- "PT10H" 1479 * "2 days" (2 * 86400 seconds) -- "PT48H" 1480 * </pre> 1481 * Note that multiples of 24 hours are not output as days to avoid confusion 1482 * with {@code Period}. 1483 * 1484 * @return an ISO-8601 representation of this duration, not null 1485 */ 1486 @Override 1487 public String toString() { 1488 if (this == ZERO) { 1489 return "PT0S"; 1490 } 1491 long effectiveTotalSecs = seconds; 1492 if (seconds < 0 && nanos > 0) { 1493 effectiveTotalSecs++; 1494 } 1495 long hours = effectiveTotalSecs / SECONDS_PER_HOUR; 1496 int minutes = (int) ((effectiveTotalSecs % SECONDS_PER_HOUR) / SECONDS_PER_MINUTE); 1497 int secs = (int) (effectiveTotalSecs % SECONDS_PER_MINUTE); 1498 StringBuilder buf = new StringBuilder(24); 1499 buf.append("PT"); 1500 if (hours != 0) { 1501 buf.append(hours).append('H'); 1502 } 1503 if (minutes != 0) { 1504 buf.append(minutes).append('M'); 1505 } 1506 if (secs == 0 && nanos == 0 && buf.length() > 2) { 1507 return buf.toString(); 1508 } 1509 if (seconds < 0 && nanos > 0) { 1510 if (secs == 0) { 1511 buf.append("-0"); 1512 } else { 1513 buf.append(secs); 1514 } 1515 } else { 1516 buf.append(secs); 1517 } 1518 if (nanos > 0) { 1519 int pos = buf.length(); 1520 if (seconds < 0) { 1521 buf.append(2 * NANOS_PER_SECOND - nanos); 1522 } else { 1523 buf.append(nanos + NANOS_PER_SECOND); 1524 } 1525 while (buf.charAt(buf.length() - 1) == '0') { 1526 buf.setLength(buf.length() - 1); 1527 } 1528 buf.setCharAt(pos, '.'); 1529 } 1530 buf.append('S'); 1531 return buf.toString(); 1532 } 1533 1534 //----------------------------------------------------------------------- 1535 /** 1536 * Writes the object using a 1537 * <a href="{@docRoot}/serialized-form.html#java.time.Ser">dedicated serialized form</a>. 1538 * @serialData 1539 * <pre> 1540 * out.writeByte(1); // identifies a Duration 1541 * out.writeLong(seconds); 1542 * out.writeInt(nanos); 1543 * </pre> 1544 * 1545 * @return the instance of {@code Ser}, not null 1546 */ 1547 @java.io.Serial 1548 private Object writeReplace() { 1549 return new Ser(Ser.DURATION_TYPE, this); 1550 } 1551 1552 /** 1553 * Defend against malicious streams. 1554 * 1555 * @param s the stream to read 1556 * @throws InvalidObjectException always 1557 */ 1558 @java.io.Serial 1559 private void readObject(ObjectInputStream s) throws InvalidObjectException { 1560 throw new InvalidObjectException("Deserialization via serialization delegate"); 1561 } 1562 1563 void writeExternal(DataOutput out) throws IOException { 1564 out.writeLong(seconds); 1565 out.writeInt(nanos); 1566 } 1567 1568 static Duration readExternal(DataInput in) throws IOException { 1569 long seconds = in.readLong(); 1570 int nanos = in.readInt(); 1571 return Duration.ofSeconds(seconds, nanos); 1572 } 1573 1574 }