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