-
Notifications
You must be signed in to change notification settings - Fork 668
/
YearMonth.java
1562 lines (1428 loc) · 66.1 KB
/
YearMonth.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.Chronology;
import java.time.chrono.IsoChronology;
import java.time.format.DateTimeFormatter;
import java.time.format.DateTimeFormatterBuilder;
import java.time.format.DateTimeParseException;
import java.time.format.SignStyle;
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.util.Objects;
import static java.time.temporal.ChronoUnit.CENTURIES;
import static java.time.temporal.ChronoUnit.DECADES;
import static java.time.temporal.ChronoUnit.ERAS;
import static java.time.temporal.ChronoUnit.MILLENNIA;
import static java.time.temporal.ChronoUnit.MONTHS;
import static java.time.temporal.ChronoUnit.YEARS;
/**
* A year-month in the ISO-8601 calendar system, such as {@code 2007-12}.
* <p>
* {@code YearMonth} is an immutable date-time object that represents the combination
* of a year and month. Any field that can be derived from a year and month, such as
* quarter-of-year, can be obtained.
* <p>
* This class does not store or represent a day, time or time-zone.
* For example, the value "October 2007" can be stored in a {@code YearMonth}.
* <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 YearMonth} 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
*/
// x年x月
public final class YearMonth implements Temporal, TemporalAdjuster, Comparable<YearMonth>, Serializable {
/**
* Parser.
*/
private static final DateTimeFormatter PARSER = new DateTimeFormatterBuilder().appendValue(ChronoField.YEAR, 4, 10, SignStyle.EXCEEDS_PAD).appendLiteral('-').appendValue(ChronoField.MONTH_OF_YEAR, 2).toFormatter();
/**
* The year.
*/
private final int year; // "Proleptic年"部件[-999_999_999, 999_999_999]
/**
* The month-of-year, not null.
*/
private final int month; // "月份"部件[1, 12]
/*▼ 构造器 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Constructor.
*
* @param year the year to represent, validated from MIN_YEAR to MAX_YEAR
* @param month the month-of-year to represent, validated from 1 (January) to 12 (December)
*/
private YearMonth(int year, int month) {
this.year = year;
this.month = month;
}
/*▲ 构造器 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 工厂方法 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Obtains the current year-month 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 year-month.
* <p>
* Using this method will prevent the ability to use an alternate clock for testing
* because the clock is hard-coded.
*
* @return the current year-month using the system clock and default time-zone, not null
*/
// 基于此刻的UTC时间,构造属于系统默认时区的YearMonth对象
public static YearMonth now() {
// 获取一个系统时钟,其预设的时区ID为系统默认的时区ID
Clock clock = Clock.systemDefaultZone();
return now(clock);
}
/**
* Obtains the current year-month from the system clock in the specified time-zone.
* <p>
* This will query the {@link Clock#system(ZoneId) system clock} to obtain the current year-month.
* 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 year-month using the system clock, not null
*/
// 基于此刻的UTC时间,构造属于zone时区的YearMonth对象
public static YearMonth now(ZoneId zone) {
// 获取一个系统时钟,其预设的时区ID为zone
Clock clock = Clock.system(zone);
return now(clock);
}
/**
* Obtains the current year-month from the specified clock.
* <p>
* This will query the specified clock to obtain the current year-month.
* 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 year-month, not null
*/
// 基于clock提供的时间戳和时区ID构造YearMonth对象
public static YearMonth now(Clock clock) {
final LocalDate now = LocalDate.now(clock);
return YearMonth.of(now.getYear(), now.getMonth());
}
/**
* Obtains an instance of {@code YearMonth} from a year and month.
*
* @param year the year to represent, from MIN_YEAR to MAX_YEAR
* @param month the month-of-year to represent, not null
*
* @return the year-month, not null
*
* @throws DateTimeException if the year value is invalid
*/
// 根据Proleptic年份、月份构造YearMonth对象
public static YearMonth of(int year, Month month) {
Objects.requireNonNull(month, "month");
return of(year, month.getValue());
}
/**
* Obtains an instance of {@code YearMonth} from a year and month.
*
* @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)
*
* @return the year-month, not null
*
* @throws DateTimeException if either field value is invalid
*/
// 根据Proleptic年份、月份构造YearMonth对象
public static YearMonth of(int year, int month) {
ChronoField.YEAR.checkValidValue(year);
ChronoField.MONTH_OF_YEAR.checkValidValue(month);
return new YearMonth(year, month);
}
/**
* Obtains an instance of {@code YearMonth} from a temporal object.
* <p>
* This obtains a year-month 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 YearMonth}.
* <p>
* The conversion extracts the {@link ChronoField#YEAR YEAR} and
* {@link ChronoField#MONTH_OF_YEAR MONTH_OF_YEAR} fields.
* The extraction is only permitted if the temporal object has an ISO
* chronology, or can be converted to a {@code LocalDate}.
* <p>
* This method matches the signature of the functional interface {@link TemporalQuery}
* allowing it to be used as a query via method reference, {@code YearMonth::from}.
*
* @param temporal the temporal object to convert, not null
*
* @return the year-month, not null
*
* @throws DateTimeException if unable to convert to a {@code YearMonth}
*/
// 从temporal中查询YearMonth对象
public static YearMonth from(TemporalAccessor temporal) {
Objects.requireNonNull(temporal, "temporal");
if(temporal instanceof YearMonth) {
return (YearMonth) temporal;
}
try {
if(!IsoChronology.INSTANCE.equals(Chronology.from(temporal))) {
temporal = LocalDate.from(temporal);
}
return of(temporal.get(ChronoField.YEAR), temporal.get(ChronoField.MONTH_OF_YEAR));
} catch(DateTimeException ex) {
throw new DateTimeException("Unable to obtain YearMonth from TemporalAccessor: " + temporal + " of type " + temporal.getClass().getName(), ex);
}
}
/**
* Obtains an instance of {@code YearMonth} from a text string such as {@code 2007-12}.
* <p>
* The string must represent a valid year-month.
* The format must be {@code uuuu-MM}.
* Years outside the range 0000 to 9999 must be prefixed by the plus or minus symbol.
*
* @param text the text to parse such as "2007-12", not null
*
* @return the parsed year-month, not null
*
* @throws DateTimeParseException if the text cannot be parsed
*/
// 从指定的文本中解析出YearMonth信息,要求该文本符合ISO规范,即类似:2020-05
public static YearMonth parse(CharSequence text) {
return parse(text, PARSER);
}
/**
* Obtains an instance of {@code YearMonth} from a text string using a specific formatter.
* <p>
* The text is parsed using the formatter, returning a year-month.
*
* @param text the text to parse, not null
* @param formatter the formatter to use, not null
*
* @return the parsed year-month, not null
*
* @throws DateTimeParseException if the text cannot be parsed
*/
// 从指定的文本中解析出YearMonth信息,要求该文本符合指定的格式规范
public static YearMonth parse(CharSequence text, DateTimeFormatter formatter) {
Objects.requireNonNull(formatter, "formatter");
return formatter.parse(text, YearMonth::from);
}
/*▲ 工厂方法 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 转换 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Combines this year-month with a day-of-month to create a {@code LocalDate}.
* <p>
* This returns a {@code LocalDate} formed from this year-month and the specified day-of-month.
* <p>
* The day-of-month value must be valid for the year-month.
* <p>
* This method can be used as part of a chain to produce a date:
* <pre>
* LocalDate date = year.atMonth(month).atDay(day);
* </pre>
*
* @param dayOfMonth the day-of-month to use, from 1 to 31
*
* @return the date formed from this year-month and the specified day, not null
*
* @throws DateTimeException if the day is invalid for the year-month
* @see #isValidDay(int)
*/
// 将当前YearMonth和月份中的天数dayOfMonth整合成一个"本地日期"对象后返回
public LocalDate atDay(int dayOfMonth) {
return LocalDate.of(year, month, dayOfMonth);
}
/**
* Returns a {@code LocalDate} at the end of the month.
* <p>
* This returns a {@code LocalDate} based on this year-month.
* The day-of-month is set to the last valid day of the month, taking
* into account leap years.
* <p>
* This method can be used as part of a chain to produce a date:
* <pre>
* LocalDate date = year.atMonth(month).atEndOfMonth();
* </pre>
*
* @return the last valid date of this year-month, not null
*/
// 将当前YearMonth和月份中的最后一天整合成一个"本地日期"对象后返回
public LocalDate atEndOfMonth() {
return LocalDate.of(year, month, lengthOfMonth());
}
/*▲ 转换 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 部件 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* 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)}.
*
* @return the year, from MIN_YEAR to MAX_YEAR
*/
// 返回"年份"部件
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()
*/
// 返回"月份"部件
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()
*/
// 返回"月份"部件
public Month getMonth() {
return Month.of(month);
}
/*▲ 部件 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 增加 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Returns a copy of this year-month with the specified amount added.
* <p>
* This returns a {@code YearMonth}, 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 YearMonth} based on this year-month with the addition made, not null
*
* @throws DateTimeException if the addition cannot be made
* @throws ArithmeticException if numeric overflow occurs
*/
/*
* 对当前时间量的值与参数中的"时间段"求和
*
* 如果求和后的值与当前时间量的值相等,则直接返回当前时间量对象。
* 否则,需要构造"求和"后的新对象再返回。
*/
@Override
public YearMonth plus(TemporalAmount amountToAdd) {
return (YearMonth) amountToAdd.addTo(this);
}
/**
* Returns a copy of this year-month with the specified amount added.
* <p>
* This returns a {@code YearMonth}, 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 here.
* The supported fields behave as follows:
* <ul>
* <li>{@code MONTHS} -
* Returns a {@code YearMonth} with the specified number of months added.
* This is equivalent to {@link #plusMonths(long)}.
* <li>{@code YEARS} -
* Returns a {@code YearMonth} with the specified number of years added.
* This is equivalent to {@link #plusYears(long)}.
* <li>{@code DECADES} -
* Returns a {@code YearMonth} with the specified number of decades added.
* This is equivalent to calling {@link #plusYears(long)} with the amount
* multiplied by 10.
* <li>{@code CENTURIES} -
* Returns a {@code YearMonth} with the specified number of centuries added.
* This is equivalent to calling {@link #plusYears(long)} with the amount
* multiplied by 100.
* <li>{@code MILLENNIA} -
* Returns a {@code YearMonth} with the specified number of millennia added.
* This is equivalent to calling {@link #plusYears(long)} with the amount
* multiplied by 1,000.
* <li>{@code ERAS} -
* Returns a {@code YearMonth} with the specified number of eras added.
* Only two eras are supported so the amount must be one, zero or minus one.
* If the amount is non-zero then the year is changed such that the year-of-era
* is unchanged.
* </ul>
* <p>
* All other {@code ChronoUnit} instances will throw an {@code UnsupportedTemporalTypeException}.
* <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 a {@code YearMonth} based on this year-month 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 YearMonth plus(long amountToAdd, TemporalUnit unit) {
if(unit instanceof ChronoUnit) {
switch((ChronoUnit) unit) {
case MONTHS:
return plusMonths(amountToAdd);
case YEARS:
return plusYears(amountToAdd);
case DECADES:
return plusYears(Math.multiplyExact(amountToAdd, 10));
case CENTURIES:
return plusYears(Math.multiplyExact(amountToAdd, 100));
case MILLENNIA:
return plusYears(Math.multiplyExact(amountToAdd, 1000));
case ERAS:
return with(ChronoField.ERA, Math.addExact(getLong(ChronoField.ERA), amountToAdd));
}
throw new UnsupportedTemporalTypeException("Unsupported unit: " + unit);
}
return unit.addTo(this, amountToAdd);
}
/**
* Returns a copy of this {@code YearMonth} with the specified number of years added.
* <p>
* This instance is immutable and unaffected by this method call.
*
* @param yearsToAdd the years to add, may be negative
*
* @return a {@code YearMonth} based on this year-month with the years added, not null
*
* @throws DateTimeException if the result exceeds the supported range
*/
/*
* 在当前时间量的值上累加yearsToAdd年
*
* 如果累加后的值与当前时间量的值相等,则直接返回当前时间量对象。
* 否则,需要构造"累加"操作后的新对象再返回。
*/
public YearMonth plusYears(long yearsToAdd) {
if(yearsToAdd == 0) {
return this;
}
int newYear = ChronoField.YEAR.checkValidIntValue(year + yearsToAdd); // safe overflow
return with(newYear, month);
}
/**
* Returns a copy of this {@code YearMonth} with the specified number of months added.
* <p>
* This instance is immutable and unaffected by this method call.
*
* @param monthsToAdd the months to add, may be negative
*
* @return a {@code YearMonth} based on this year-month with the months added, not null
*
* @throws DateTimeException if the result exceeds the supported range
*/
/*
* 在当前时间量的值上累加monthsToAdd月
*
* 如果累加后的值与当前时间量的值相等,则直接返回当前时间量对象。
* 否则,需要构造"累加"操作后的新对象再返回。
*/
public YearMonth plusMonths(long monthsToAdd) {
if(monthsToAdd == 0) {
return this;
}
long monthCount = year * 12L + (month - 1);
long calcMonths = monthCount + monthsToAdd; // safe overflow
int newYear = ChronoField.YEAR.checkValidIntValue(Math.floorDiv(calcMonths, 12));
int newMonth = Math.floorMod(calcMonths, 12) + 1;
return with(newYear, newMonth);
}
/*▲ 增加 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 减少 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Returns a copy of this year-month with the specified amount subtracted.
* <p>
* This returns a {@code YearMonth}, based on this one, with the specified amount subtracted.
* 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#subtractFrom(Temporal)}. The amount implementation is free
* to implement the subtraction in any way it wishes, however it typically
* calls back to {@link #minus(long, TemporalUnit)}. Consult the documentation
* of the amount implementation to determine if it can be successfully subtracted.
* <p>
* This instance is immutable and unaffected by this method call.
*
* @param amountToSubtract the amount to subtract, not null
*
* @return a {@code YearMonth} based on this year-month with the subtraction made, not null
*
* @throws DateTimeException if the subtraction cannot be made
* @throws ArithmeticException if numeric overflow occurs
*/
/*
* 对当前时间量的值与参数中的"时间段"求差
*
* 如果求差后的值与当前时间量的值相等,则直接返回当前时间量对象。
* 否则,需要构造"求差"后的新对象再返回。
*/
@Override
public YearMonth minus(TemporalAmount amountToSubtract) {
return (YearMonth) amountToSubtract.subtractFrom(this);
}
/**
* Returns a copy of this year-month with the specified amount subtracted.
* <p>
* This returns a {@code YearMonth}, based on this one, with the amount
* in terms of the unit subtracted. If it is not possible to subtract the amount,
* because the unit is not supported or for some other reason, an exception is thrown.
* <p>
* This method is equivalent to {@link #plus(long, TemporalUnit)} with the amount negated.
* See that method for a full description of how addition, and thus subtraction, works.
* <p>
* This instance is immutable and unaffected by this method call.
*
* @param amountToSubtract the amount of the unit to subtract from the result, may be negative
* @param unit the unit of the amount to subtract, not null
*
* @return a {@code YearMonth} based on this year-month with the specified amount subtracted, not null
*
* @throws DateTimeException if the subtraction cannot be made
* @throws UnsupportedTemporalTypeException if the unit is not supported
* @throws ArithmeticException if numeric overflow occurs
*/
/*
* 对当前时间量的值减去amountToSubtract个unit单位的时间量
*
* 如果减去后的值与当前时间量的值相等,则直接返回当前时间量对象。
* 否则,需要构造"减去"操作后的新对象再返回。
*/
@Override
public YearMonth minus(long amountToSubtract, TemporalUnit unit) {
if(amountToSubtract == Long.MIN_VALUE) {
return plus(Long.MAX_VALUE, unit).plus(1, unit);
}
return plus(-amountToSubtract, unit);
}
/**
* Returns a copy of this {@code YearMonth} with the specified number of years subtracted.
* <p>
* This instance is immutable and unaffected by this method call.
*
* @param yearsToSubtract the years to subtract, may be negative
*
* @return a {@code YearMonth} based on this year-month with the years subtracted, not null
*
* @throws DateTimeException if the result exceeds the supported range
*/
/*
* 在当前时间量的值上减去yearsToSubtract年
*
* 如果减去后的值与当前时间量的值相等,则直接返回当前时间量对象。
* 否则,需要构造"减去"操作后的新对象再返回。
*/
public YearMonth minusYears(long yearsToSubtract) {
if(yearsToSubtract == Long.MIN_VALUE) {
return plusYears(Long.MAX_VALUE).plusYears(1);
}
return plusYears(-yearsToSubtract);
}
/**
* Returns a copy of this {@code YearMonth} with the specified number of months subtracted.
* <p>
* This instance is immutable and unaffected by this method call.
*
* @param monthsToSubtract the months to subtract, may be negative
*
* @return a {@code YearMonth} based on this year-month with the months subtracted, not null
*
* @throws DateTimeException if the result exceeds the supported range
*/
/*
* 在当前时间量的值上减去monthsToSubtract月
*
* 如果减去后的值与当前时间量的值相等,则直接返回当前时间量对象。
* 否则,需要构造"减去"操作后的新对象再返回。
*/
public YearMonth minusMonths(long monthsToSubtract) {
if(monthsToSubtract == Long.MIN_VALUE) {
return plusMonths(Long.MAX_VALUE).plusMonths(1);
}
return plusMonths(-monthsToSubtract);
}
/*▲ 减少 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 时间量单位 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Checks if the specified unit is supported.
* <p>
* This checks if the specified unit can be added to, or subtracted from, this year-month.
* If false, then calling the {@link #plus(long, TemporalUnit)} and
* {@link #minus(long, TemporalUnit) minus} methods will throw an exception.
* <p>
* If the unit is a {@link ChronoUnit} then the query is implemented here.
* The supported units are:
* <ul>
* <li>{@code MONTHS}
* <li>{@code YEARS}
* <li>{@code DECADES}
* <li>{@code CENTURIES}
* <li>{@code MILLENNIA}
* <li>{@code ERAS}
* </ul>
* All other {@code ChronoUnit} instances will return false.
* <p>
* If the unit is not a {@code ChronoUnit}, then the result of this method
* is obtained by invoking {@code TemporalUnit.isSupportedBy(Temporal)}
* passing {@code this} as the argument.
* Whether the unit is supported is determined by the unit.
*
* @param unit the unit to check, null returns false
*
* @return true if the unit can be added/subtracted, false if not
*/
// 判断当前时间量是否支持指定的时间量单位
@Override
public boolean isSupported(TemporalUnit unit) {
if(unit instanceof ChronoUnit) {
return unit == MONTHS || unit == YEARS || unit == DECADES || unit == CENTURIES || unit == MILLENNIA || unit == ERAS;
}
return unit != null && unit.isSupportedBy(this);
}
/*▲ 时间量单位 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 时间量字段操作(TemporalAccessor) ███████████████████████████████████████████████████████┓ */
/**
* Checks if the specified field is supported.
* <p>
* This checks if this year-month can be queried for the specified field.
* If false, then calling the {@link #range(TemporalField) range},
* {@link #get(TemporalField) get} and {@link #with(TemporalField, long)}
* methods will throw an exception.
* <p>
* If the field is a {@link ChronoField} then the query is implemented here.
* The supported fields are:
* <ul>
* <li>{@code MONTH_OF_YEAR}
* <li>{@code PROLEPTIC_MONTH}
* <li>{@code YEAR_OF_ERA}
* <li>{@code YEAR}
* <li>{@code ERA}
* </ul>
* All other {@code ChronoField} instances will return false.
* <p>
* If the field is not a {@code ChronoField}, then the result of this method
* is obtained by invoking {@code TemporalField.isSupportedBy(TemporalAccessor)}
* passing {@code this} as the argument.
* Whether the field is supported is determined by the field.
*
* @param field the field to check, null returns false
*
* @return true if the field is supported on this year-month, false if not
*/
// 判断当前时间量是否支持指定的时间量字段
@Override
public boolean isSupported(TemporalField field) {
if(field instanceof ChronoField) {
return field == ChronoField.YEAR || field == ChronoField.MONTH_OF_YEAR || field == ChronoField.PROLEPTIC_MONTH || field == ChronoField.YEAR_OF_ERA || field == ChronoField.ERA;
}
return field != null && field.isSupportedBy(this);
}
/**
* Gets the range of valid values for the specified field.
* <p>
* The range object expresses the minimum and maximum valid values for a field.
* This year-month is used to enhance the accuracy of the returned range.
* If it is not possible to return the range, because the field is not supported
* or for some other reason, an exception is thrown.
* <p>
* If the field is a {@link ChronoField} then the query is implemented here.
* The {@link #isSupported(TemporalField) supported fields} will return
* appropriate range instances.
* All other {@code ChronoField} instances will throw an {@code UnsupportedTemporalTypeException}.
* <p>
* If the field is not a {@code ChronoField}, then the result of this method
* is obtained by invoking {@code TemporalField.rangeRefinedBy(TemporalAccessor)}
* passing {@code this} as the argument.
* Whether the range can be obtained is determined by the field.
*
* @param field the field to query the range for, not null
*
* @return the range of valid values for the field, not null
*
* @throws DateTimeException if the range for the field cannot be obtained
* @throws UnsupportedTemporalTypeException if the field is not supported
*/
// 返回时间量字段field的取值区间,通常要求当前时间量支持该时间量字段
@Override
public ValueRange range(TemporalField field) {
if(field == ChronoField.YEAR_OF_ERA) {
if(getYear()<=0) {
return ValueRange.of(1, Year.MAX_VALUE + 1);
}
return ValueRange.of(1, Year.MAX_VALUE);
}
return Temporal.super.range(field);
}
/**
* Gets the value of the specified field from this year-month as an {@code int}.
* <p>
* This queries this year-month for the value of the specified field.
* The returned value will always be within the valid range of values for the field.
* If it is not possible to return the value, because the field is not supported
* or for some other reason, an exception is thrown.
* <p>
* If the field is a {@link ChronoField} then the query is implemented here.
* The {@link #isSupported(TemporalField) supported fields} will return valid
* values based on this year-month, except {@code PROLEPTIC_MONTH} which is too
* large to fit in an {@code int} and throw a {@code DateTimeException}.
* All other {@code ChronoField} instances will throw an {@code UnsupportedTemporalTypeException}.
* <p>
* If the field is not a {@code ChronoField}, then the result of this method
* is obtained by invoking {@code TemporalField.getFrom(TemporalAccessor)}
* passing {@code this} as the argument. Whether the value can be obtained,
* and what the value represents, is determined by the field.
*
* @param field the field to get, not null
*
* @return the value for the field
*
* @throws DateTimeException if a value for the field cannot be obtained or
* the value is outside the range of valid values for the field
* @throws UnsupportedTemporalTypeException if the field is not supported or
* the range of values exceeds an {@code int}
* @throws ArithmeticException if numeric overflow occurs
*/
/*
* 以int形式返回时间量字段field的值
*
* 目前支持的字段包括:
*
* ChronoField.YEAR - 返回"Proleptic年"部件
* ChronoField.MONTH_OF_YEAR - 返回"月份"部件
* .......................................................................
* ChronoField.YEAR_OF_ERA - 将"Proleptic年"转换为位于纪元中的[年]后返回
* ChronoField.PROLEPTIC_MONTH ×
* ChronoField.ERA - 计算"Proleptic年"年所在的纪元;在公历系统中,0是公元前,1是公元(后)
*/
@Override
public int get(TemporalField field) {
long longValue = getLong(field);
return range(field).checkValidIntValue(longValue, field);
}
/**
* Gets the value of the specified field from this year-month as a {@code long}.
* <p>
* This queries this year-month for the value of the specified field.
* If it is not possible to return the value, because the field is not supported
* or for some other reason, an exception is thrown.
* <p>
* If the field is a {@link ChronoField} then the query is implemented here.
* The {@link #isSupported(TemporalField) supported fields} will return valid
* values based on this year-month.
* All other {@code ChronoField} instances will throw an {@code UnsupportedTemporalTypeException}.
* <p>
* If the field is not a {@code ChronoField}, then the result of this method
* is obtained by invoking {@code TemporalField.getFrom(TemporalAccessor)}
* passing {@code this} as the argument. Whether the value can be obtained,
* and what the value represents, is determined by the field.
*
* @param field the field to get, not null
*
* @return the value for the field
*
* @throws DateTimeException if a value for the field cannot be obtained
* @throws UnsupportedTemporalTypeException if the field is not supported
* @throws ArithmeticException if numeric overflow occurs
*/
/*
* 以long形式返回时间量字段field的值
*
* 目前支持的字段包括:
*
* ChronoField.YEAR - 返回"Proleptic年"部件
* ChronoField.MONTH_OF_YEAR - 返回"月份"部件
* .......................................................................
* ChronoField.YEAR_OF_ERA - 将"Proleptic年"转换为位于纪元中的[年]后返回
* ChronoField.PROLEPTIC_MONTH = 计算当前时间量包含的"Proleptic月"
* ChronoField.ERA - 计算"Proleptic年"年所在的纪元;在公历系统中,0是公元前,1是公元(后)
*/
@Override
public long getLong(TemporalField field) {
if(field instanceof ChronoField) {
switch((ChronoField) field) {
case MONTH_OF_YEAR:
return month;
case PROLEPTIC_MONTH:
return getProlepticMonth();
case YEAR_OF_ERA:
return (year >= 1 ? year : 1 - year);
case YEAR:
return year;
case ERA:
return (year<1 ? 0 : 1);
}
throw new UnsupportedTemporalTypeException("Unsupported field: " + field);
}
return field.getFrom(this);
}
/**
* Queries this year-month using the specified query.
* <p>
* This queries this year-month using the specified query strategy object.
* The {@code TemporalQuery} object defines the logic to be used to
* obtain the result. Read the documentation of the query to understand
* what the result of this method will be.
* <p>
* The result of this method is obtained by invoking the
* {@link TemporalQuery#queryFrom(TemporalAccessor)} method on the
* specified query passing {@code this} as the argument.
*
* @param <R> the type of the result
* @param query the query to invoke, not null
*
* @return the query result, null may be returned (defined by the query)
*
* @throws DateTimeException if unable to query (defined by the query)
* @throws ArithmeticException if numeric overflow occurs (defined by the query)
*/
// 使用指定的时间量查询器,从当前时间量中查询目标信息
@SuppressWarnings("unchecked")
@Override
public <R> R query(TemporalQuery<R> query) {
if(query == TemporalQueries.precision()) {
return (R) MONTHS;
}
if(query == TemporalQueries.chronology()) {
return (R) IsoChronology.INSTANCE;
}
return Temporal.super.query(query);
}
/*▲ 时间量字段操作(TemporalAccessor) ███████████████████████████████████████████████████████┛ */