/usr/share/doc/libjoda-time-java/api/org/joda/time/Years.html is in libjoda-time-java-doc 2.4-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Years (Joda-Time 2.4 API)</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Years (Joda-Time 2.4 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Years.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-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/joda/time/YearMonthDay.Property.html" title="class in org.joda.time"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/joda/time/Years.html" target="_top">Frames</a></li>
<li><a href="Years.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<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>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.joda.time</div>
<h2 title="Class Years" class="title">Class Years</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../org/joda/time/base/BaseSingleFieldPeriod.html" title="class in org.joda.time.base">org.joda.time.base.BaseSingleFieldPeriod</a></li>
<li>
<ul class="inheritance">
<li>org.joda.time.Years</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../org/joda/time/base/BaseSingleFieldPeriod.html" title="class in org.joda.time.base">BaseSingleFieldPeriod</a>>, <a href="../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</a></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="strong">Years</span>
extends <a href="../../../org/joda/time/base/BaseSingleFieldPeriod.html" title="class in org.joda.time.base">BaseSingleFieldPeriod</a></pre>
<div class="block">An immutable time period representing a number of years.
<p>
<code>Years</code> is an immutable period that can only store years.
It does not store months, days or hours for example. As such it is a
type-safe way of representing a number of years in an application.
<p>
The number of years is set in the constructor, and may be queried using
<code>getYears()</code>. Basic mathematical operations are provided -
<code>plus()</code>, <code>minus()</code>, <code>multipliedBy()</code> and
<code>dividedBy()</code>.
<p>
<code>Years</code> is thread-safe and immutable.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.4</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../serialized-form.html#org.joda.time.Years">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#MAX_VALUE">MAX_VALUE</a></strong></code>
<div class="block">Constant representing the maximum number of years that can be stored in this object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#MIN_VALUE">MIN_VALUE</a></strong></code>
<div class="block">Constant representing the minimum number of years that can be stored in this object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#ONE">ONE</a></strong></code>
<div class="block">Constant representing one year.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#THREE">THREE</a></strong></code>
<div class="block">Constant representing three years.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#TWO">TWO</a></strong></code>
<div class="block">Constant representing two years.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#ZERO">ZERO</a></strong></code>
<div class="block">Constant representing zero years.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#dividedBy(int)">dividedBy</a></strong>(int divisor)</code>
<div class="block">Returns a new instance with the years divided by the specified divisor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/joda/time/DurationFieldType.html" title="class in org.joda.time">DurationFieldType</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#getFieldType()">getFieldType</a></strong>()</code>
<div class="block">Gets the duration field type, which is <code>years</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#getPeriodType()">getPeriodType</a></strong>()</code>
<div class="block">Gets the period type, which is <code>years</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#getYears()">getYears</a></strong>()</code>
<div class="block">Gets the number of years that this period represents.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#isGreaterThan(org.joda.time.Years)">isGreaterThan</a></strong>(<a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> other)</code>
<div class="block">Is this years instance greater than the specified number of years.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#isLessThan(org.joda.time.Years)">isLessThan</a></strong>(<a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> other)</code>
<div class="block">Is this years instance less than the specified number of years.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#minus(int)">minus</a></strong>(int years)</code>
<div class="block">Returns a new instance with the specified number of years taken away.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#minus(org.joda.time.Years)">minus</a></strong>(<a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> years)</code>
<div class="block">Returns a new instance with the specified number of years taken away.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#multipliedBy(int)">multipliedBy</a></strong>(int scalar)</code>
<div class="block">Returns a new instance with the years multiplied by the specified scalar.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#negated()">negated</a></strong>()</code>
<div class="block">Returns a new instance with the years value negated.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#parseYears(java.lang.String)">parseYears</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> periodStr)</code>
<div class="block">Creates a new <code>Years</code> by parsing a string in the ISO8601 format 'PnY'.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#plus(int)">plus</a></strong>(int years)</code>
<div class="block">Returns a new instance with the specified number of years added.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#plus(org.joda.time.Years)">plus</a></strong>(<a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> years)</code>
<div class="block">Returns a new instance with the specified number of years added.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#toString()">toString</a></strong>()</code>
<div class="block">Gets this instance as a String in the ISO8601 duration format.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#years(int)">years</a></strong>(int years)</code>
<div class="block">Obtains an instance of <code>Years</code> that may be cached.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#yearsBetween(org.joda.time.ReadableInstant,%20org.joda.time.ReadableInstant)">yearsBetween</a></strong>(<a href="../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</a> start,
<a href="../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</a> end)</code>
<div class="block">Creates a <code>Years</code> representing the number of whole years
between the two specified datetimes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#yearsBetween(org.joda.time.ReadablePartial,%20org.joda.time.ReadablePartial)">yearsBetween</a></strong>(<a href="../../../org/joda/time/ReadablePartial.html" title="interface in org.joda.time">ReadablePartial</a> start,
<a href="../../../org/joda/time/ReadablePartial.html" title="interface in org.joda.time">ReadablePartial</a> end)</code>
<div class="block">Creates a <code>Years</code> representing the number of whole years
between the two specified partial datetimes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Years.html#yearsIn(org.joda.time.ReadableInterval)">yearsIn</a></strong>(<a href="../../../org/joda/time/ReadableInterval.html" title="interface in org.joda.time">ReadableInterval</a> interval)</code>
<div class="block">Creates a <code>Years</code> representing the number of whole years
in the specified interval.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.joda.time.base.BaseSingleFieldPeriod">
<!-- -->
</a>
<h3>Methods inherited from class org.joda.time.base.<a href="../../../org/joda/time/base/BaseSingleFieldPeriod.html" title="class in org.joda.time.base">BaseSingleFieldPeriod</a></h3>
<code><a href="../../../org/joda/time/base/BaseSingleFieldPeriod.html#between(org.joda.time.ReadableInstant,%20org.joda.time.ReadableInstant,%20org.joda.time.DurationFieldType)">between</a>, <a href="../../../org/joda/time/base/BaseSingleFieldPeriod.html#between(org.joda.time.ReadablePartial,%20org.joda.time.ReadablePartial,%20org.joda.time.ReadablePeriod)">between</a>, <a href="../../../org/joda/time/base/BaseSingleFieldPeriod.html#compareTo(org.joda.time.base.BaseSingleFieldPeriod)">compareTo</a>, <a href="../../../org/joda/time/base/BaseSingleFieldPeriod.html#equals(java.lang.Object)">equals</a>, <a href="../../../org/joda/time/base/BaseSingleFieldPeriod.html#get(org.joda.time.DurationFieldType)">get</a>, <a href="../../../org/joda/time/base/BaseSingleFieldPeriod.html#getFieldType(int)">getFieldType</a>, <a href="../../../org/joda/time/base/BaseSingleFieldPeriod.html#getValue()">getValue</a>, <a href="../../../org/joda/time/base/BaseSingleFieldPeriod.html#getValue(int)">getValue</a>, <a href="../../../org/joda/time/base/BaseSingleFieldPeriod.html#hashCode()">hashCode</a>, <a href="../../../org/joda/time/base/BaseSingleFieldPeriod.html#isSupported(org.joda.time.DurationFieldType)">isSupported</a>, <a href="../../../org/joda/time/base/BaseSingleFieldPeriod.html#setValue(int)">setValue</a>, <a href="../../../org/joda/time/base/BaseSingleFieldPeriod.html#size()">size</a>, <a href="../../../org/joda/time/base/BaseSingleFieldPeriod.html#standardPeriodIn(org.joda.time.ReadablePeriod,%20long)">standardPeriodIn</a>, <a href="../../../org/joda/time/base/BaseSingleFieldPeriod.html#toMutablePeriod()">toMutablePeriod</a>, <a href="../../../org/joda/time/base/BaseSingleFieldPeriod.html#toPeriod()">toPeriod</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="ZERO">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ZERO</h4>
<pre>public static final <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> ZERO</pre>
<div class="block">Constant representing zero years.</div>
</li>
</ul>
<a name="ONE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ONE</h4>
<pre>public static final <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> ONE</pre>
<div class="block">Constant representing one year.</div>
</li>
</ul>
<a name="TWO">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TWO</h4>
<pre>public static final <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> TWO</pre>
<div class="block">Constant representing two years.</div>
</li>
</ul>
<a name="THREE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>THREE</h4>
<pre>public static final <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> THREE</pre>
<div class="block">Constant representing three years.</div>
</li>
</ul>
<a name="MAX_VALUE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MAX_VALUE</h4>
<pre>public static final <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> MAX_VALUE</pre>
<div class="block">Constant representing the maximum number of years that can be stored in this object.</div>
</li>
</ul>
<a name="MIN_VALUE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MIN_VALUE</h4>
<pre>public static final <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> MIN_VALUE</pre>
<div class="block">Constant representing the minimum number of years that can be stored in this object.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="years(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>years</h4>
<pre>public static <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> years(int years)</pre>
<div class="block">Obtains an instance of <code>Years</code> that may be cached.
<code>Years</code> is immutable, so instances can be cached and shared.
This factory method provides access to shared instances.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>years</code> - the number of years to obtain an instance for</dd>
<dt><span class="strong">Returns:</span></dt><dd>the instance of Years</dd></dl>
</li>
</ul>
<a name="yearsBetween(org.joda.time.ReadableInstant, org.joda.time.ReadableInstant)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>yearsBetween</h4>
<pre>public static <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> yearsBetween(<a href="../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</a> start,
<a href="../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</a> end)</pre>
<div class="block">Creates a <code>Years</code> representing the number of whole years
between the two specified datetimes. This method corectly handles
any daylight savings time changes that may occur during the interval.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>start</code> - the start instant, must not be null</dd><dd><code>end</code> - the end instant, must not be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>the period in years</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the instants are null or invalid</dd></dl>
</li>
</ul>
<a name="yearsBetween(org.joda.time.ReadablePartial, org.joda.time.ReadablePartial)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>yearsBetween</h4>
<pre>public static <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> yearsBetween(<a href="../../../org/joda/time/ReadablePartial.html" title="interface in org.joda.time">ReadablePartial</a> start,
<a href="../../../org/joda/time/ReadablePartial.html" title="interface in org.joda.time">ReadablePartial</a> end)</pre>
<div class="block">Creates a <code>Years</code> representing the number of whole years
between the two specified partial datetimes.
<p>
The two partials must contain the same fields, for example you can specify
two <code>LocalDate</code> objects.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>start</code> - the start partial date, must not be null</dd><dd><code>end</code> - the end partial date, must not be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>the period in years</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the partials are null or invalid</dd></dl>
</li>
</ul>
<a name="yearsIn(org.joda.time.ReadableInterval)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>yearsIn</h4>
<pre>public static <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> yearsIn(<a href="../../../org/joda/time/ReadableInterval.html" title="interface in org.joda.time">ReadableInterval</a> interval)</pre>
<div class="block">Creates a <code>Years</code> representing the number of whole years
in the specified interval. This method corectly handles any daylight
savings time changes that may occur during the interval.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>interval</code> - the interval to extract years from, null returns zero</dd>
<dt><span class="strong">Returns:</span></dt><dd>the period in years</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the partials are null or invalid</dd></dl>
</li>
</ul>
<a name="parseYears(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseYears</h4>
<pre>public static <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> parseYears(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> periodStr)</pre>
<div class="block">Creates a new <code>Years</code> by parsing a string in the ISO8601 format 'PnY'.
<p>
The parse will accept the full ISO syntax of PnYnMnWnDTnHnMnS however only the
years component may be non-zero. If any other component is non-zero, an exception
will be thrown.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>periodStr</code> - the period string, null returns zero</dd>
<dt><span class="strong">Returns:</span></dt><dd>the period in years</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the string format is invalid</dd></dl>
</li>
</ul>
<a name="getFieldType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFieldType</h4>
<pre>public <a href="../../../org/joda/time/DurationFieldType.html" title="class in org.joda.time">DurationFieldType</a> getFieldType()</pre>
<div class="block">Gets the duration field type, which is <code>years</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/joda/time/base/BaseSingleFieldPeriod.html#getFieldType()">getFieldType</a></code> in class <code><a href="../../../org/joda/time/base/BaseSingleFieldPeriod.html" title="class in org.joda.time.base">BaseSingleFieldPeriod</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the period type</dd></dl>
</li>
</ul>
<a name="getPeriodType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPeriodType</h4>
<pre>public <a href="../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</a> getPeriodType()</pre>
<div class="block">Gets the period type, which is <code>years</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/joda/time/ReadablePeriod.html#getPeriodType()">getPeriodType</a></code> in interface <code><a href="../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/joda/time/base/BaseSingleFieldPeriod.html#getPeriodType()">getPeriodType</a></code> in class <code><a href="../../../org/joda/time/base/BaseSingleFieldPeriod.html" title="class in org.joda.time.base">BaseSingleFieldPeriod</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the period type</dd></dl>
</li>
</ul>
<a name="getYears()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getYears</h4>
<pre>public int getYears()</pre>
<div class="block">Gets the number of years that this period represents.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the number of years in the period</dd></dl>
</li>
</ul>
<a name="plus(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>plus</h4>
<pre>public <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> plus(int years)</pre>
<div class="block">Returns a new instance with the specified number of years added.
<p>
This instance is immutable and unaffected by this method call.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>years</code> - the amount of years to add, may be negative</dd>
<dt><span class="strong">Returns:</span></dt><dd>the new period plus the specified number of years</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ArithmeticException.html?is-external=true" title="class or interface in java.lang">ArithmeticException</a></code> - if the result overflows an int</dd></dl>
</li>
</ul>
<a name="plus(org.joda.time.Years)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>plus</h4>
<pre>public <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> plus(<a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> years)</pre>
<div class="block">Returns a new instance with the specified number of years added.
<p>
This instance is immutable and unaffected by this method call.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>years</code> - the amount of years to add, may be negative, null means zero</dd>
<dt><span class="strong">Returns:</span></dt><dd>the new period plus the specified number of years</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ArithmeticException.html?is-external=true" title="class or interface in java.lang">ArithmeticException</a></code> - if the result overflows an int</dd></dl>
</li>
</ul>
<a name="minus(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>minus</h4>
<pre>public <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> minus(int years)</pre>
<div class="block">Returns a new instance with the specified number of years taken away.
<p>
This instance is immutable and unaffected by this method call.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>years</code> - the amount of years to take away, may be negative</dd>
<dt><span class="strong">Returns:</span></dt><dd>the new period minus the specified number of years</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ArithmeticException.html?is-external=true" title="class or interface in java.lang">ArithmeticException</a></code> - if the result overflows an int</dd></dl>
</li>
</ul>
<a name="minus(org.joda.time.Years)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>minus</h4>
<pre>public <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> minus(<a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> years)</pre>
<div class="block">Returns a new instance with the specified number of years taken away.
<p>
This instance is immutable and unaffected by this method call.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>years</code> - the amount of years to take away, may be negative, null means zero</dd>
<dt><span class="strong">Returns:</span></dt><dd>the new period minus the specified number of years</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ArithmeticException.html?is-external=true" title="class or interface in java.lang">ArithmeticException</a></code> - if the result overflows an int</dd></dl>
</li>
</ul>
<a name="multipliedBy(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>multipliedBy</h4>
<pre>public <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> multipliedBy(int scalar)</pre>
<div class="block">Returns a new instance with the years multiplied by the specified scalar.
<p>
This instance is immutable and unaffected by this method call.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>scalar</code> - the amount to multiply by, may be negative</dd>
<dt><span class="strong">Returns:</span></dt><dd>the new period multiplied by the specified scalar</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ArithmeticException.html?is-external=true" title="class or interface in java.lang">ArithmeticException</a></code> - if the result overflows an int</dd></dl>
</li>
</ul>
<a name="dividedBy(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dividedBy</h4>
<pre>public <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> dividedBy(int divisor)</pre>
<div class="block">Returns a new instance with the years divided by the specified divisor.
The calculation uses integer division, thus 3 divided by 2 is 1.
<p>
This instance is immutable and unaffected by this method call.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>divisor</code> - the amount to divide by, may be negative</dd>
<dt><span class="strong">Returns:</span></dt><dd>the new period divided by the specified divisor</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ArithmeticException.html?is-external=true" title="class or interface in java.lang">ArithmeticException</a></code> - if the divisor is zero</dd></dl>
</li>
</ul>
<a name="negated()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>negated</h4>
<pre>public <a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> negated()</pre>
<div class="block">Returns a new instance with the years value negated.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the new period with a negated value</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ArithmeticException.html?is-external=true" title="class or interface in java.lang">ArithmeticException</a></code> - if the result overflows an int</dd></dl>
</li>
</ul>
<a name="isGreaterThan(org.joda.time.Years)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isGreaterThan</h4>
<pre>public boolean isGreaterThan(<a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> other)</pre>
<div class="block">Is this years instance greater than the specified number of years.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>other</code> - the other period, null means zero</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if this years instance is greater than the specified one</dd></dl>
</li>
</ul>
<a name="isLessThan(org.joda.time.Years)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLessThan</h4>
<pre>public boolean isLessThan(<a href="../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a> other)</pre>
<div class="block">Is this years instance less than the specified number of years.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>other</code> - the other period, null means zero</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if this years instance is less than the specified one</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre>
<div class="block">Gets this instance as a String in the ISO8601 duration format.
<p>
For example, "P4Y" represents 4 years.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/joda/time/ReadablePeriod.html#toString()">toString</a></code> in interface <code><a href="../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the value as an ISO8601 string</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Years.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-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/joda/time/YearMonthDay.Property.html" title="class in org.joda.time"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/joda/time/Years.html" target="_top">Frames</a></li>
<li><a href="Years.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<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>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2002–2014 <a href="http://www.joda.org">Joda.org</a>. All rights reserved.</small></p>
</body>
</html>
|