forked from bjmashibing/java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathPeriod.html
More file actions
1547 lines (1546 loc) · 74 KB
/
Period.html
File metadata and controls
1547 lines (1546 loc) · 74 KB
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
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Period (Java SE 12 & JDK 12 )</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="keywords" content="java.time.Period class">
<meta name="keywords" content="ZERO">
<meta name="keywords" content="ofYears()">
<meta name="keywords" content="ofMonths()">
<meta name="keywords" content="ofWeeks()">
<meta name="keywords" content="ofDays()">
<meta name="keywords" content="of()">
<meta name="keywords" content="from()">
<meta name="keywords" content="parse()">
<meta name="keywords" content="between()">
<meta name="keywords" content="get()">
<meta name="keywords" content="getUnits()">
<meta name="keywords" content="getChronology()">
<meta name="keywords" content="isZero()">
<meta name="keywords" content="isNegative()">
<meta name="keywords" content="getYears()">
<meta name="keywords" content="getMonths()">
<meta name="keywords" content="getDays()">
<meta name="keywords" content="withYears()">
<meta name="keywords" content="withMonths()">
<meta name="keywords" content="withDays()">
<meta name="keywords" content="plus()">
<meta name="keywords" content="plusYears()">
<meta name="keywords" content="plusMonths()">
<meta name="keywords" content="plusDays()">
<meta name="keywords" content="minus()">
<meta name="keywords" content="minusYears()">
<meta name="keywords" content="minusMonths()">
<meta name="keywords" content="minusDays()">
<meta name="keywords" content="multipliedBy()">
<meta name="keywords" content="negated()">
<meta name="keywords" content="normalized()">
<meta name="keywords" content="toTotalMonths()">
<meta name="keywords" content="addTo()">
<meta name="keywords" content="subtractFrom()">
<meta name="keywords" content="equals()">
<meta name="keywords" content="hashCode()">
<meta name="keywords" content="toString()">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Period (Java SE 12 & JDK 12 )";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":9,"i2":10,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":9,"i21":9,"i22":9,"i23":9,"i24":9,"i25":9,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Period.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><div style="margin-top: 14px;"><strong>Java SE 12 & JDK 12</strong> </div></div>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding"> </div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="moduleLabelInType">Module</span> <a href="../../module-summary.html">java.base</a></div>
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">java.time</a></div>
<h2 title="Class Period" class="title">Class Period</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="../lang/Object.html" title="class in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>java.time.Period</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../io/Serializable.html" title="interface in java.io">Serializable</a></code>, <code><a href="chrono/ChronoPeriod.html" title="interface in java.time.chrono">ChronoPeriod</a></code>, <code><a href="temporal/TemporalAmount.html" title="interface in java.time.temporal">TemporalAmount</a></code></dd>
</dl>
<hr>
<pre>public final class <span class="typeNameLabel">Period</span>
extends <a href="../lang/Object.html" title="class in java.lang">Object</a>
implements <a href="chrono/ChronoPeriod.html" title="interface in java.time.chrono">ChronoPeriod</a>, <a href="../io/Serializable.html" title="interface in java.io">Serializable</a></pre>
<div class="block">A date-based amount of time in the ISO-8601 calendar system,
such as '2 years, 3 months and 4 days'.
<p>
This class models a quantity or amount of time in terms of years, months and days.
See <a href="Duration.html" title="class in java.time"><code>Duration</code></a> for the time-based equivalent to this class.
<p>
Durations and periods differ in their treatment of daylight savings time
when added to <a href="ZonedDateTime.html" title="class in java.time"><code>ZonedDateTime</code></a>. A <code>Duration</code> will add an exact
number of seconds, thus a duration of one day is always exactly 24 hours.
By contrast, a <code>Period</code> will add a conceptual day, trying to maintain
the local time.
<p>
For example, consider adding a period of one day and a duration of one day to
18:00 on the evening before a daylight savings gap. The <code>Period</code> will add
the conceptual day and result in a <code>ZonedDateTime</code> at 18:00 the following day.
By contrast, the <code>Duration</code> will add exactly 24 hours, resulting in a
<code>ZonedDateTime</code> at 19:00 the following day (assuming a one hour DST gap).
<p>
The supported units of a period are <a href="temporal/ChronoUnit.html#YEARS"><code>YEARS</code></a>,
<a href="temporal/ChronoUnit.html#MONTHS"><code>MONTHS</code></a> and <a href="temporal/ChronoUnit.html#DAYS"><code>DAYS</code></a>.
All three fields are always present, but may be set to zero.
<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.
<p>
The period is modeled as a directed amount of time, meaning that individual parts of the
period may be negative.
<p>
This is a <a href="../../../java.base/java/lang/doc-files/ValueBased.html">value-based</a>
class; use of identity-sensitive operations (including reference equality
(<code>==</code>), identity hash code, or synchronization) on instances of
<code>Period</code> may have unpredictable results and should be avoided.
The <code>equals</code> method should be used for comparisons.</div>
<dl>
<dt><span class="simpleTagLabel">Implementation Requirements:</span></dt>
<dd>This class is immutable and thread-safe.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.8</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../serialized-form.html#java.time.Period">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<div class="memberSummary">
<table>
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static <a href="Period.html" title="class in java.time">Period</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ZERO">ZERO</a></span></code></th>
<td class="colLast">
<div class="block">A constant for a period of zero.</div>
</td>
</tr>
</tbody>
</table>
</div>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<div class="memberSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor" id="i0">
<td class="colFirst"><code><a href="temporal/Temporal.html" title="interface in java.time.temporal">Temporal</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addTo(java.time.temporal.Temporal)">addTo</a></span>​(<a href="temporal/Temporal.html" title="interface in java.time.temporal">Temporal</a> temporal)</code></th>
<td class="colLast">
<div class="block">Adds this period to the specified temporal object.</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>static <a href="Period.html" title="class in java.time">Period</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#between(java.time.LocalDate,java.time.LocalDate)">between</a></span>​(<a href="LocalDate.html" title="class in java.time">LocalDate</a> startDateInclusive,
<a href="LocalDate.html" title="class in java.time">LocalDate</a> endDateExclusive)</code></th>
<td class="colLast">
<div class="block">Obtains a <code>Period</code> consisting of the number of years, months,
and days between two dates.</div>
</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>​(<a href="../lang/Object.html" title="class in java.lang">Object</a> obj)</code></th>
<td class="colLast">
<div class="block">Checks if this period is equal to another period.</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>static <a href="Period.html" title="class in java.time">Period</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#from(java.time.temporal.TemporalAmount)">from</a></span>​(<a href="temporal/TemporalAmount.html" title="interface in java.time.temporal">TemporalAmount</a> amount)</code></th>
<td class="colLast">
<div class="block">Obtains an instance of <code>Period</code> from a temporal amount.</div>
</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(java.time.temporal.TemporalUnit)">get</a></span>​(<a href="temporal/TemporalUnit.html" title="interface in java.time.temporal">TemporalUnit</a> unit)</code></th>
<td class="colLast">
<div class="block">Gets the value of the requested unit.</div>
</td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code><a href="chrono/IsoChronology.html" title="class in java.time.chrono">IsoChronology</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getChronology()">getChronology</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the chronology of this period, which is the ISO calendar system.</div>
</td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDays()">getDays</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the amount of days of this period.</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMonths()">getMonths</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the amount of months of this period.</div>
</td>
</tr>
<tr class="altColor" id="i8">
<td class="colFirst"><code><a href="../util/List.html" title="interface in java.util">List</a><<a href="temporal/TemporalUnit.html" title="interface in java.time.temporal">TemporalUnit</a>></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUnits()">getUnits</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the set of units supported by this period.</div>
</td>
</tr>
<tr class="rowColor" id="i9">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getYears()">getYears</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the amount of years of this period.</div>
</td>
</tr>
<tr class="altColor" id="i10">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th>
<td class="colLast">
<div class="block">A hash code for this period.</div>
</td>
</tr>
<tr class="rowColor" id="i11">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isNegative()">isNegative</a></span>()</code></th>
<td class="colLast">
<div class="block">Checks if any of the three units of this period are negative.</div>
</td>
</tr>
<tr class="altColor" id="i12">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isZero()">isZero</a></span>()</code></th>
<td class="colLast">
<div class="block">Checks if all three units of this period are zero.</div>
</td>
</tr>
<tr class="rowColor" id="i13">
<td class="colFirst"><code><a href="Period.html" title="class in java.time">Period</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#minus(java.time.temporal.TemporalAmount)">minus</a></span>​(<a href="temporal/TemporalAmount.html" title="interface in java.time.temporal">TemporalAmount</a> amountToSubtract)</code></th>
<td class="colLast">
<div class="block">Returns a copy of this period with the specified period subtracted.</div>
</td>
</tr>
<tr class="altColor" id="i14">
<td class="colFirst"><code><a href="Period.html" title="class in java.time">Period</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#minusDays(long)">minusDays</a></span>​(long daysToSubtract)</code></th>
<td class="colLast">
<div class="block">Returns a copy of this period with the specified days subtracted.</div>
</td>
</tr>
<tr class="rowColor" id="i15">
<td class="colFirst"><code><a href="Period.html" title="class in java.time">Period</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#minusMonths(long)">minusMonths</a></span>​(long monthsToSubtract)</code></th>
<td class="colLast">
<div class="block">Returns a copy of this period with the specified months subtracted.</div>
</td>
</tr>
<tr class="altColor" id="i16">
<td class="colFirst"><code><a href="Period.html" title="class in java.time">Period</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#minusYears(long)">minusYears</a></span>​(long yearsToSubtract)</code></th>
<td class="colLast">
<div class="block">Returns a copy of this period with the specified years subtracted.</div>
</td>
</tr>
<tr class="rowColor" id="i17">
<td class="colFirst"><code><a href="Period.html" title="class in java.time">Period</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#multipliedBy(int)">multipliedBy</a></span>​(int scalar)</code></th>
<td class="colLast">
<div class="block">Returns a new instance with each element in this period multiplied
by the specified scalar.</div>
</td>
</tr>
<tr class="altColor" id="i18">
<td class="colFirst"><code><a href="Period.html" title="class in java.time">Period</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#negated()">negated</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a new instance with each amount in this period negated.</div>
</td>
</tr>
<tr class="rowColor" id="i19">
<td class="colFirst"><code><a href="Period.html" title="class in java.time">Period</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#normalized()">normalized</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a copy of this period with the years and months normalized.</div>
</td>
</tr>
<tr class="altColor" id="i20">
<td class="colFirst"><code>static <a href="Period.html" title="class in java.time">Period</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(int,int,int)">of</a></span>​(int years,
int months,
int days)</code></th>
<td class="colLast">
<div class="block">Obtains a <code>Period</code> representing a number of years, months and days.</div>
</td>
</tr>
<tr class="rowColor" id="i21">
<td class="colFirst"><code>static <a href="Period.html" title="class in java.time">Period</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ofDays(int)">ofDays</a></span>​(int days)</code></th>
<td class="colLast">
<div class="block">Obtains a <code>Period</code> representing a number of days.</div>
</td>
</tr>
<tr class="altColor" id="i22">
<td class="colFirst"><code>static <a href="Period.html" title="class in java.time">Period</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ofMonths(int)">ofMonths</a></span>​(int months)</code></th>
<td class="colLast">
<div class="block">Obtains a <code>Period</code> representing a number of months.</div>
</td>
</tr>
<tr class="rowColor" id="i23">
<td class="colFirst"><code>static <a href="Period.html" title="class in java.time">Period</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ofWeeks(int)">ofWeeks</a></span>​(int weeks)</code></th>
<td class="colLast">
<div class="block">Obtains a <code>Period</code> representing a number of weeks.</div>
</td>
</tr>
<tr class="altColor" id="i24">
<td class="colFirst"><code>static <a href="Period.html" title="class in java.time">Period</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ofYears(int)">ofYears</a></span>​(int years)</code></th>
<td class="colLast">
<div class="block">Obtains a <code>Period</code> representing a number of years.</div>
</td>
</tr>
<tr class="rowColor" id="i25">
<td class="colFirst"><code>static <a href="Period.html" title="class in java.time">Period</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parse(java.lang.CharSequence)">parse</a></span>​(<a href="../lang/CharSequence.html" title="interface in java.lang">CharSequence</a> text)</code></th>
<td class="colLast">
<div class="block">Obtains a <code>Period</code> from a text string such as <code>PnYnMnD</code>.</div>
</td>
</tr>
<tr class="altColor" id="i26">
<td class="colFirst"><code><a href="Period.html" title="class in java.time">Period</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#plus(java.time.temporal.TemporalAmount)">plus</a></span>​(<a href="temporal/TemporalAmount.html" title="interface in java.time.temporal">TemporalAmount</a> amountToAdd)</code></th>
<td class="colLast">
<div class="block">Returns a copy of this period with the specified period added.</div>
</td>
</tr>
<tr class="rowColor" id="i27">
<td class="colFirst"><code><a href="Period.html" title="class in java.time">Period</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#plusDays(long)">plusDays</a></span>​(long daysToAdd)</code></th>
<td class="colLast">
<div class="block">Returns a copy of this period with the specified days added.</div>
</td>
</tr>
<tr class="altColor" id="i28">
<td class="colFirst"><code><a href="Period.html" title="class in java.time">Period</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#plusMonths(long)">plusMonths</a></span>​(long monthsToAdd)</code></th>
<td class="colLast">
<div class="block">Returns a copy of this period with the specified months added.</div>
</td>
</tr>
<tr class="rowColor" id="i29">
<td class="colFirst"><code><a href="Period.html" title="class in java.time">Period</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#plusYears(long)">plusYears</a></span>​(long yearsToAdd)</code></th>
<td class="colLast">
<div class="block">Returns a copy of this period with the specified years added.</div>
</td>
</tr>
<tr class="altColor" id="i30">
<td class="colFirst"><code><a href="temporal/Temporal.html" title="interface in java.time.temporal">Temporal</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#subtractFrom(java.time.temporal.Temporal)">subtractFrom</a></span>​(<a href="temporal/Temporal.html" title="interface in java.time.temporal">Temporal</a> temporal)</code></th>
<td class="colLast">
<div class="block">Subtracts this period from the specified temporal object.</div>
</td>
</tr>
<tr class="rowColor" id="i31">
<td class="colFirst"><code><a href="../lang/String.html" title="class in java.lang">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">
<div class="block">Outputs this period as a <code>String</code>, such as <code>P6Y3M1D</code>.</div>
</td>
</tr>
<tr class="altColor" id="i32">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toTotalMonths()">toTotalMonths</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the total number of months in this period.</div>
</td>
</tr>
<tr class="rowColor" id="i33">
<td class="colFirst"><code><a href="Period.html" title="class in java.time">Period</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withDays(int)">withDays</a></span>​(int days)</code></th>
<td class="colLast">
<div class="block">Returns a copy of this period with the specified amount of days.</div>
</td>
</tr>
<tr class="altColor" id="i34">
<td class="colFirst"><code><a href="Period.html" title="class in java.time">Period</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withMonths(int)">withMonths</a></span>​(int months)</code></th>
<td class="colLast">
<div class="block">Returns a copy of this period with the specified amount of months.</div>
</td>
</tr>
<tr class="rowColor" id="i35">
<td class="colFirst"><code><a href="Period.html" title="class in java.time">Period</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withYears(int)">withYears</a></span>​(int years)</code></th>
<td class="colLast">
<div class="block">Returns a copy of this period with the specified amount of years.</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods declared in class java.lang.<a href="../lang/Object.html" title="class in java.lang">Object</a></h3>
<code><a href="../lang/Object.html#clone()">clone</a>, <a href="../lang/Object.html#finalize()">finalize</a>, <a href="../lang/Object.html#getClass()">getClass</a>, <a href="../lang/Object.html#notify()">notify</a>, <a href="../lang/Object.html#notifyAll()">notifyAll</a>, <a href="../lang/Object.html#wait()">wait</a>, <a href="../lang/Object.html#wait(long)">wait</a>, <a href="../lang/Object.html#wait(long,int)">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="ZERO">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ZERO</h4>
<pre>public static final <a href="Period.html" title="class in java.time">Period</a> ZERO</pre>
<div class="block">A constant for a period of zero.</div>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="ofYears(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ofYears</h4>
<pre class="methodSignature">public static <a href="Period.html" title="class in java.time">Period</a> ofYears​(int years)</pre>
<div class="block">Obtains a <code>Period</code> representing a number of years.
<p>
The resulting period will have the specified years.
The months and days units will be zero.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>years</code> - the number of years, positive or negative</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the period of years, not null</dd>
</dl>
</li>
</ul>
<a id="ofMonths(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ofMonths</h4>
<pre class="methodSignature">public static <a href="Period.html" title="class in java.time">Period</a> ofMonths​(int months)</pre>
<div class="block">Obtains a <code>Period</code> representing a number of months.
<p>
The resulting period will have the specified months.
The years and days units will be zero.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>months</code> - the number of months, positive or negative</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the period of months, not null</dd>
</dl>
</li>
</ul>
<a id="ofWeeks(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ofWeeks</h4>
<pre class="methodSignature">public static <a href="Period.html" title="class in java.time">Period</a> ofWeeks​(int weeks)</pre>
<div class="block">Obtains a <code>Period</code> representing a number of weeks.
<p>
The resulting period will be day-based, with the amount of days
equal to the number of weeks multiplied by 7.
The years and months units will be zero.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>weeks</code> - the number of weeks, positive or negative</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the period, with the input weeks converted to days, not null</dd>
</dl>
</li>
</ul>
<a id="ofDays(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ofDays</h4>
<pre class="methodSignature">public static <a href="Period.html" title="class in java.time">Period</a> ofDays​(int days)</pre>
<div class="block">Obtains a <code>Period</code> representing a number of days.
<p>
The resulting period will have the specified days.
The years and months units will be zero.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>days</code> - the number of days, positive or negative</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the period of days, not null</dd>
</dl>
</li>
</ul>
<a id="of(int,int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>of</h4>
<pre class="methodSignature">public static <a href="Period.html" title="class in java.time">Period</a> of​(int years,
int months,
int days)</pre>
<div class="block">Obtains a <code>Period</code> representing a number of years, months and days.
<p>
This creates an instance based on years, months and days.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>years</code> - the amount of years, may be negative</dd>
<dd><code>months</code> - the amount of months, may be negative</dd>
<dd><code>days</code> - the amount of days, may be negative</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the period of years, months and days, not null</dd>
</dl>
</li>
</ul>
<a id="from(java.time.temporal.TemporalAmount)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>from</h4>
<pre class="methodSignature">public static <a href="Period.html" title="class in java.time">Period</a> from​(<a href="temporal/TemporalAmount.html" title="interface in java.time.temporal">TemporalAmount</a> amount)</pre>
<div class="block">Obtains an instance of <code>Period</code> from a temporal amount.
<p>
This obtains a period based on the specified amount.
A <code>TemporalAmount</code> represents an amount of time, which may be
date-based or time-based, which this factory extracts to a <code>Period</code>.
<p>
The conversion loops around the set of units from the amount and uses
the <a href="temporal/ChronoUnit.html#YEARS"><code>YEARS</code></a>, <a href="temporal/ChronoUnit.html#MONTHS"><code>MONTHS</code></a>
and <a href="temporal/ChronoUnit.html#DAYS"><code>DAYS</code></a> units to create a period.
If any other units are found then an exception is thrown.
<p>
If the amount is a <code>ChronoPeriod</code> then it must use the ISO chronology.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>amount</code> - the temporal amount to convert, not null</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the equivalent period, not null</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="DateTimeException.html" title="class in java.time">DateTimeException</a></code> - if unable to convert to a <code>Period</code></dd>
<dd><code><a href="../lang/ArithmeticException.html" title="class in java.lang">ArithmeticException</a></code> - if the amount of years, months or days exceeds an int</dd>
</dl>
</li>
</ul>
<a id="parse(java.lang.CharSequence)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre class="methodSignature">public static <a href="Period.html" title="class in java.time">Period</a> parse​(<a href="../lang/CharSequence.html" title="interface in java.lang">CharSequence</a> text)</pre>
<div class="block">Obtains a <code>Period</code> from a text string such as <code>PnYnMnD</code>.
<p>
This will parse the string produced by <code>toString()</code> which is
based on the ISO-8601 period formats <code>PnYnMnD</code> and <code>PnW</code>.
<p>
The string starts with an optional sign, denoted by the ASCII negative
or positive symbol. If negative, the whole period is negated.
The ASCII letter "P" is next in upper or lower case.
There are then four sections, each consisting of a number and a suffix.
At least one of the four sections must be present.
The sections have suffixes in ASCII of "Y", "M", "W" and "D" for
years, months, weeks and days, accepted in upper or lower case.
The suffixes must occur in order.
The number part of each section must consist of ASCII digits.
The number may be prefixed by the ASCII negative or positive symbol.
The number must parse to an <code>int</code>.
<p>
The leading plus/minus sign, and negative values for other units are
not part of the ISO-8601 standard. In addition, ISO-8601 does not
permit mixing between the <code>PnYnMnD</code> and <code>PnW</code> formats.
Any week-based input is multiplied by 7 and treated as a number of days.
<p>
For example, the following are valid inputs:
<pre>
"P2Y" -- Period.ofYears(2)
"P3M" -- Period.ofMonths(3)
"P4W" -- Period.ofWeeks(4)
"P5D" -- Period.ofDays(5)
"P1Y2M3D" -- Period.of(1, 2, 3)
"P1Y2M3W4D" -- Period.of(1, 2, 25)
"P-1Y2M" -- Period.of(-1, 2, 0)
"-P1Y2M" -- Period.of(-1, -2, 0)
</pre></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>text</code> - the text to parse, not null</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the parsed period, not null</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="format/DateTimeParseException.html" title="class in java.time.format">DateTimeParseException</a></code> - if the text cannot be parsed to a period</dd>
</dl>
</li>
</ul>
<a id="between(java.time.LocalDate,java.time.LocalDate)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>between</h4>
<pre class="methodSignature">public static <a href="Period.html" title="class in java.time">Period</a> between​(<a href="LocalDate.html" title="class in java.time">LocalDate</a> startDateInclusive,
<a href="LocalDate.html" title="class in java.time">LocalDate</a> endDateExclusive)</pre>
<div class="block">Obtains a <code>Period</code> consisting of the number of years, months,
and days between two dates.
<p>
The start date is included, but the end date is not.
The period is calculated by removing complete months, then calculating
the remaining number of days, adjusting to ensure that both have the same sign.
The number of months is then split into years and months based on a 12 month year.
A month is considered if the end day-of-month is greater than or equal to the start day-of-month.
For example, from <code>2010-01-15</code> to <code>2011-03-18</code> is one year, two months and three days.
<p>
The result of this method can be a negative period if the end is before the start.
The negative sign will be the same in each of year, month and day.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>startDateInclusive</code> - the start date, inclusive, not null</dd>
<dd><code>endDateExclusive</code> - the end date, exclusive, not null</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the period between this date and the end date, not null</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="chrono/ChronoLocalDate.html#until(java.time.chrono.ChronoLocalDate)"><code>ChronoLocalDate.until(ChronoLocalDate)</code></a></dd>
</dl>
</li>
</ul>
<a id="get(java.time.temporal.TemporalUnit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre class="methodSignature">public long get​(<a href="temporal/TemporalUnit.html" title="interface in java.time.temporal">TemporalUnit</a> unit)</pre>
<div class="block">Gets the value of the requested unit.
<p>
This returns a value for each of the three supported units,
<a href="temporal/ChronoUnit.html#YEARS"><code>YEARS</code></a>, <a href="temporal/ChronoUnit.html#MONTHS"><code>MONTHS</code></a> and
<a href="temporal/ChronoUnit.html#DAYS"><code>DAYS</code></a>.
All other units throw an exception.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="chrono/ChronoPeriod.html#get(java.time.temporal.TemporalUnit)">get</a></code> in interface <code><a href="chrono/ChronoPeriod.html" title="interface in java.time.chrono">ChronoPeriod</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="temporal/TemporalAmount.html#get(java.time.temporal.TemporalUnit)">get</a></code> in interface <code><a href="temporal/TemporalAmount.html" title="interface in java.time.temporal">TemporalAmount</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>unit</code> - the <code>TemporalUnit</code> for which to return the value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the long value of the unit</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="DateTimeException.html" title="class in java.time">DateTimeException</a></code> - if the unit is not supported</dd>
<dd><code><a href="temporal/UnsupportedTemporalTypeException.html" title="class in java.time.temporal">UnsupportedTemporalTypeException</a></code> - if the unit is not supported</dd>
</dl>
</li>
</ul>
<a id="getUnits()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUnits</h4>
<pre class="methodSignature">public <a href="../util/List.html" title="interface in java.util">List</a><<a href="temporal/TemporalUnit.html" title="interface in java.time.temporal">TemporalUnit</a>> getUnits()</pre>
<div class="block">Gets the set of units supported by this period.
<p>
The supported units are <a href="temporal/ChronoUnit.html#YEARS"><code>YEARS</code></a>,
<a href="temporal/ChronoUnit.html#MONTHS"><code>MONTHS</code></a> and <a href="temporal/ChronoUnit.html#DAYS"><code>DAYS</code></a>.
They are returned in the order years, months, days.
<p>
This set can be used in conjunction with <a href="#get(java.time.temporal.TemporalUnit)"><code>get(TemporalUnit)</code></a>
to access the entire state of the period.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="chrono/ChronoPeriod.html#getUnits()">getUnits</a></code> in interface <code><a href="chrono/ChronoPeriod.html" title="interface in java.time.chrono">ChronoPeriod</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="temporal/TemporalAmount.html#getUnits()">getUnits</a></code> in interface <code><a href="temporal/TemporalAmount.html" title="interface in java.time.temporal">TemporalAmount</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list containing the years, months and days units, not null</dd>
</dl>
</li>
</ul>
<a id="getChronology()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChronology</h4>
<pre class="methodSignature">public <a href="chrono/IsoChronology.html" title="class in java.time.chrono">IsoChronology</a> getChronology()</pre>
<div class="block">Gets the chronology of this period, which is the ISO calendar system.
<p>
The <code>Chronology</code> represents the calendar system in use.
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.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="chrono/ChronoPeriod.html#getChronology()">getChronology</a></code> in interface <code><a href="chrono/ChronoPeriod.html" title="interface in java.time.chrono">ChronoPeriod</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the ISO chronology, not null</dd>
</dl>
</li>
</ul>
<a id="isZero()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isZero</h4>
<pre class="methodSignature">public boolean isZero()</pre>
<div class="block">Checks if all three units of this period are zero.
<p>
A zero period has the value zero for the years, months and days units.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="chrono/ChronoPeriod.html#isZero()">isZero</a></code> in interface <code><a href="chrono/ChronoPeriod.html" title="interface in java.time.chrono">ChronoPeriod</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this period is zero-length</dd>
</dl>
</li>
</ul>
<a id="isNegative()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNegative</h4>
<pre class="methodSignature">public boolean isNegative()</pre>
<div class="block">Checks if any of the three units of this period are negative.
<p>
This checks whether the years, months or days units are less than zero.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="chrono/ChronoPeriod.html#isNegative()">isNegative</a></code> in interface <code><a href="chrono/ChronoPeriod.html" title="interface in java.time.chrono">ChronoPeriod</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if any unit of this period is negative</dd>
</dl>
</li>
</ul>
<a id="getYears()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getYears</h4>
<pre class="methodSignature">public int getYears()</pre>
<div class="block">Gets the amount of years of this period.
<p>
This returns the years unit.
<p>
The months unit is not automatically normalized with the years unit.
This means that a period of "15 months" is different to a period
of "1 year and 3 months".</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the amount of years of this period, may be negative</dd>
</dl>
</li>
</ul>
<a id="getMonths()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMonths</h4>
<pre class="methodSignature">public int getMonths()</pre>
<div class="block">Gets the amount of months of this period.
<p>
This returns the months unit.
<p>
The months unit is not automatically normalized with the years unit.
This means that a period of "15 months" is different to a period
of "1 year and 3 months".</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the amount of months of this period, may be negative</dd>
</dl>
</li>
</ul>
<a id="getDays()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDays</h4>
<pre class="methodSignature">public int getDays()</pre>
<div class="block">Gets the amount of days of this period.
<p>
This returns the days unit.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the amount of days of this period, may be negative</dd>
</dl>
</li>
</ul>
<a id="withYears(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withYears</h4>
<pre class="methodSignature">public <a href="Period.html" title="class in java.time">Period</a> withYears​(int years)</pre>
<div class="block">Returns a copy of this period with the specified amount of years.
<p>
This sets the amount of the years unit in a copy of this period.
The months and days units are unaffected.
<p>
The months unit is not automatically normalized with the years unit.
This means that a period of "15 months" is different to a period
of "1 year and 3 months".
<p>
This instance is immutable and unaffected by this method call.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>years</code> - the years to represent, may be negative</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>Period</code> based on this period with the requested years, not null</dd>
</dl>
</li>
</ul>
<a id="withMonths(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withMonths</h4>
<pre class="methodSignature">public <a href="Period.html" title="class in java.time">Period</a> withMonths​(int months)</pre>
<div class="block">Returns a copy of this period with the specified amount of months.
<p>
This sets the amount of the months unit in a copy of this period.
The years and days units are unaffected.
<p>
The months unit is not automatically normalized with the years unit.
This means that a period of "15 months" is different to a period
of "1 year and 3 months".
<p>
This instance is immutable and unaffected by this method call.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>months</code> - the months to represent, may be negative</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>Period</code> based on this period with the requested months, not null</dd>
</dl>
</li>
</ul>
<a id="withDays(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withDays</h4>
<pre class="methodSignature">public <a href="Period.html" title="class in java.time">Period</a> withDays​(int days)</pre>
<div class="block">Returns a copy of this period with the specified amount of days.
<p>
This sets the amount of the days unit in a copy of this period.