-
Notifications
You must be signed in to change notification settings - Fork 668
/
LocalDate.java
2911 lines (2672 loc) · 127 KB
/
LocalDate.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.DataInput;
import java.io.DataOutput;
import java.io.IOException;
import java.io.InvalidObjectException;
import java.io.ObjectInputStream;
import java.io.Serializable;
import java.time.chrono.ChronoLocalDate;
import java.time.chrono.IsoChronology;
import java.time.chrono.IsoEra;
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.ZoneOffsetTransition;
import java.time.zone.ZoneRules;
import java.util.Objects;
import java.util.stream.LongStream;
import java.util.stream.Stream;
import static java.time.LocalTime.SECONDS_PER_DAY;
import static java.time.temporal.ChronoField.ALIGNED_DAY_OF_WEEK_IN_MONTH;
import static java.time.temporal.ChronoField.ALIGNED_DAY_OF_WEEK_IN_YEAR;
import static java.time.temporal.ChronoField.ALIGNED_WEEK_OF_MONTH;
import static java.time.temporal.ChronoField.ALIGNED_WEEK_OF_YEAR;
import static java.time.temporal.ChronoField.DAY_OF_MONTH;
import static java.time.temporal.ChronoField.DAY_OF_YEAR;
import static java.time.temporal.ChronoField.EPOCH_DAY;
import static java.time.temporal.ChronoField.ERA;
import static java.time.temporal.ChronoField.MONTH_OF_YEAR;
import static java.time.temporal.ChronoField.PROLEPTIC_MONTH;
import static java.time.temporal.ChronoField.YEAR;
/**
* A date without a time-zone in the ISO-8601 calendar system,
* such as {@code 2007-12-03}.
* <p>
* {@code LocalDate} is an immutable date-time object that represents a date,
* often viewed as year-month-day. Other date fields, such as day-of-year,
* day-of-week and week-of-year, can also be accessed.
* For example, the value "2nd October 2007" can be stored in a {@code LocalDate}.
* <p>
* This class does not store or represent a time or time-zone.
* Instead, it is a description of the date, as used for birthdays.
* It cannot represent an instant on the time-line without additional information
* such as an offset or time-zone.
* <p>
* The ISO-8601 calendar system is the modern civil calendar system used today
* in most of the world. It is equivalent to the proleptic Gregorian calendar
* system, in which today's rules for leap years are applied for all time.
* For most applications written today, the ISO-8601 rules are entirely suitable.
* However, any application that makes use of historical dates, and requires them
* to be accurate will find the ISO-8601 approach unsuitable.
*
* <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 LocalDate} 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
*/
// "本地日期","日期"基于[ISO]历法系统
public final class LocalDate implements Temporal, TemporalAdjuster, ChronoLocalDate, Serializable {
/**
* The number of days in a 400 year cycle.
*/
/*
* 每400个公历年包含的天数
*
* 参见:Year#isLeap(year)中关于闰年的描述。
*/
private static final int DAYS_PER_CYCLE = 146097;
/**
* The number of days from year zero to year 1970.
* There are five 400 year cycles from year zero to 2000.
* There are 7 leap years from 1970 to 2000.
*/
/*
* 公历0年到公历1970年包含的天数
*
* 从0年到2000年之间有5个400年周期。
* 从1970年到2000年有7个闰年。
*/
static final long DAYS_0000_TO_1970 = (DAYS_PER_CYCLE * 5L) - (30L * 365L + 7L);
/**
* The epoch year {@code LocalDate}, '1970-01-01'.
*/
public static final LocalDate EPOCH = LocalDate.of(1970, 1, 1); // 新纪元时间
/**
* The minimum supported {@code LocalDate}, '-999999999-01-01'.
* This could be used by an application as a "far past" date.
*/
public static final LocalDate MIN = LocalDate.of(Year.MIN_VALUE, 1, 1);
/**
* The maximum supported {@code LocalDate}, '+999999999-12-31'.
* This could be used by an application as a "far future" date.
*/
public static final LocalDate MAX = LocalDate.of(Year.MAX_VALUE, 12, 31);
/**
* The year.
*/
private final int year; // "Proleptic年"部件[-999999999, 999999999]
/**
* The month-of-year.
*/
private final short month; // "月份"部件[1, 12]
/**
* The day-of-month.
*/
private final short day; // "天"部件[1, 28/31]
/*▼ 构造器 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Constructor, previously validated.
*
* @param year the year to represent, from MIN_YEAR to MAX_YEAR
* @param month the month-of-year to represent, not null
* @param dayOfMonth the day-of-month to represent, valid for year-month, from 1 to 31
*/
private LocalDate(int year, int month, int dayOfMonth) {
this.year = year;
this.month = (short) month;
this.day = (short) dayOfMonth;
}
/*▲ 构造器 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 工厂方法 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Obtains the current date 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.
* <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 using the system clock and default time-zone, not null
*/
// 基于此刻的UTC时间,构造属于系统默认时区的"本地日期"对象
public static LocalDate now() {
// 获取一个系统时钟,其预设的时区ID为系统默认的时区ID
Clock clock = Clock.systemDefaultZone();
return now(clock);
}
/**
* Obtains the current date 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.
* Specifying the time-zone avoids dependence on the default 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 using the system clock, not null
*/
// 基于此刻的UTC时间,构造属于zone时区的"本地日期"对象
public static LocalDate now(ZoneId zone) {
// 获取一个系统时钟,其预设的时区ID为zone
Clock clock = Clock.system(zone);
return now(clock);
}
/**
* Obtains the current date from the specified clock.
* <p>
* This will query the specified clock to obtain the current date - today.
* 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, not null
*/
// 基于clock提供的时间戳和时区ID构造"本地日期"对象
public static LocalDate now(Clock clock) {
Objects.requireNonNull(clock, "clock");
// 获取clock时钟提供的时间戳
final Instant instant = clock.instant();
// 获取clock时钟提供的时区ID
ZoneId zoneId = clock.getZone();
// 使用指定的时间戳和时区ID构造属于zone时区的"本地日期"
return ofInstant(instant, zoneId);
}
/**
* Obtains an instance of {@code LocalDate} from a year, month and day.
* <p>
* This returns a {@code LocalDate} with the specified year, month and day-of-month.
* The day must be valid for the year and month, otherwise an exception will be thrown.
*
* @param year the year to represent, from MIN_YEAR to MAX_YEAR
* @param month the month-of-year to represent, not null
* @param dayOfMonth the day-of-month to represent, from 1 to 31
*
* @return the local date, 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
*/
/*
* 根据Proleptic年份、月份和月份中的天数构造"本地日期"对象
*
* year : 年份,这里应当传入"Proleptic年"
* month : 月份
* dayOfMonth: 一月中的第几天
*/
public static LocalDate of(int year, Month month, int dayOfMonth) {
Objects.requireNonNull(month, "month");
YEAR.checkValidValue(year);
DAY_OF_MONTH.checkValidValue(dayOfMonth);
return create(year, month.getValue(), dayOfMonth);
}
/**
* Obtains an instance of {@code LocalDate} from a year, month and day.
* <p>
* This returns a {@code LocalDate} with the specified year, month and day-of-month.
* The day must be valid for the year and month, otherwise an exception will be thrown.
*
* @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
*
* @return the local date, 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
*/
/*
* 根据Proleptic年份、月份和月份中的天数构造"本地日期"对象
*
* year : 年份,这里应当传入"Proleptic年"
* month : 月份
* dayOfMonth: 一月中的第几天
*/
public static LocalDate of(int year, int month, int dayOfMonth) {
YEAR.checkValidValue(year);
MONTH_OF_YEAR.checkValidValue(month);
DAY_OF_MONTH.checkValidValue(dayOfMonth);
return create(year, month, dayOfMonth);
}
/**
* Obtains an instance of {@code LocalDate} from a year and day-of-year.
* <p>
* This returns a {@code LocalDate} with the specified year and day-of-year.
* The day-of-year must be valid for the year, otherwise an exception will be thrown.
*
* @param year the year to represent, from MIN_YEAR to MAX_YEAR
* @param dayOfYear the day-of-year to represent, from 1 to 366
*
* @return the local date, not null
*
* @throws DateTimeException if the value of any field is out of range,
* or if the day-of-year is invalid for the year
*/
/*
* 根据Proleptic年份和年份中的天数构造"本地日期"对象
*
* year : 年份,这里应当传入"Proleptic年"
* dayOfYear: 一年中的第几天
*/
public static LocalDate ofYearDay(int year, int dayOfYear) {
YEAR.checkValidValue(year);
DAY_OF_YEAR.checkValidValue(dayOfYear);
// 当前年份是否为"闰年"
boolean leap = IsoChronology.INSTANCE.isLeapYear(year);
if(dayOfYear == 366 && !leap) {
throw new DateTimeException("Invalid date 'DayOfYear 366' as '" + year + "' is not a leap year");
}
// 计算月份
Month moy = Month.of((dayOfYear - 1) / 31 + 1);
// 获取当前月份的最后一天是所在年份的第几天
int monthEnd = moy.firstDayOfYear(leap) + moy.length(leap) - 1;
if(dayOfYear>monthEnd) {
moy = moy.plus(1);
}
// 计算出剩余的天数
int dom = dayOfYear - moy.firstDayOfYear(leap) + 1;
return new LocalDate(year, moy.getValue(), dom);
}
/**
* Obtains an instance of {@code LocalDate} from the epoch day count.
* <p>
* This returns a {@code LocalDate} with the specified epoch-day.
* The {@link ChronoField#EPOCH_DAY EPOCH_DAY} is a simple incrementing count
* of days where day 0 is 1970-01-01. Negative numbers represent earlier days.
*
* @param epochDay the Epoch Day to convert, based on the epoch 1970-01-01
*
* @return the local date, not null
*
* @throws DateTimeException if the epoch day exceeds the supported date range
*/
// 根据给定的纪元天构造"本地日期"对象
public static LocalDate ofEpochDay(long epochDay) {
EPOCH_DAY.checkValidValue(epochDay);
long zeroDay = epochDay + DAYS_0000_TO_1970;
// find the march-based year
zeroDay -= 60; // adjust to 0000-03-01 so leap day is at end of four year cycle
long adjust = 0;
if(zeroDay<0) {
// adjust negative years to positive for calculation
long adjustCycles = (zeroDay + 1) / DAYS_PER_CYCLE - 1;
adjust = adjustCycles * 400;
zeroDay += -adjustCycles * DAYS_PER_CYCLE;
}
long yearEst = (400 * zeroDay + 591) / DAYS_PER_CYCLE;
long doyEst = zeroDay - (365 * yearEst + yearEst / 4 - yearEst / 100 + yearEst / 400);
if(doyEst<0) {
// fix estimate
yearEst--;
doyEst = zeroDay - (365 * yearEst + yearEst / 4 - yearEst / 100 + yearEst / 400);
}
yearEst += adjust; // reset any negative year
int marchDoy0 = (int) doyEst;
// convert march-based values back to january-based
int marchMonth0 = (marchDoy0 * 5 + 2) / 153;
int month = (marchMonth0 + 2) % 12 + 1;
int dom = marchDoy0 - (marchMonth0 * 306 + 5) / 10 + 1;
yearEst += marchMonth0 / 10;
// check year now we are certain it is correct
int year = YEAR.checkValidIntValue(yearEst);
return new LocalDate(year, month, dom);
}
/**
* Obtains an instance of {@code LocalDate} from an {@code Instant} and zone ID.
* <p>
* This creates a local date based on the specified instant.
* First, the offset from UTC/Greenwich is obtained using the zone ID and instant,
* which is simple as there is only one valid offset for each instant.
* Then, the instant and offset are used to calculate the local date.
*
* @param instant the instant to create the date from, not null
* @param zone the time-zone, which may be an offset, not null
*
* @return the local date, not null
*
* @throws DateTimeException if the result exceeds the supported range
* @since 9
*/
// 使用指定的时间戳和时区ID构造属于zone时区的"本地日期"对象
public static LocalDate 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);
// 计算instant在zone时区的纪元秒
long localSecond = instant.getEpochSecond() + offset.getTotalSeconds();
// 根据纪元秒计算纪元天
long localEpochDay = Math.floorDiv(localSecond, SECONDS_PER_DAY);
// 根据给定的纪元天构造"本地日期"
return ofEpochDay(localEpochDay);
}
/**
* Obtains an instance of {@code LocalDate} from a temporal object.
* <p>
* This obtains a local date 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 LocalDate}.
* <p>
* The conversion uses the {@link TemporalQueries#localDate()} query, which relies
* on extracting the {@link ChronoField#EPOCH_DAY EPOCH_DAY} field.
* <p>
* This method matches the signature of the functional interface {@link TemporalQuery}
* allowing it to be used as a query via method reference, {@code LocalDate::from}.
*
* @param temporal the temporal object to convert, not null
*
* @return the local date, not null
*
* @throws DateTimeException if unable to convert to a {@code LocalDate}
*/
/*
* 从temporal中查询LocalDate部件。
*
* 如果没有现成的部件,通常需要从temporal中解析出纪元天,
* 然后使用纪元天构造LocalDate后返回。
*/
public static LocalDate from(TemporalAccessor temporal) {
Objects.requireNonNull(temporal, "temporal");
// 从temporal中查询LocalDate部件的信息
LocalDate date = temporal.query(TemporalQueries.localDate());
if(date == null) {
throw new DateTimeException("Unable to obtain LocalDate from TemporalAccessor: " + temporal + " of type " + temporal.getClass().getName());
}
return date;
}
/**
* Obtains an instance of {@code LocalDate} from a text string such as {@code 2007-12-03}.
* <p>
* The string must represent a valid date and is parsed using
* {@link java.time.format.DateTimeFormatter#ISO_LOCAL_DATE}.
*
* @param text the text to parse such as "2007-12-03", not null
*
* @return the parsed local date, not null
*
* @throws DateTimeParseException if the text cannot be parsed
*/
// 从指定的文本中解析出LocalDate信息,要求该文本符合ISO规范,即类似:2020-01-15
public static LocalDate parse(CharSequence text) {
return parse(text, DateTimeFormatter.ISO_LOCAL_DATE);
}
/**
* Obtains an instance of {@code LocalDate} from a text string using a specific formatter.
* <p>
* The text is parsed using the formatter, returning a date.
*
* @param text the text to parse, not null
* @param formatter the formatter to use, not null
*
* @return the parsed local date, not null
*
* @throws DateTimeParseException if the text cannot be parsed
*/
// 从指定的文本中解析出LocalDate信息,要求该文本符合指定的格式规范
public static LocalDate parse(CharSequence text, DateTimeFormatter formatter) {
Objects.requireNonNull(formatter, "formatter");
return formatter.parse(text, new TemporalQuery<LocalDate>() {
@Override
public LocalDate queryFrom(TemporalAccessor temporal) {
return from(temporal);
}
});
}
/*▲ 工厂方法 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 转换 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Combines this date with a time to create a {@code LocalDateTime}.
* <p>
* This returns a {@code LocalDateTime} formed from this date at the specified time.
* All possible combinations of date and time are valid.
*
* @param time the time to combine with, not null
*
* @return the local date-time formed from this date and the specified time, not null
*/
// 将当前"本地日期"和指定的"本地时间"整合成一个"本地日期-时间"对象后返回
@Override
public LocalDateTime atTime(LocalTime time) {
return LocalDateTime.of(this, time);
}
/**
* Combines this date with a time to create a {@code LocalDateTime}.
* <p>
* This returns a {@code LocalDateTime} formed from this date at the
* specified hour and minute.
* The seconds and nanosecond fields will be set to zero.
* The individual time fields must be within their valid range.
* All possible combinations of date and time are valid.
*
* @param hour the hour-of-day to use, from 0 to 23
* @param minute the minute-of-hour to use, from 0 to 59
*
* @return the local date-time formed from this date and the specified time, not null
*
* @throws DateTimeException if the value of any field is out of range
*/
// 将当前"本地日期"和指定的时间部件整合成一个"本地日期-时间"对象后返回
public LocalDateTime atTime(int hour, int minute) {
// 根据指定的时间部件构造"本地时间"对象
LocalTime localTime = LocalTime.of(hour, minute);
return atTime(localTime);
}
/**
* Combines this date with a time to create a {@code LocalDateTime}.
* <p>
* This returns a {@code LocalDateTime} formed from this date at the
* specified hour, minute and second.
* The nanosecond field will be set to zero.
* The individual time fields must be within their valid range.
* All possible combinations of date and time are valid.
*
* @param hour the hour-of-day to use, from 0 to 23
* @param minute the minute-of-hour to use, from 0 to 59
* @param second the second-of-minute to represent, from 0 to 59
*
* @return the local date-time formed from this date and the specified time, not null
*
* @throws DateTimeException if the value of any field is out of range
*/
// 将当前"本地日期"和指定的时间部件整合成一个"本地日期-时间"对象后返回
public LocalDateTime atTime(int hour, int minute, int second) {
// 根据指定的时间部件构造"本地时间"对象
LocalTime localTime = LocalTime.of(hour, minute, second);
return atTime(localTime);
}
/**
* Combines this date with a time to create a {@code LocalDateTime}.
* <p>
* This returns a {@code LocalDateTime} formed from this date at the
* specified hour, minute, second and nanosecond.
* The individual time fields must be within their valid range.
* All possible combinations of date and time are valid.
*
* @param hour the hour-of-day to use, from 0 to 23
* @param minute the minute-of-hour to use, 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
*
* @return the local date-time formed from this date and the specified time, not null
*
* @throws DateTimeException if the value of any field is out of range
*/
// 将当前"本地日期"和指定的时间部件整合成一个"本地日期-时间"对象后返回
public LocalDateTime atTime(int hour, int minute, int second, int nanoOfSecond) {
// 根据指定的时间部件构造"本地时间"对象
LocalTime localTime = LocalTime.of(hour, minute, second, nanoOfSecond);
return atTime(localTime);
}
/**
* Combines this date with an offset time to create an {@code OffsetDateTime}.
* <p>
* This returns an {@code OffsetDateTime} formed from this date at the specified time.
* All possible combinations of date and time are valid.
*
* @param time the time to combine with, not null
*
* @return the offset date-time formed from this date and the specified time, not null
*/
/*
* 将当前"本地日期"和指定的"本地时间"整合成一个"本地日期-时间"对象后返回。
* 返回的OffsetDateTime中使用了参数time中的时区偏移信息。
*/
public OffsetDateTime atTime(OffsetTime time) {
// 从time中获取"本地时间"部件
LocalTime localTime = time.toLocalTime();
// 从time中获取"时区偏移"部件
ZoneOffset zoneOffset = time.getOffset();
// 使用当前"本地日期"和localTime构造一个"本地日期-时间"对象
LocalDateTime localDateTime = LocalDateTime.of(this, localTime);
// 使用localDateTime构造属于zoneOffset的"本地日期-时间"对象
return OffsetDateTime.of(localDateTime, zoneOffset);
}
/**
* Combines this date with the time of midnight to create a {@code LocalDateTime}
* at the start of this date.
* <p>
* This returns a {@code LocalDateTime} formed from this date at the time of
* midnight, 00:00, at the start of this date.
*
* @return the local date-time of midnight at the start of this date, not null
*/
// 将当前"本地日期"和一个代表一天中起始的"本地时间"整合成一个"本地日期-时间"对象后返回
public LocalDateTime atStartOfDay() {
return LocalDateTime.of(this, LocalTime.MIDNIGHT);
}
/**
* Returns a zoned date-time from this date at the earliest valid time according
* to the rules in the time-zone.
* <p>
* Time-zone rules, such as daylight savings, mean that not every local date-time
* is valid for the specified zone, thus the local date-time may not be midnight.
* <p>
* In most cases, there is only one valid offset for a local date-time.
* In the case of an overlap, there are two valid offsets, and the earlier one is used,
* corresponding to the first occurrence of midnight on the date.
* In the case of a gap, the zoned date-time will represent the instant just after the gap.
* <p>
* If the zone ID is a {@link ZoneOffset}, then the result always has a time of midnight.
* <p>
* To convert to a specific time in a given time-zone call {@link #atTime(LocalTime)}
* followed by {@link LocalDateTime#atZone(ZoneId)}.
*
* @param zone the zone ID to use, not null
*
* @return the zoned date-time formed from this date and the earliest valid time for the zone, not null
*/
/*
* 将当前"本地日期"和一个代表一天中起始的"本地时间"整合成一个"本地日期-时间"对象后返回。
* 返回的ZonedDateTime中使用了参数zone中的时区信息。
*/
public ZonedDateTime atStartOfDay(ZoneId zone) {
Objects.requireNonNull(zone, "zone");
/*
* need to handle case where there is a gap from 11:30 to 00:30
* standard ZDT factory would result in 01:00 rather than 00:30
*/
LocalDateTime localDateTime = atTime(LocalTime.MIDNIGHT);
// 如果zone是地理时区
if(!(zone instanceof ZoneOffset)) {
// 获取与zone对应的"时区规则集"
ZoneRules rules = zone.getRules();
// 获取zone时区在localDateTime时刻的偏移转换规则,该规则用来指示如何切换时区的时间偏移
ZoneOffsetTransition trans = rules.getTransition(localDateTime);
// 如果localDateTime位于zone时区的"间隙时间"中,则需要将其调整到"间隙时间"之后
if(trans != null && trans.isGap()) {
localDateTime = trans.getDateTimeAfter();
}
}
return ZonedDateTime.of(localDateTime, zone);
}
// 返回当前时间量的纪元天
@Override
public long toEpochDay() {
long y = year;
long m = month;
long total = 0;
total += 365 * y;
if(y >= 0) {
total += (y + 3) / 4 - (y + 99) / 100 + (y + 399) / 400;
} else {
total -= y / -4 - y / -100 + y / -400;
}
total += ((367 * m - 362) / 12);
total += day - 1;
if(m>2) {
total--;
if(!isLeapYear()) {
total--;
}
}
return total - DAYS_0000_TO_1970;
}
/**
* Converts this {@code LocalDate} to the number of seconds since the epoch
* of 1970-01-01T00:00:00Z.
* <p>
* This combines this local date with the specified time and
* offset to calculate the epoch-second value, which is the
* number of elapsed seconds from 1970-01-01T00:00:00Z.
* Instants on the time-line after the epoch are positive, earlier
* are negative.
*
* @param time the local time, not null
* @param offset the zone offset, not null
*
* @return the number of seconds since the epoch of 1970-01-01T00:00:00Z, may be negative
*
* @since 9
*/
// 将位于offset时区的当前"本地日期"与指定的"本地时间"time捆绑为一个"时间点",然后计算该本地时间点下,UTC时区的纪元秒
public long toEpochSecond(LocalTime time, ZoneOffset offset) {
Objects.requireNonNull(time, "time");
Objects.requireNonNull(offset, "offset");
// 返回当前本地日期的纪元天
long epochDay = toEpochDay();
// 将"本地时间"time转换为一天中的秒数
int seconds = time.toSecondOfDay();
// 计算出(本地日期+time)代表的纪元秒
long epochSec = epochDay * SECONDS_PER_DAY + seconds;
// 减去时区偏移秒数
epochSec -= offset.getTotalSeconds();
return epochSec;
}
/*▲ 转换 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 部件 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* 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 year;
}
/**
* 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 month;
}
/**
* 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 Month.of(month);
}
/**
* 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 day;
}
/**
* 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() {
int dow0 = Math.floorMod(toEpochDay() + 3, 7);
return DayOfWeek.of(dow0 + 1);
}
/**
* 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 getMonth().firstDayOfYear(isLeapYear()) + day - 1;
}
/*▲ 部件 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 增加 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Returns a copy of this date with the specified amount added.
* <p>
* This returns a {@code LocalDate}, based on this one, with the specified amount added.
* The amount is typically {@link Period} 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 a {@code LocalDate} based on this date with the addition made, not null
*
* @throws DateTimeException if the addition cannot be made
* @throws ArithmeticException if numeric overflow occurs
*/
/*
* 对当前时间量的值与参数中的"时间段"求和
*
* 如果求和后的值与当前时间量的值相等,则直接返回当前时间量对象。
* 否则,需要构造"求和"后的新对象再返回。
*/
@Override
public LocalDate plus(TemporalAmount amountToAdd) {
Objects.requireNonNull(amountToAdd, "amountToAdd");
if(amountToAdd instanceof Period) {
Period periodToAdd = (Period) amountToAdd;
return plusMonths(periodToAdd.toTotalMonths()).plusDays(periodToAdd.getDays());
}
return (LocalDate) amountToAdd.addTo(this);
}
/**
* Returns a copy of this date with the specified amount added.
* <p>
* This returns a {@code LocalDate}, 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>
* In some cases, adding the amount can cause the resulting date to become invalid.
* For example, adding one month to 31st January would result in 31st February.
* In cases like this, the unit is responsible for resolving the date.
* Typically it will choose the previous valid date, which would be the last valid
* day of February in this example.
* <p>
* If the field is a {@link ChronoUnit} then the addition is implemented here.
* The supported fields behave as follows:
* <ul>
* <li>{@code DAYS} -
* Returns a {@code LocalDate} with the specified number of days added.
* This is equivalent to {@link #plusDays(long)}.
* <li>{@code WEEKS} -
* Returns a {@code LocalDate} with the specified number of weeks added.
* This is equivalent to {@link #plusWeeks(long)} and uses a 7 day week.
* <li>{@code MONTHS} -
* Returns a {@code LocalDate} with the specified number of months added.
* This is equivalent to {@link #plusMonths(long)}.
* The day-of-month will be unchanged unless it would be invalid for the new
* month and year. In that case, the day-of-month is adjusted to the maximum
* valid value for the new month and year.
* <li>{@code YEARS} -
* Returns a {@code LocalDate} with the specified number of years added.
* This is equivalent to {@link #plusYears(long)}.
* The day-of-month will be unchanged unless it would be invalid for the new
* month and year. In that case, the day-of-month is adjusted to the maximum
* valid value for the new month and year.
* <li>{@code DECADES} -
* Returns a {@code LocalDate} with the specified number of decades added.
* This is equivalent to calling {@link #plusYears(long)} with the amount
* multiplied by 10.
* The day-of-month will be unchanged unless it would be invalid for the new
* month and year. In that case, the day-of-month is adjusted to the maximum
* valid value for the new month and year.
* <li>{@code CENTURIES} -
* Returns a {@code LocalDate} with the specified number of centuries added.
* This is equivalent to calling {@link #plusYears(long)} with the amount
* multiplied by 100.
* The day-of-month will be unchanged unless it would be invalid for the new
* month and year. In that case, the day-of-month is adjusted to the maximum
* valid value for the new month and year.
* <li>{@code MILLENNIA} -
* Returns a {@code LocalDate} with the specified number of millennia added.
* This is equivalent to calling {@link #plusYears(long)} with the amount
* multiplied by 1,000.
* The day-of-month will be unchanged unless it would be invalid for the new
* month and year. In that case, the day-of-month is adjusted to the maximum
* valid value for the new month and year.
* <li>{@code ERAS} -
* Returns a {@code LocalDate} with the specified number of eras added.