-
Notifications
You must be signed in to change notification settings - Fork 669
/
Copy pathOffsetDateTime.java
2700 lines (2497 loc) · 123 KB
/
OffsetDateTime.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 2012, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/*
* This file is available under and governed by the GNU General Public
* License version 2 only, as published by the Free Software Foundation.
* However, the following notice accompanied the original version of this
* file:
*
* Copyright (c) 2007-2012, Stephen Colebourne & Michael Nascimento Santos
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* * Neither the name of JSR-310 nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package java.time;
import java.io.IOException;
import java.io.InvalidObjectException;
import java.io.ObjectInput;
import java.io.ObjectInputStream;
import java.io.ObjectOutput;
import java.io.Serializable;
import java.time.chrono.IsoChronology;
import java.time.format.DateTimeFormatter;
import java.time.format.DateTimeParseException;
import java.time.temporal.ChronoField;
import java.time.temporal.ChronoUnit;
import java.time.temporal.Temporal;
import java.time.temporal.TemporalAccessor;
import java.time.temporal.TemporalAdjuster;
import java.time.temporal.TemporalAmount;
import java.time.temporal.TemporalField;
import java.time.temporal.TemporalQueries;
import java.time.temporal.TemporalQuery;
import java.time.temporal.TemporalUnit;
import java.time.temporal.UnsupportedTemporalTypeException;
import java.time.temporal.ValueRange;
import java.time.zone.ZoneRules;
import java.util.Comparator;
import java.util.Objects;
import static java.time.temporal.ChronoUnit.FOREVER;
import static java.time.temporal.ChronoUnit.NANOS;
/**
* A date-time with an offset from UTC/Greenwich in the ISO-8601 calendar system,
* such as {@code 2007-12-03T10:15:30+01:00}.
* <p>
* {@code OffsetDateTime} is an immutable representation of a date-time with an offset.
* This class stores all date and time fields, to a precision of nanoseconds,
* as well as the offset from UTC/Greenwich. For example, the value
* "2nd October 2007 at 13:45:30.123456789 +02:00" can be stored in an {@code OffsetDateTime}.
* <p>
* {@code OffsetDateTime}, {@link java.time.ZonedDateTime} and {@link java.time.Instant} all store an instant
* on the time-line to nanosecond precision.
* {@code Instant} is the simplest, simply representing the instant.
* {@code OffsetDateTime} adds to the instant the offset from UTC/Greenwich, which allows
* the local date-time to be obtained.
* {@code ZonedDateTime} adds full time-zone rules.
* <p>
* It is intended that {@code ZonedDateTime} or {@code Instant} is used to model data
* in simpler applications. This class may be used when modeling date-time concepts in
* more detail, or when communicating to a database or in a network protocol.
*
* <p>
* This is a <a href="{@docRoot}/java.base/java/lang/doc-files/ValueBased.html">value-based</a>
* class; use of identity-sensitive operations (including reference equality
* ({@code ==}), identity hash code, or synchronization) on instances of
* {@code OffsetDateTime} may have unpredictable results and should be avoided.
* The {@code equals} method should be used for comparisons.
*
* @implSpec This class is immutable and thread-safe.
* @since 1.8
*/
/*
* "本地日期-时间","时间"[关联]了所属的时区ID,"日期"基于[ISO]历法系统。
*
* 注:这里关联的时区ID是基于时间偏移的。
*/
public final class OffsetDateTime implements Temporal, TemporalAdjuster, Comparable<OffsetDateTime>, Serializable {
/**
* The minimum supported {@code OffsetDateTime}, '-999999999-01-01T00:00:00+18:00'.
* This is the local date-time of midnight at the start of the minimum date
* in the maximum offset (larger offsets are earlier on the time-line).
* This combines {@link LocalDateTime#MIN} and {@link ZoneOffset#MAX}.
* This could be used by an application as a "far past" date-time.
*/
public static final OffsetDateTime MIN = LocalDateTime.MIN.atOffset(ZoneOffset.MAX);
/**
* The maximum supported {@code OffsetDateTime}, '+999999999-12-31T23:59:59.999999999-18:00'.
* This is the local date-time just before midnight at the end of the maximum date
* in the minimum offset (larger negative offsets are later on the time-line).
* This combines {@link LocalDateTime#MAX} and {@link ZoneOffset#MIN}.
* This could be used by an application as a "far future" date-time.
*/
public static final OffsetDateTime MAX = LocalDateTime.MAX.atOffset(ZoneOffset.MIN);
/**
* The local date-time.
*/
// 位于offset时区的"本地日期-时间"
private final LocalDateTime dateTime;
/**
* The offset from UTC/Greenwich.
*/
// 基于时间偏移的时区ID,用来指示当前"本地日期-时间"所处的时区
private final ZoneOffset offset;
/*▼ 构造器 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Constructor.
*
* @param dateTime the local date-time, not null
* @param offset the zone offset, not null
*/
private OffsetDateTime(LocalDateTime dateTime, ZoneOffset offset) {
this.dateTime = Objects.requireNonNull(dateTime, "dateTime");
this.offset = Objects.requireNonNull(offset, "offset");
}
/*▲ 构造器 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 工厂方法 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Obtains the current date-time from the system clock in the default time-zone.
* <p>
* This will query the {@link Clock#systemDefaultZone() system clock} in the default
* time-zone to obtain the current date-time.
* The offset will be calculated from the time-zone in the clock.
* <p>
* Using this method will prevent the ability to use an alternate clock for testing
* because the clock is hard-coded.
*
* @return the current date-time using the system clock, not null
*/
// 构造属于系统默认时区的"本地日期-时间"对象(时区偏移时间准确)
public static OffsetDateTime now() {
// 获取一个系统时钟,其预设的时区ID为系统默认的时区ID
Clock clock = Clock.systemDefaultZone();
return now(clock);
}
/**
* Obtains the current date-time from the system clock in the specified time-zone.
* <p>
* This will query the {@link Clock#system(ZoneId) system clock} to obtain the current date-time.
* Specifying the time-zone avoids dependence on the default time-zone.
* The offset will be calculated from the specified time-zone.
* <p>
* Using this method will prevent the ability to use an alternate clock for testing
* because the clock is hard-coded.
*
* @param zone the zone ID to use, not null
*
* @return the current date-time using the system clock, not null
*/
// 构造属于zone时区的"本地日期-时间"对象(时区偏移时间准确)
public static OffsetDateTime now(ZoneId zone) {
// 获取一个系统时钟,其预设的时区ID为zone
Clock clock = Clock.system(zone);
return now(clock);
}
/**
* Obtains the current date-time from the specified clock.
* <p>
* This will query the specified clock to obtain the current date-time.
* The offset will be calculated from the time-zone in the clock.
* <p>
* Using this method allows the use of an alternate clock for testing.
* The alternate clock may be introduced using {@link Clock dependency injection}.
*
* @param clock the clock to use, not null
*
* @return the current date-time, not null
*/
// 使用指定的时钟构造"本地日期-时间"对象(时区偏移时间准确)
public static OffsetDateTime now(Clock clock) {
Objects.requireNonNull(clock, "clock");
// 获取clock时钟提供的时间戳
final Instant instant = clock.instant();
// 获取clock时钟提供的时区ID
ZoneId zoneId = clock.getZone();
// 获取与zoneId对应的"时区规则集"
ZoneRules rules = zoneId.getRules();
/*
* 获取zoneId时区在instant时刻的"实际偏移"。
* 这里可以返回一个准确的"实际偏移"。
*/
ZoneOffset offset = rules.getOffset(instant);
// 使用给定的时间戳构造属于offset时区的"本地日期-时间"对象(时区偏移时间准确)
return ofInstant(instant, offset);
}
/**
* Obtains an instance of {@code OffsetDateTime} from a date, time and offset.
* <p>
* This creates an offset date-time with the specified local date, time and offset.
*
* @param date the local date, not null
* @param time the local time, not null
* @param offset the zone offset, not null
*
* @return the offset date-time, not null
*/
// 使用给定的"本地日期"部件和"本地时间"部件构造属于offset的"本地日期-时间"对象
public static OffsetDateTime of(LocalDate date, LocalTime time, ZoneOffset offset) {
LocalDateTime dt = LocalDateTime.of(date, time);
return new OffsetDateTime(dt, offset);
}
/**
* Obtains an instance of {@code OffsetDateTime} from a date-time and offset.
* <p>
* This creates an offset date-time with the specified local date-time and offset.
*
* @param localDateTime the local date-time, not null
* @param offset the zone offset, not null
*
* @return the offset date-time, not null
*/
// 使用localDateTime构造属于zone的"本地日期-时间"对象
public static OffsetDateTime of(LocalDateTime localDateTime, ZoneOffset offset) {
return new OffsetDateTime(localDateTime, offset);
}
/**
* Obtains an instance of {@code OffsetDateTime} from a year, month, day,
* hour, minute, second, nanosecond and offset.
* <p>
* This creates an offset date-time with the seven specified fields.
* <p>
* This method exists primarily for writing test cases.
* Non test-code will typically use other methods to create an offset time.
* {@code LocalDateTime} has five additional convenience variants of the
* equivalent factory method taking fewer arguments.
* They are not provided here to reduce the footprint of the API.
*
* @param year the year to represent, from MIN_YEAR to MAX_YEAR
* @param month the month-of-year to represent, from 1 (January) to 12 (December)
* @param dayOfMonth the day-of-month to represent, from 1 to 31
* @param hour the hour-of-day to represent, from 0 to 23
* @param minute the minute-of-hour to represent, from 0 to 59
* @param second the second-of-minute to represent, from 0 to 59
* @param nanoOfSecond the nano-of-second to represent, from 0 to 999,999,999
* @param offset the zone offset, not null
*
* @return the offset date-time, not null
*
* @throws DateTimeException if the value of any field is out of range, or
* if the day-of-month is invalid for the month-year
*/
// 使用给定的日期部件和时间部件构造属于offset时区的"本地日期-时间"对象
public static OffsetDateTime of(int year, int month, int dayOfMonth, int hour, int minute, int second, int nanoOfSecond, ZoneOffset offset) {
LocalDateTime dt = LocalDateTime.of(year, month, dayOfMonth, hour, minute, second, nanoOfSecond);
return new OffsetDateTime(dt, offset);
}
/**
* Obtains an instance of {@code OffsetDateTime} from an {@code Instant} and zone ID.
* <p>
* This creates an offset date-time with the same instant as that specified.
* Finding the offset from UTC/Greenwich is simple as there is only one valid
* offset for each instant.
*
* @param instant the instant to create the date-time from, not null
* @param zone the time-zone, which may be an offset, not null
*
* @return the offset date-time, not null
*
* @throws DateTimeException if the result exceeds the supported range
*/
// 使用给定的时间戳构造属于zone时区的"本地日期-时间"对象(时区偏移时间准确)
public static OffsetDateTime ofInstant(Instant instant, ZoneId zone) {
Objects.requireNonNull(instant, "instant");
Objects.requireNonNull(zone, "zone");
// 获取与zone对应的"时区规则集"
ZoneRules rules = zone.getRules();
/*
* 获取zone时区在instant时刻的"实际偏移"。
* 这里可以返回一个准确的"实际偏移"。
*/
ZoneOffset offset = rules.getOffset(instant);
// 获取纪元秒部件
long epochSecond = instant.getEpochSecond();
// 获取纳秒偏移部件
int nano = instant.getNano();
// 使用UTC时区的纪元秒、纳秒偏移以及时区ID构造一个属于offset时区的"本地日期-时间"
LocalDateTime localDateTime = LocalDateTime.ofEpochSecond(epochSecond, nano, offset);
return new OffsetDateTime(localDateTime, offset);
}
/**
* Obtains an instance of {@code OffsetDateTime} from a temporal object.
* <p>
* This obtains an offset date-time based on the specified temporal.
* A {@code TemporalAccessor} represents an arbitrary set of date and time information,
* which this factory converts to an instance of {@code OffsetDateTime}.
* <p>
* The conversion will first obtain a {@code ZoneOffset} from the temporal object.
* It will then try to obtain a {@code LocalDateTime}, falling back to an {@code Instant} if necessary.
* The result will be the combination of {@code ZoneOffset} with either
* with {@code LocalDateTime} or {@code Instant}.
* Implementations are permitted to perform optimizations such as accessing
* those fields that are equivalent to the relevant objects.
* <p>
* This method matches the signature of the functional interface {@link TemporalQuery}
* allowing it to be used as a query via method reference, {@code OffsetDateTime::from}.
*
* @param temporal the temporal object to convert, not null
*
* @return the offset date-time, not null
*
* @throws DateTimeException if unable to convert to an {@code OffsetDateTime}
*/
// 从temporal中获取/构造OffsetDateTime部件
public static OffsetDateTime from(TemporalAccessor temporal) {
if(temporal instanceof OffsetDateTime) {
return (OffsetDateTime) temporal;
}
try {
// 从temporal中查询出基于时间偏移的时区ID
ZoneOffset offset = ZoneOffset.from(temporal);
// 从temporal中查询LocalDate部件的信息
LocalDate date = temporal.query(TemporalQueries.localDate());
// 从temporal中查询LocalTime部件的信息
LocalTime time = temporal.query(TemporalQueries.localTime());
if(date != null && time != null) {
return OffsetDateTime.of(date, time, offset);
}
// 从时间量temporal中获取秒部件和纳秒部件的信息,以构造一个时间戳
Instant instant = Instant.from(temporal);
// 使用给定的时间戳构造属于offset时区的"本地日期-时间"对象(时区偏移时间准确)
return OffsetDateTime.ofInstant(instant, offset);
} catch(DateTimeException ex) {
throw new DateTimeException("Unable to obtain OffsetDateTime from TemporalAccessor: " + temporal + " of type " + temporal.getClass().getName(), ex);
}
}
/**
* Obtains an instance of {@code OffsetDateTime} from a text string
* such as {@code 2007-12-03T10:15:30+01:00}.
* <p>
* The string must represent a valid date-time and is parsed using
* {@link java.time.format.DateTimeFormatter#ISO_OFFSET_DATE_TIME}.
*
* @param text the text to parse such as "2007-12-03T10:15:30+01:00", not null
*
* @return the parsed offset date-time, not null
*
* @throws DateTimeParseException if the text cannot be parsed
*/
// 从指定的文本中解析出ZonedDateTime信息,要求该文本符合ISO规范,即类似:2020-01-15T08:20:53+08:00
public static OffsetDateTime parse(CharSequence text) {
return parse(text, DateTimeFormatter.ISO_OFFSET_DATE_TIME);
}
/**
* Obtains an instance of {@code OffsetDateTime} from a text string using a specific formatter.
* <p>
* The text is parsed using the formatter, returning a date-time.
*
* @param text the text to parse, not null
* @param formatter the formatter to use, not null
*
* @return the parsed offset date-time, not null
*
* @throws DateTimeParseException if the text cannot be parsed
*/
// 从指定的文本中解析出ZonedDateTime信息,要求该文本符合指定的格式规范
public static OffsetDateTime parse(CharSequence text, DateTimeFormatter formatter) {
Objects.requireNonNull(formatter, "formatter");
return formatter.parse(text, OffsetDateTime::from);
}
/*▲ 工厂方法 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 转换 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Combines this date-time with a time-zone to create a {@code ZonedDateTime}
* ensuring that the result has the same instant.
* <p>
* This returns a {@code ZonedDateTime} formed from this date-time and the specified time-zone.
* This conversion will ignore the visible local date-time and use the underlying instant instead.
* This avoids any problems with local time-line gaps or overlaps.
* The result might have different values for fields such as hour, minute an even day.
* <p>
* To attempt to retain the values of the fields, use {@link #atZoneSimilarLocal(ZoneId)}.
* To use the offset as the zone ID, use {@link #toZonedDateTime()}.
*
* @param zone the time-zone to use, not null
*
* @return the zoned date-time formed from this date-time, not null
*/
// 将当前时间量转换为属于zone的"本地日期-时间"对象(时区偏移时间准确)
public ZonedDateTime atZoneSameInstant(ZoneId zone) {
return ZonedDateTime.ofInstant(dateTime, offset, zone);
}
/**
* Combines this date-time with a time-zone to create a {@code ZonedDateTime}
* trying to keep the same local date and time.
* <p>
* This returns a {@code ZonedDateTime} formed from this date-time and the specified time-zone.
* Where possible, the result will have the same local date-time as this object.
* <p>
* Time-zone rules, such as daylight savings, mean that not every time on the
* local time-line exists. If the local date-time is in a gap or overlap according to
* the rules then a resolver is used to determine the resultant local time and offset.
* This method uses {@link ZonedDateTime#ofLocal(LocalDateTime, ZoneId, ZoneOffset)}
* to retain the offset from this instance if possible.
* <p>
* Finer control over gaps and overlaps is available in two ways.
* If you simply want to use the later offset at overlaps then call
* {@link ZonedDateTime#withLaterOffsetAtOverlap()} immediately after this method.
* <p>
* To create a zoned date-time at the same instant irrespective of the local time-line,
* use {@link #atZoneSameInstant(ZoneId)}.
* To use the offset as the zone ID, use {@link #toZonedDateTime()}.
*
* @param zone the time-zone to use, not null
*
* @return the zoned date-time formed from this date and the earliest valid time for the zone, not null
*/
/*
* 将当前时间量转换为属于zone的"本地日期-时间"对象
* 如果zone不是ZoneOffset类型,则时区偏移时间可能会不准确。
*/
public ZonedDateTime atZoneSimilarLocal(ZoneId zone) {
return ZonedDateTime.ofLocal(dateTime, zone, offset);
}
/**
* Converts this date-time to a {@code ZonedDateTime} using the offset as the zone ID.
* <p>
* This creates the simplest possible {@code ZonedDateTime} using the offset
* as the zone ID.
* <p>
* To control the time-zone used, see {@link #atZoneSameInstant(ZoneId)} and
* {@link #atZoneSimilarLocal(ZoneId)}.
*
* @return a zoned date-time representing the same local date-time and offset, not null
*/
// 将当前时间量转换为ZonedDateTime对象后返回(时区偏移时间准确)
public ZonedDateTime toZonedDateTime() {
return ZonedDateTime.of(dateTime, offset);
}
/**
* Converts this date-time to an {@code OffsetTime}.
* <p>
* This returns an offset time with the same local time and offset.
*
* @return an OffsetTime representing the time and offset, not null
*/
// 将当前时间量转换为OffsetTime对象
public OffsetTime toOffsetTime() {
return OffsetTime.of(dateTime.toLocalTime(), offset);
}
/**
* Converts this date-time to an {@code Instant}.
* <p>
* This returns an {@code Instant} representing the same point on the
* time-line as this date-time.
*
* @return an {@code Instant} representing the same instant, not null
*/
// 将当前时间量转换为时间戳,该时间戳反映的是UTC/GMT"零时区"的时间点
public Instant toInstant() {
return dateTime.toInstant(offset);
}
/**
* Converts this date-time to the number of seconds from the epoch of 1970-01-01T00:00:00Z.
* <p>
* This allows this date-time to be converted to a value of the
* {@link ChronoField#INSTANT_SECONDS epoch-seconds} field. This is primarily
* intended for low-level conversions rather than general application usage.
*
* @return the number of seconds from the epoch of 1970-01-01T00:00:00Z
*/
// 计算当前时间点下,UTC时区的纪元秒
public long toEpochSecond() {
return dateTime.toEpochSecond(offset);
}
/*▲ 转换 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 部件 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Gets the zone offset, such as '+01:00'.
* <p>
* This is the offset of the local date-time from UTC/Greenwich.
*
* @return the zone offset, not null
*/
// 返回基于时间偏移的"时区ID"部件
public ZoneOffset getOffset() {
return offset;
}
/**
* Gets the {@code LocalDateTime} part of this date-time.
* <p>
* This returns a {@code LocalDateTime} with the same year, month, day and time
* as this date-time.
*
* @return the local date-time part of this date-time, not null
*/
// 返回"本地日期-时间"组件
public LocalDateTime toLocalDateTime() {
return dateTime;
}
/**
* Gets the {@code LocalDate} part of this date-time.
* <p>
* This returns a {@code LocalDate} with the same year, month and day
* as this date-time.
*
* @return the date part of this date-time, not null
*/
// 返回"本地日期"组件
public LocalDate toLocalDate() {
return dateTime.toLocalDate();
}
/**
* Gets the {@code LocalTime} part of this date-time.
* <p>
* This returns a {@code LocalTime} with the same hour, minute, second and
* nanosecond as this date-time.
*
* @return the time part of this date-time, not null
*/
// 返回"本地时间"组件
public LocalTime toLocalTime() {
return dateTime.toLocalTime();
}
/**
* Gets the year field.
* <p>
* This method returns the primitive {@code int} value for the year.
* <p>
* The year returned by this method is proleptic as per {@code get(YEAR)}.
* To obtain the year-of-era, use {@code get(YEAR_OF_ERA)}.
*
* @return the year, from MIN_YEAR to MAX_YEAR
*/
// (哪年)返回"年份"部件[-999999999, 999999999],由"本地日期"部件计算而来
public int getYear() {
return dateTime.getYear();
}
/**
* Gets the month-of-year field from 1 to 12.
* <p>
* This method returns the month as an {@code int} from 1 to 12.
* Application code is frequently clearer if the enum {@link Month}
* is used by calling {@link #getMonth()}.
*
* @return the month-of-year, from 1 to 12
*
* @see #getMonth()
*/
// (哪月)返回"月份"部件[1, 12],由"本地日期"部件计算而来
public int getMonthValue() {
return dateTime.getMonthValue();
}
/**
* Gets the month-of-year field using the {@code Month} enum.
* <p>
* This method returns the enum {@link Month} for the month.
* This avoids confusion as to what {@code int} values mean.
* If you need access to the primitive {@code int} value then the enum
* provides the {@link Month#getValue() int value}.
*
* @return the month-of-year, not null
*
* @see #getMonthValue()
*/
// (哪月)以Month形式返回"月份"部件,由"本地日期"部件计算而来
public Month getMonth() {
return dateTime.getMonth();
}
/**
* Gets the day-of-month field.
* <p>
* This method returns the primitive {@code int} value for the day-of-month.
*
* @return the day-of-month, from 1 to 31
*/
// (哪日)返回"天"部件[1, 28/31]
public int getDayOfMonth() {
return dateTime.getDayOfMonth();
}
/**
* Gets the day-of-week field, which is an enum {@code DayOfWeek}.
* <p>
* This method returns the enum {@link DayOfWeek} for the day-of-week.
* This avoids confusion as to what {@code int} values mean.
* If you need access to the primitive {@code int} value then the enum
* provides the {@link DayOfWeek#getValue() int value}.
* <p>
* Additional information can be obtained from the {@code DayOfWeek}.
* This includes textual names of the values.
*
* @return the day-of-week, not null
*/
// (周几)返回当前"本地日期-时间"是所在周的第几天
public DayOfWeek getDayOfWeek() {
return dateTime.getDayOfWeek();
}
/**
* Gets the day-of-year field.
* <p>
* This method returns the primitive {@code int} value for the day-of-year.
*
* @return the day-of-year, from 1 to 365, or 366 in a leap year
*/
// 返回当前"本地日期-时间"是所在年份的第几天
public int getDayOfYear() {
return dateTime.getDayOfYear();
}
/**
* Gets the hour-of-day field.
*
* @return the hour-of-day, from 0 to 23
*/
// (几时)返回"小时"部件[0, 23],由"本地时间"部件计算而来
public int getHour() {
return dateTime.getHour();
}
/**
* Gets the minute-of-hour field.
*
* @return the minute-of-hour, from 0 to 59
*/
// (几分)返回"分钟"部件[0, 59],由"本地时间"部件计算而来
public int getMinute() {
return dateTime.getMinute();
}
/**
* Gets the second-of-minute field.
*
* @return the second-of-minute, from 0 to 59
*/
// (几秒)返回"秒"部件[0, 59],由"本地时间"部件计算而来
public int getSecond() {
return dateTime.getSecond();
}
/**
* Gets the nano-of-second field.
*
* @return the nano-of-second, from 0 to 999,999,999
*/
// (几纳秒)返回"纳秒"部件[0, 999999999],由"本地时间"部件计算而来
public int getNano() {
return dateTime.getNano();
}
/*▲ 部件 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 增加 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Returns a copy of this date-time with the specified amount added.
* <p>
* This returns an {@code OffsetDateTime}, based on this one, with the specified amount added.
* The amount is typically {@link Period} or {@link Duration} but may be
* any other type implementing the {@link TemporalAmount} interface.
* <p>
* The calculation is delegated to the amount object by calling
* {@link TemporalAmount#addTo(Temporal)}. The amount implementation is free
* to implement the addition in any way it wishes, however it typically
* calls back to {@link #plus(long, TemporalUnit)}. Consult the documentation
* of the amount implementation to determine if it can be successfully added.
* <p>
* This instance is immutable and unaffected by this method call.
*
* @param amountToAdd the amount to add, not null
*
* @return an {@code OffsetDateTime} based on this date-time with the addition made, not null
*
* @throws DateTimeException if the addition cannot be made
* @throws ArithmeticException if numeric overflow occurs
*/
/*
* 对当前时间量的值与参数中的"时间段"求和
*
* 如果求和后的值与当前时间量的值相等,则直接返回当前时间量对象。
* 否则,需要构造"求和"后的新对象再返回。
*/
@Override
public OffsetDateTime plus(TemporalAmount amountToAdd) {
return (OffsetDateTime) amountToAdd.addTo(this);
}
/**
* Returns a copy of this date-time with the specified amount added.
* <p>
* This returns an {@code OffsetDateTime}, based on this one, with the amount
* in terms of the unit added. If it is not possible to add the amount, because the
* unit is not supported or for some other reason, an exception is thrown.
* <p>
* If the field is a {@link ChronoUnit} then the addition is implemented by
* {@link LocalDateTime#plus(long, TemporalUnit)}.
* The offset is not part of the calculation and will be unchanged in the result.
* <p>
* If the field is not a {@code ChronoUnit}, then the result of this method
* is obtained by invoking {@code TemporalUnit.addTo(Temporal, long)}
* passing {@code this} as the argument. In this case, the unit determines
* whether and how to perform the addition.
* <p>
* This instance is immutable and unaffected by this method call.
*
* @param amountToAdd the amount of the unit to add to the result, may be negative
* @param unit the unit of the amount to add, not null
*
* @return an {@code OffsetDateTime} based on this date-time with the specified amount added, not null
*
* @throws DateTimeException if the addition cannot be made
* @throws UnsupportedTemporalTypeException if the unit is not supported
* @throws ArithmeticException if numeric overflow occurs
*/
/*
* 对当前时间量的值累加amountToAdd个unit单位的时间量
*
* 如果累加后的值与当前时间量的值相等,则直接返回当前时间量对象。
* 否则,需要构造"累加"操作后的新对象再返回。
*/
@Override
public OffsetDateTime plus(long amountToAdd, TemporalUnit unit) {
if(unit instanceof ChronoUnit) {
return with(dateTime.plus(amountToAdd, unit), offset);
}
return unit.addTo(this, amountToAdd);
}
/**
* Returns a copy of this {@code OffsetDateTime} with the specified number of years added.
* <p>
* This method adds the specified amount to the years field in three steps:
* <ol>
* <li>Add the input years to the year field</li>
* <li>Check if the resulting date would be invalid</li>
* <li>Adjust the day-of-month to the last valid day if necessary</li>
* </ol>
* <p>
* For example, 2008-02-29 (leap year) plus one year would result in the
* invalid date 2009-02-29 (standard year). Instead of returning an invalid
* result, the last valid day of the month, 2009-02-28, is selected instead.
* <p>
* This instance is immutable and unaffected by this method call.
*
* @param years the years to add, may be negative
*
* @return an {@code OffsetDateTime} based on this date-time with the years added, not null
*
* @throws DateTimeException if the result exceeds the supported date range
*/
/*
* 在当前时间量的值上累加years年
*
* 如果累加后的值与当前时间量的值相等,则直接返回当前时间量对象。
* 否则,需要构造"累加"操作后的新对象再返回。
*/
public OffsetDateTime plusYears(long years) {
return with(dateTime.plusYears(years), offset);
}
/**
* Returns a copy of this {@code OffsetDateTime} with the specified number of months added.
* <p>
* This method adds the specified amount to the months field in three steps:
* <ol>
* <li>Add the input months to the month-of-year field</li>
* <li>Check if the resulting date would be invalid</li>
* <li>Adjust the day-of-month to the last valid day if necessary</li>
* </ol>
* <p>
* For example, 2007-03-31 plus one month would result in the invalid date
* 2007-04-31. Instead of returning an invalid result, the last valid day
* of the month, 2007-04-30, is selected instead.
* <p>
* This instance is immutable and unaffected by this method call.
*
* @param months the months to add, may be negative
*
* @return an {@code OffsetDateTime} based on this date-time with the months added, not null
*
* @throws DateTimeException if the result exceeds the supported date range
*/
/*
* 在当前时间量的值上累加months月
*
* 如果累加后的值与当前时间量的值相等,则直接返回当前时间量对象。
* 否则,需要构造"累加"操作后的新对象再返回。
*/
public OffsetDateTime plusMonths(long months) {
return with(dateTime.plusMonths(months), offset);
}
/**
* Returns a copy of this OffsetDateTime with the specified number of weeks added.
* <p>
* This method adds the specified amount in weeks to the days field incrementing
* the month and year fields as necessary to ensure the result remains valid.
* The result is only invalid if the maximum/minimum year is exceeded.
* <p>
* For example, 2008-12-31 plus one week would result in 2009-01-07.
* <p>
* This instance is immutable and unaffected by this method call.
*
* @param weeks the weeks to add, may be negative
*
* @return an {@code OffsetDateTime} based on this date-time with the weeks added, not null
*
* @throws DateTimeException if the result exceeds the supported date range
*/
/*
* 在当前时间量的值上累加weeks周
*
* 如果累加后的值与当前时间量的值相等,则直接返回当前时间量对象。
* 否则,需要构造"累加"操作后的新对象再返回。
*/
public OffsetDateTime plusWeeks(long weeks) {
return with(dateTime.plusWeeks(weeks), offset);
}
/**
* Returns a copy of this OffsetDateTime with the specified number of days added.
* <p>
* This method adds the specified amount to the days field incrementing the
* month and year fields as necessary to ensure the result remains valid.
* The result is only invalid if the maximum/minimum year is exceeded.
* <p>
* For example, 2008-12-31 plus one day would result in 2009-01-01.
* <p>
* This instance is immutable and unaffected by this method call.
*
* @param days the days to add, may be negative
*
* @return an {@code OffsetDateTime} based on this date-time with the days added, not null
*
* @throws DateTimeException if the result exceeds the supported date range
*/
/*
* 在当前时间量的值上累加days天
*
* 如果累加后的值与当前时间量的值相等,则直接返回当前时间量对象。
* 否则,需要构造"累加"操作后的新对象再返回。
*/
public OffsetDateTime plusDays(long days) {
return with(dateTime.plusDays(days), offset);
}
/**
* Returns a copy of this {@code OffsetDateTime} with the specified number of hours added.
* <p>
* This instance is immutable and unaffected by this method call.
*
* @param hours the hours to add, may be negative
*
* @return an {@code OffsetDateTime} based on this date-time with the hours added, not null
*
* @throws DateTimeException if the result exceeds the supported date range
*/
/*
* 在当前时间量的值上累加hours小时
*
* 如果累加后的值与当前时间量的值相等,则直接返回当前时间量对象。
* 否则,需要构造"累加"操作后的新对象再返回。
*/
public OffsetDateTime plusHours(long hours) {
return with(dateTime.plusHours(hours), offset);
}
/**
* Returns a copy of this {@code OffsetDateTime} with the specified number of minutes added.
* <p>
* This instance is immutable and unaffected by this method call.
*
* @param minutes the minutes to add, may be negative
*
* @return an {@code OffsetDateTime} based on this date-time with the minutes added, not null
*
* @throws DateTimeException if the result exceeds the supported date range
*/
/*
* 在当前时间量的值上累加minutes分钟
*
* 如果累加后的值与当前时间量的值相等,则直接返回当前时间量对象。
* 否则,需要构造"累加"操作后的新对象再返回。
*/
public OffsetDateTime plusMinutes(long minutes) {
return with(dateTime.plusMinutes(minutes), offset);
}
/**
* Returns a copy of this {@code OffsetDateTime} with the specified number of seconds added.
* <p>
* This instance is immutable and unaffected by this method call.
*
* @param seconds the seconds to add, may be negative
*
* @return an {@code OffsetDateTime} based on this date-time with the seconds added, not null
*
* @throws DateTimeException if the result exceeds the supported date range
*/
/*
* 在当前时间量的值上累加seconds秒
*
* 如果累加后的值与当前时间量的值相等,则直接返回当前时间量对象。
* 否则,需要构造"累加"操作后的新对象再返回。