forked from kangjianwei/LearningJDK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
LocalTime.java
2298 lines (2101 loc) · 97.2 KB
/
LocalTime.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.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.Objects;
import static java.time.temporal.ChronoUnit.NANOS;
/**
* A time without a time-zone in the ISO-8601 calendar system,
* such as {@code 10:15:30}.
* <p>
* {@code LocalTime} is an immutable date-time object that represents a time,
* often viewed as hour-minute-second.
* Time is represented to nanosecond precision.
* For example, the value "13:45.30.123456789" can be stored in a {@code LocalTime}.
* <p>
* This class does not store or represent a date or time-zone.
* Instead, it is a description of the local time as seen on a wall clock.
* 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. This API assumes that all calendar systems use the same
* representation, this class, for time-of-day.
*
* <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 LocalTime} 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
public final class LocalTime implements Temporal, TemporalAdjuster, Comparable<LocalTime>, Serializable {
/**
* The minimum supported {@code LocalTime}, '00:00'.
* This is the time of midnight at the start of the day.
*/
public static final LocalTime MIN; // 00:00
/**
* The maximum supported {@code LocalTime}, '23:59:59.999999999'.
* This is the time just before midnight at the end of the day.
*/
public static final LocalTime MAX; // 23:59:59.999999999
/**
* The time of midnight at the start of the day, '00:00'.
*/
public static final LocalTime MIDNIGHT; // 00:00
/**
* The time of noon in the middle of the day, '12:00'.
*/
public static final LocalTime NOON; // 12:00
/**
* Hours per day.
*/
static final int HOURS_PER_DAY = 24; // 每天24小时
/**
* Minutes per hour.
*/
static final int MINUTES_PER_HOUR = 60; // 每小时60分
/**
* Minutes per day.
*/
static final int MINUTES_PER_DAY = MINUTES_PER_HOUR * HOURS_PER_DAY; // 每天24*60分
/**
* Seconds per minute.
*/
static final int SECONDS_PER_MINUTE = 60; // 每分60秒
/**
* Seconds per hour.
*/
static final int SECONDS_PER_HOUR = SECONDS_PER_MINUTE * MINUTES_PER_HOUR; // 每小时60*60秒
/**
* Seconds per day.
*/
static final int SECONDS_PER_DAY = SECONDS_PER_HOUR * HOURS_PER_DAY; // 每天60*60*24秒
/**
* Milliseconds per day.
*/
static final long MILLIS_PER_DAY = SECONDS_PER_DAY * 1000L; // 每天60*60*24*1000毫秒
/**
* Microseconds per day.
*/
static final long MICROS_PER_DAY = SECONDS_PER_DAY * 1000_000L; // 每天60*60*24*1000微秒
/**
* Nanos per millisecond.
*/
static final long NANOS_PER_MILLI = 1000_000L; // 每毫秒是1000_000纳秒
/**
* Nanos per second.
*/
static final long NANOS_PER_SECOND = 1000_000_000L; // 每秒是1000_000_000纳秒
/**
* Nanos per minute.
*/
static final long NANOS_PER_MINUTE = NANOS_PER_SECOND * SECONDS_PER_MINUTE; // 每分钟是60*1000_000_000纳秒
/**
* Nanos per hour.
*/
static final long NANOS_PER_HOUR = NANOS_PER_MINUTE * MINUTES_PER_HOUR; // 每小时是60*60*1000_000_000纳秒
/**
* Nanos per day.
*/
static final long NANOS_PER_DAY = NANOS_PER_HOUR * HOURS_PER_DAY; // 每天是24*60*60*1000_000_000纳秒
/**
* Constants for the local time of each hour.
*/
private static final LocalTime[] HOURS = new LocalTime[24];
/**
* The hour.
*/
private final byte hour; // "小时"部件[0, 23]
/**
* The minute.
*/
private final byte minute; // "分钟"部件[0, 59]
/**
* The second.
*/
private final byte second; // "秒"部件[0, 59]
/**
* The nanosecond.
*/
private final int nano; // "纳秒"部件[0, 999999999]
static {
for(int i = 0; i<HOURS.length; i++) {
HOURS[i] = new LocalTime(i, 0, 0, 0);
}
MIDNIGHT = HOURS[0];
NOON = HOURS[12];
MIN = HOURS[0];
MAX = new LocalTime(23, 59, 59, 999_999_999);
}
/*▼ 构造器 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Constructor, previously validated.
*
* @param hour the hour-of-day to represent, validated from 0 to 23
* @param minute the minute-of-hour to represent, validated from 0 to 59
* @param second the second-of-minute to represent, validated from 0 to 59
* @param nanoOfSecond the nano-of-second to represent, validated from 0 to 999,999,999
*/
private LocalTime(int hour, int minute, int second, int nanoOfSecond) {
this.hour = (byte) hour;
this.minute = (byte) minute;
this.second = (byte) second;
this.nano = nanoOfSecond;
}
/*▲ 构造器 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 工厂方法 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Obtains the current 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 time.
* <p>
* Using this method will prevent the ability to use an alternate clock for testing
* because the clock is hard-coded.
*
* @return the current time using the system clock and default time-zone, not null
*/
// 基于此刻的UTC时间,构造属于系统默认时区的"本地时间"对象
public static LocalTime now() {
// 获取一个系统时钟,其预设的时区ID为系统默认的时区ID
Clock clock = Clock.systemDefaultZone();
return now(clock);
}
/**
* Obtains the current 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 time.
* 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 time using the system clock, not null
*/
// 基于此刻的UTC时间,构造属于zone时区的"本地时间"对象
public static LocalTime now(ZoneId zone) {
// 获取一个系统时钟,其预设的时区ID为zone
Clock clock = Clock.system(zone);
return now(clock);
}
/**
* Obtains the current time from the specified clock.
* <p>
* This will query the specified clock to obtain the current time.
* 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 time, not null
*/
// 基于clock提供的时间戳和时区ID构造"本地时间"对象
public static LocalTime now(Clock clock) {
Objects.requireNonNull(clock, "clock");
// 获取clock时钟提供的时间戳
final Instant instant = clock.instant();
// 获取clock时钟提供的时区ID
ZoneId zoneId = clock.getZone();
return ofInstant(instant, zoneId);
}
/**
* Obtains an instance of {@code LocalTime} from an hour and minute.
* <p>
* This returns a {@code LocalTime} with the specified hour and minute.
* The second and nanosecond fields will be set to zero.
*
* @param hour the hour-of-day to represent, from 0 to 23
* @param minute the minute-of-hour to represent, from 0 to 59
*
* @return the local time, not null
*
* @throws DateTimeException if the value of any field is out of range
*/
// 根据指定的时间部件构造"本地时间"对象
public static LocalTime of(int hour, int minute) {
ChronoField.HOUR_OF_DAY.checkValidValue(hour);
if(minute == 0) {
return HOURS[hour];
}
ChronoField.MINUTE_OF_HOUR.checkValidValue(minute);
return new LocalTime(hour, minute, 0, 0);
}
/**
* Obtains an instance of {@code LocalTime} from an hour, minute and second.
* <p>
* This returns a {@code LocalTime} with the specified hour, minute and second.
* The nanosecond field will be set to zero.
*
* @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
*
* @return the local time, not null
*
* @throws DateTimeException if the value of any field is out of range
*/
// 根据指定的时间部件构造"本地时间"对象
public static LocalTime of(int hour, int minute, int second) {
ChronoField.HOUR_OF_DAY.checkValidValue(hour);
if((minute | second) == 0) {
return HOURS[hour]; // for performance
}
ChronoField.MINUTE_OF_HOUR.checkValidValue(minute);
ChronoField.SECOND_OF_MINUTE.checkValidValue(second);
return new LocalTime(hour, minute, second, 0);
}
/**
* Obtains an instance of {@code LocalTime} from an hour, minute, second and nanosecond.
* <p>
* This returns a {@code LocalTime} with the specified hour, minute, second and nanosecond.
*
* @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
*
* @return the local time, not null
*
* @throws DateTimeException if the value of any field is out of range
*/
// 根据指定的时间部件构造"本地时间"对象
public static LocalTime of(int hour, int minute, int second, int nanoOfSecond) {
ChronoField.HOUR_OF_DAY.checkValidValue(hour);
ChronoField.MINUTE_OF_HOUR.checkValidValue(minute);
ChronoField.SECOND_OF_MINUTE.checkValidValue(second);
ChronoField.NANO_OF_SECOND.checkValidValue(nanoOfSecond);
return create(hour, minute, second, nanoOfSecond);
}
/**
* Obtains an instance of {@code LocalTime} from a second-of-day value.
* <p>
* This returns a {@code LocalTime} with the specified second-of-day.
* The nanosecond field will be set to zero.
*
* @param secondOfDay the second-of-day, from {@code 0} to {@code 24 * 60 * 60 - 1}
*
* @return the local time, not null
*
* @throws DateTimeException if the second-of-day value is invalid
*/
// 使用指定的秒数(不超过一天)构造"本地时间"对象
public static LocalTime ofSecondOfDay(long secondOfDay) {
ChronoField.SECOND_OF_DAY.checkValidValue(secondOfDay);
// 计算小时部件
int hours = (int) (secondOfDay / SECONDS_PER_HOUR);
secondOfDay -= hours * SECONDS_PER_HOUR;
// 计算分钟部件
int minutes = (int) (secondOfDay / SECONDS_PER_MINUTE);
secondOfDay -= minutes * SECONDS_PER_MINUTE;
return create(hours, minutes, (int) secondOfDay, 0);
}
/**
* Obtains an instance of {@code LocalTime} from a nanos-of-day value.
* <p>
* This returns a {@code LocalTime} with the specified nanosecond-of-day.
*
* @param nanoOfDay the nano of day, from {@code 0} to {@code 24 * 60 * 60 * 1,000,000,000 - 1}
*
* @return the local time, not null
*
* @throws DateTimeException if the nanos of day value is invalid
*/
// 使用指定的纳秒数(不超过一天)构造"本地时间"对象
public static LocalTime ofNanoOfDay(long nanoOfDay) {
ChronoField.NANO_OF_DAY.checkValidValue(nanoOfDay);
// 计算小时部件
int hours = (int) (nanoOfDay / NANOS_PER_HOUR);
nanoOfDay -= hours * NANOS_PER_HOUR;
// 计算分钟部件
int minutes = (int) (nanoOfDay / NANOS_PER_MINUTE);
nanoOfDay -= minutes * NANOS_PER_MINUTE;
// 计算秒部件
int seconds = (int) (nanoOfDay / NANOS_PER_SECOND);
// 剩下纳秒部件
nanoOfDay -= seconds * NANOS_PER_SECOND;
return create(hours, minutes, seconds, (int) nanoOfDay);
}
/**
* Obtains an instance of {@code LocalTime} from an {@code Instant} and zone ID.
* <p>
* This creates a local time 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 time.
*
* @param instant the instant to create the time from, not null
* @param zone the time-zone, which may be an offset, not null
*
* @return the local time, not null
*
* @since 9
*/
// 使用指定的时间戳和时区ID构造属于zone时区的"本地日期"对象
public static LocalTime 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();
// 获取localSecond中不足一天的秒数,即会忽略"日期"部件中包含的秒
int secsOfDay = Math.floorMod(localSecond, SECONDS_PER_DAY);
// 获取时间戳中的纳秒偏移部件
int nano = instant.getNano();
// 使用指定的纳秒数(不超过一天)构造"本地时间"
return ofNanoOfDay(secsOfDay * NANOS_PER_SECOND + nano);
}
/**
* Obtains an instance of {@code LocalTime} from a temporal object.
* <p>
* This obtains a local 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 LocalTime}.
* <p>
* The conversion uses the {@link TemporalQueries#localTime()} query, which relies
* on extracting the {@link ChronoField#NANO_OF_DAY NANO_OF_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 LocalTime::from}.
*
* @param temporal the temporal object to convert, not null
*
* @return the local time, not null
*
* @throws DateTimeException if unable to convert to a {@code LocalTime}
*/
/*
* 从temporal中查询LocalTime部件。
*
* 如果没有现成的部件,通常需要从指定的时间量中解析出包含的纳秒数,
* 然后使用该时间量包含的纳秒数构造LocalTime后返回。
*/
public static LocalTime from(TemporalAccessor temporal) {
Objects.requireNonNull(temporal, "temporal");
LocalTime time = temporal.query(TemporalQueries.localTime());
if(time == null) {
throw new DateTimeException("Unable to obtain LocalTime from TemporalAccessor: " + temporal + " of type " + temporal.getClass().getName());
}
return time;
}
/**
* Obtains an instance of {@code LocalTime} from a text string such as {@code 10:15}.
* <p>
* The string must represent a valid time and is parsed using
* {@link java.time.format.DateTimeFormatter#ISO_LOCAL_TIME}.
*
* @param text the text to parse such as "10:15:30", not null
*
* @return the parsed local time, not null
*
* @throws DateTimeParseException if the text cannot be parsed
*/
// 从指定的文本中解析出LocalTime信息,要求该文本符合ISO规范,即类似:08:20:53
public static LocalTime parse(CharSequence text) {
return parse(text, DateTimeFormatter.ISO_LOCAL_TIME);
}
/**
* Obtains an instance of {@code LocalTime} from a text string using a specific formatter.
* <p>
* The text is parsed using the formatter, returning a time.
*
* @param text the text to parse, not null
* @param formatter the formatter to use, not null
*
* @return the parsed local time, not null
*
* @throws DateTimeParseException if the text cannot be parsed
*/
// 从指定的文本中解析出LocalTime信息,要求该文本符合指定的格式规范
public static LocalTime parse(CharSequence text, DateTimeFormatter formatter) {
Objects.requireNonNull(formatter, "formatter");
return formatter.parse(text, new TemporalQuery<LocalTime>() {
@Override
public LocalTime queryFrom(TemporalAccessor temporal) {
return from(temporal);
}
});
}
/*▲ 工厂方法 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 转换 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Combines this time with a date to create a {@code LocalDateTime}.
* <p>
* This returns a {@code LocalDateTime} formed from this time at the specified date.
* All possible combinations of date and time are valid.
*
* @param date the date to combine with, not null
*
* @return the local date-time formed from this time and the specified date, not null
*/
// 将当前"本地时间"和指定的"本地日期"整合成一个"本地日期-时间"对象后返回
public LocalDateTime atDate(LocalDate date) {
return LocalDateTime.of(date, this);
}
/**
* Combines this time with an offset to create an {@code OffsetTime}.
* <p>
* This returns an {@code OffsetTime} formed from this time at the specified offset.
* All possible combinations of time and offset are valid.
*
* @param offset the offset to combine with, not null
*
* @return the offset time formed from this time and the specified offset, not null
*/
// 将当前"本地时间"和指定的时区ID整合成一个属于offset时区的"本地时间"对象后返回
public OffsetTime atOffset(ZoneOffset offset) {
return OffsetTime.of(this, offset);
}
/**
* Extracts the time as seconds of day,
* from {@code 0} to {@code 24 * 60 * 60 - 1}.
*
* @return the second-of-day equivalent to this time
*/
// 计算当前"本地时间"包含的秒数
public int toSecondOfDay() {
int total = hour * SECONDS_PER_HOUR;
total += minute * SECONDS_PER_MINUTE;
total += second;
return total;
}
/**
* Extracts the time as nanos of day,
* from {@code 0} to {@code 24 * 60 * 60 * 1,000,000,000 - 1}.
*
* @return the nano of day equivalent to this time
*/
// 计算当前"本地时间"包含的纳秒数
public long toNanoOfDay() {
long total = hour * NANOS_PER_HOUR;
total += minute * NANOS_PER_MINUTE;
total += second * NANOS_PER_SECOND;
total += nano;
return total;
}
/**
* Converts this {@code LocalTime} to the number of seconds since the epoch
* of 1970-01-01T00:00:00Z.
* <p>
* This combines this local time with the specified date 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 date the local date, 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时区的date与当前本地时间捆绑为一个"时间点",并计算该本地时间点下,UTC时区的纪元秒
public long toEpochSecond(LocalDate date, ZoneOffset offset) {
Objects.requireNonNull(date, "date");
Objects.requireNonNull(offset, "offset");
// 返回时间量date的纪元天
long epochDay = date.toEpochDay();
// 将当前"本地时间"转换为一天中的秒数
int seconds = toSecondOfDay();
// 计算出(date+本地时间)代表的纪元秒
long epochSec = epochDay * SECONDS_PER_DAY + seconds;
// 减去时区偏移秒数
epochSec -= offset.getTotalSeconds();
return epochSec;
}
/*▲ 转换 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 部件 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Gets the hour-of-day field.
*
* @return the hour-of-day, from 0 to 23
*/
// (几时)返回"小时"部件[0, 23]
public int getHour() {
return hour;
}
/**
* Gets the minute-of-hour field.
*
* @return the minute-of-hour, from 0 to 59
*/
// (几分)返回"分钟"部件[0, 59]
public int getMinute() {
return minute;
}
/**
* Gets the second-of-minute field.
*
* @return the second-of-minute, from 0 to 59
*/
// (几秒)返回"秒"部件[0, 59]
public int getSecond() {
return second;
}
/**
* Gets the nano-of-second field.
*
* @return the nano-of-second, from 0 to 999,999,999
*/
// (几纳秒)返回"纳秒"部件[0, 999999999]
public int getNano() {
return nano;
}
/*▲ 部件 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 增加 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Returns a copy of this time with the specified amount added.
* <p>
* This returns a {@code LocalTime}, based on this one, with the specified amount added.
* The amount is typically {@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 a {@code LocalTime} based on this time with the addition made, not null
*
* @throws DateTimeException if the addition cannot be made
* @throws ArithmeticException if numeric overflow occurs
*/
/*
* 对当前时间量的值与参数中的"时间段"求和
*
* 如果求和后的值与当前时间量的值相等,则直接返回当前时间量对象。
* 否则,需要构造"求和"后的新对象再返回。
*/
@Override
public LocalTime plus(TemporalAmount amountToAdd) {
return (LocalTime) amountToAdd.addTo(this);
}
/**
* Returns a copy of this time with the specified amount added.
* <p>
* This returns a {@code LocalTime}, 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 NANOS} -
* Returns a {@code LocalTime} with the specified number of nanoseconds added.
* This is equivalent to {@link #plusNanos(long)}.
* <li>{@code MICROS} -
* Returns a {@code LocalTime} with the specified number of microseconds added.
* This is equivalent to {@link #plusNanos(long)} with the amount
* multiplied by 1,000.
* <li>{@code MILLIS} -
* Returns a {@code LocalTime} with the specified number of milliseconds added.
* This is equivalent to {@link #plusNanos(long)} with the amount
* multiplied by 1,000,000.
* <li>{@code SECONDS} -
* Returns a {@code LocalTime} with the specified number of seconds added.
* This is equivalent to {@link #plusSeconds(long)}.
* <li>{@code MINUTES} -
* Returns a {@code LocalTime} with the specified number of minutes added.
* This is equivalent to {@link #plusMinutes(long)}.
* <li>{@code HOURS} -
* Returns a {@code LocalTime} with the specified number of hours added.
* This is equivalent to {@link #plusHours(long)}.
* <li>{@code HALF_DAYS} -
* Returns a {@code LocalTime} with the specified number of half-days added.
* This is equivalent to {@link #plusHours(long)} with the amount
* multiplied by 12.
* </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 LocalTime} based on this 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 LocalTime plus(long amountToAdd, TemporalUnit unit) {
if(unit instanceof ChronoUnit) {
switch((ChronoUnit) unit) {
case NANOS:
return plusNanos(amountToAdd);
case MICROS:
return plusNanos((amountToAdd % MICROS_PER_DAY) * 1000);
case MILLIS:
return plusNanos((amountToAdd % MILLIS_PER_DAY) * 1000_000);
case SECONDS:
return plusSeconds(amountToAdd);
case MINUTES:
return plusMinutes(amountToAdd);
case HOURS:
return plusHours(amountToAdd);
case HALF_DAYS:
return plusHours((amountToAdd % 2) * 12);
}
throw new UnsupportedTemporalTypeException("Unsupported unit: " + unit);
}
return unit.addTo(this, amountToAdd);
}
/**
* Returns a copy of this {@code LocalTime} with the specified number of hours added.
* <p>
* This adds the specified number of hours to this time, returning a new time.
* The calculation wraps around midnight.
* <p>
* This instance is immutable and unaffected by this method call.
*
* @param hoursToAdd the hours to add, may be negative
*
* @return a {@code LocalTime} based on this time with the hours added, not null
*/
/*
* 在当前时间量的值上累加hoursToAdd小时
*
* 如果累加后的值与当前时间量的值相等,则直接返回当前时间量对象。
* 否则,需要构造"累加"操作后的新对象再返回。
*/
public LocalTime plusHours(long hoursToAdd) {
if(hoursToAdd == 0) {
return this;
}
int newHour = ((int) (hoursToAdd % HOURS_PER_DAY) + hour + HOURS_PER_DAY) % HOURS_PER_DAY;
return create(newHour, minute, second, nano);
}
/**
* Returns a copy of this {@code LocalTime} with the specified number of minutes added.
* <p>
* This adds the specified number of minutes to this time, returning a new time.
* The calculation wraps around midnight.
* <p>
* This instance is immutable and unaffected by this method call.
*
* @param minutesToAdd the minutes to add, may be negative
*
* @return a {@code LocalTime} based on this time with the minutes added, not null
*/
/*
* 在当前时间量的值上累加minutesToAdd分钟
*
* 如果累加后的值与当前时间量的值相等,则直接返回当前时间量对象。
* 否则,需要构造"累加"操作后的新对象再返回。
*/
public LocalTime plusMinutes(long minutesToAdd) {
if(minutesToAdd == 0) {
return this;
}
int mofd = hour * MINUTES_PER_HOUR + minute;
int newMofd = ((int) (minutesToAdd % MINUTES_PER_DAY) + mofd + MINUTES_PER_DAY) % MINUTES_PER_DAY;
if(mofd == newMofd) {
return this;
}
int newHour = newMofd / MINUTES_PER_HOUR;
int newMinute = newMofd % MINUTES_PER_HOUR;
return create(newHour, newMinute, second, nano);
}
/**
* Returns a copy of this {@code LocalTime} with the specified number of seconds added.
* <p>
* This adds the specified number of seconds to this time, returning a new time.
* The calculation wraps around midnight.
* <p>
* This instance is immutable and unaffected by this method call.
*
* @param secondstoAdd the seconds to add, may be negative
*
* @return a {@code LocalTime} based on this time with the seconds added, not null
*/
/*
* 在当前时间量的值上累加secondstoAdd秒
*
* 如果累加后的值与当前时间量的值相等,则直接返回当前时间量对象。
* 否则,需要构造"累加"操作后的新对象再返回。
*/
public LocalTime plusSeconds(long secondstoAdd) {
if(secondstoAdd == 0) {
return this;
}
int sofd = hour * SECONDS_PER_HOUR + minute * SECONDS_PER_MINUTE + second;
int newSofd = ((int) (secondstoAdd % SECONDS_PER_DAY) + sofd + SECONDS_PER_DAY) % SECONDS_PER_DAY;
if(sofd == newSofd) {
return this;
}
int newHour = newSofd / SECONDS_PER_HOUR;
int newMinute = (newSofd / SECONDS_PER_MINUTE) % MINUTES_PER_HOUR;
int newSecond = newSofd % SECONDS_PER_MINUTE;
return create(newHour, newMinute, newSecond, nano);
}
/**
* Returns a copy of this {@code LocalTime} with the specified number of nanoseconds added.
* <p>
* This adds the specified number of nanoseconds to this time, returning a new time.
* The calculation wraps around midnight.
* <p>
* This instance is immutable and unaffected by this method call.
*
* @param nanosToAdd the nanos to add, may be negative
*
* @return a {@code LocalTime} based on this time with the nanoseconds added, not null
*/
/*
* 在当前时间量的值上累加nanosToAdd纳秒
*
* 如果累加后的值与当前时间量的值相等,则直接返回当前时间量对象。
* 否则,需要构造"累加"操作后的新对象再返回。
*/
public LocalTime plusNanos(long nanosToAdd) {
if(nanosToAdd == 0) {
return this;
}
long nofd = toNanoOfDay();
long newNofd = ((nanosToAdd % NANOS_PER_DAY) + nofd + NANOS_PER_DAY) % NANOS_PER_DAY;
if(nofd == newNofd) {
return this;
}
int newHour = (int) (newNofd / NANOS_PER_HOUR);
int newMinute = (int) ((newNofd / NANOS_PER_MINUTE) % MINUTES_PER_HOUR);
int newSecond = (int) ((newNofd / NANOS_PER_SECOND) % SECONDS_PER_MINUTE);
int newNano = (int) (newNofd % NANOS_PER_SECOND);
return create(newHour, newMinute, newSecond, newNano);
}
/*▲ 增加 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 减少 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Returns a copy of this time with the specified amount subtracted.
* <p>
* This returns a {@code LocalTime}, based on this one, with the specified amount subtracted.
* The amount is typically {@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#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 LocalTime} based on this time with the subtraction made, not null
*
* @throws DateTimeException if the subtraction cannot be made
* @throws ArithmeticException if numeric overflow occurs
*/
/*