/usr/share/doc/libjoda-time-java/api/org/joda/time/base/AbstractPeriod.html is in libjoda-time-java-doc 2.9.7-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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AbstractPeriod (Joda-Time 2.9.7 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AbstractPeriod (Joda-Time 2.9.7 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/AbstractPeriod.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/base/AbstractPartial.html" title="class in org.joda.time.base"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/joda/time/base/BaseDateTime.html" title="class in org.joda.time.base"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/joda/time/base/AbstractPeriod.html" target="_top">Frames</a></li>
<li><a href="AbstractPeriod.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>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </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.base</div>
<h2 title="Class AbstractPeriod" class="title">Class AbstractPeriod</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/8/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>org.joda.time.base.AbstractPeriod</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/joda/time/base/BasePeriod.html" title="class in org.joda.time.base">BasePeriod</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">AbstractPeriod</span>
extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</a></pre>
<div class="block">AbstractPeriod provides the common behaviour for period classes.
<p>
This class should generally not be used directly by API users. The
<a href="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time"><code>ReadablePeriod</code></a> interface should be used when different
kinds of periods are to be referenced.
<p>
AbstractPeriod subclasses may be mutable and not thread-safe.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/joda/time/base/AbstractPeriod.html#AbstractPeriod--">AbstractPeriod</a></span>()</code>
<div class="block">Constructor.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/joda/time/base/AbstractPeriod.html#equals-java.lang.Object-">equals</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> period)</code>
<div class="block">Compares this object with the specified object for equality based
on the value of each field.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/joda/time/base/AbstractPeriod.html#get-org.joda.time.DurationFieldType-">get</a></span>(<a href="../../../../org/joda/time/DurationFieldType.html" title="class in org.joda.time">DurationFieldType</a> type)</code>
<div class="block">Gets the value of one of the fields.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<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><span class="memberNameLink"><a href="../../../../org/joda/time/base/AbstractPeriod.html#getFieldType-int-">getFieldType</a></span>(int index)</code>
<div class="block">Gets the field type at the specified index.</div>
</td>
</tr>
<tr id="i3" 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><span class="memberNameLink"><a href="../../../../org/joda/time/base/AbstractPeriod.html#getFieldTypes--">getFieldTypes</a></span>()</code>
<div class="block">Gets an array of the field types that this period supports.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/joda/time/base/AbstractPeriod.html#getValues--">getValues</a></span>()</code>
<div class="block">Gets an array of the value of each of the fields that this period supports.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/joda/time/base/AbstractPeriod.html#hashCode--">hashCode</a></span>()</code>
<div class="block">Gets a hash code for the period as defined by ReadablePeriod.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/joda/time/base/AbstractPeriod.html#indexOf-org.joda.time.DurationFieldType-">indexOf</a></span>(<a href="../../../../org/joda/time/DurationFieldType.html" title="class in org.joda.time">DurationFieldType</a> type)</code>
<div class="block">Gets the index of the field in this period.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/joda/time/base/AbstractPeriod.html#isSupported-org.joda.time.DurationFieldType-">isSupported</a></span>(<a href="../../../../org/joda/time/DurationFieldType.html" title="class in org.joda.time">DurationFieldType</a> type)</code>
<div class="block">Checks whether the field specified is supported by this period.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/joda/time/base/AbstractPeriod.html#size--">size</a></span>()</code>
<div class="block">Gets the number of fields that this period supports.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/joda/time/MutablePeriod.html" title="class in org.joda.time">MutablePeriod</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/joda/time/base/AbstractPeriod.html#toMutablePeriod--">toMutablePeriod</a></span>()</code>
<div class="block">Get this object as a <code>MutablePeriod</code>.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../org/joda/time/Period.html" title="class in org.joda.time">Period</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/joda/time/base/AbstractPeriod.html#toPeriod--">toPeriod</a></span>()</code>
<div class="block">Get this period as an immutable <code>Period</code> object.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/joda/time/base/AbstractPeriod.html#toString--">toString</a></span>()</code>
<div class="block">Gets the value as a String in the ISO8601 duration format.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/joda/time/base/AbstractPeriod.html#toString-org.joda.time.format.PeriodFormatter-">toString</a></span>(<a href="../../../../org/joda/time/format/PeriodFormatter.html" title="class in org.joda.time.format">PeriodFormatter</a> formatter)</code>
<div class="block">Uses the specified formatter to convert this period to a String.</div>
</td>
</tr>
</table>
<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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.joda.time.ReadablePeriod">
<!-- -->
</a>
<h3>Methods inherited from interface org.joda.time.<a href="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</a></h3>
<code><a href="../../../../org/joda/time/ReadablePeriod.html#getPeriodType--">getPeriodType</a>, <a href="../../../../org/joda/time/ReadablePeriod.html#getValue-int-">getValue</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractPeriod--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractPeriod</h4>
<pre>protected AbstractPeriod()</pre>
<div class="block">Constructor.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="size--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>public int size()</pre>
<div class="block">Gets the number of fields that this period supports.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/joda/time/ReadablePeriod.html#size--">size</a></code> in interface <code><a href="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of fields supported</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0 (previously on BasePeriod)</dd>
</dl>
</li>
</ul>
<a name="getFieldType-int-">
<!-- -->
</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(int index)</pre>
<div class="block">Gets the field type at the specified index.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/joda/time/ReadablePeriod.html#getFieldType-int-">getFieldType</a></code> in interface <code><a href="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - the index to retrieve</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the field at the specified index</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</a></code> - if the index is invalid</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0 (previously on BasePeriod)</dd>
</dl>
</li>
</ul>
<a name="getFieldTypes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFieldTypes</h4>
<pre>public <a href="../../../../org/joda/time/DurationFieldType.html" title="class in org.joda.time">DurationFieldType</a>[] getFieldTypes()</pre>
<div class="block">Gets an array of the field types that this period supports.
<p>
The fields are returned largest to smallest, for example Hours, Minutes, Seconds.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the fields supported in an array that may be altered, largest to smallest</dd>
</dl>
</li>
</ul>
<a name="getValues--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValues</h4>
<pre>public int[] getValues()</pre>
<div class="block">Gets an array of the value of each of the fields that this period supports.
<p>
The fields are returned largest to smallest, for example Hours, Minutes, Seconds.
Each value corresponds to the same array index as <code>getFields()</code></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current values of each field in an array that may be altered, largest to smallest</dd>
</dl>
</li>
</ul>
<a name="get-org.joda.time.DurationFieldType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public int get(<a href="../../../../org/joda/time/DurationFieldType.html" title="class in org.joda.time">DurationFieldType</a> type)</pre>
<div class="block">Gets the value of one of the fields.
<p>
If the field type specified is not supported by the period then zero
is returned.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/joda/time/ReadablePeriod.html#get-org.joda.time.DurationFieldType-">get</a></code> in interface <code><a href="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - the field type to query, null returns zero</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of that field, zero if field not supported</dd>
</dl>
</li>
</ul>
<a name="isSupported-org.joda.time.DurationFieldType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSupported</h4>
<pre>public boolean isSupported(<a href="../../../../org/joda/time/DurationFieldType.html" title="class in org.joda.time">DurationFieldType</a> type)</pre>
<div class="block">Checks whether the field specified is supported by this period.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/joda/time/ReadablePeriod.html#isSupported-org.joda.time.DurationFieldType-">isSupported</a></code> in interface <code><a href="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - the type to check, may be null which returns false</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the field is supported</dd>
</dl>
</li>
</ul>
<a name="indexOf-org.joda.time.DurationFieldType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indexOf</h4>
<pre>public int indexOf(<a href="../../../../org/joda/time/DurationFieldType.html" title="class in org.joda.time">DurationFieldType</a> type)</pre>
<div class="block">Gets the index of the field in this period.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - the type to check, may be null which returns -1</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the index of -1 if not supported</dd>
</dl>
</li>
</ul>
<a name="toPeriod--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toPeriod</h4>
<pre>public <a href="../../../../org/joda/time/Period.html" title="class in org.joda.time">Period</a> toPeriod()</pre>
<div class="block">Get this period as an immutable <code>Period</code> object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/joda/time/ReadablePeriod.html#toPeriod--">toPeriod</a></code> in interface <code><a href="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Period using the same field set and values</dd>
</dl>
</li>
</ul>
<a name="toMutablePeriod--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toMutablePeriod</h4>
<pre>public <a href="../../../../org/joda/time/MutablePeriod.html" title="class in org.joda.time">MutablePeriod</a> toMutablePeriod()</pre>
<div class="block">Get this object as a <code>MutablePeriod</code>.
<p>
This will always return a new <code>MutablePeriod</code> with the same fields.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/joda/time/ReadablePeriod.html#toMutablePeriod--">toMutablePeriod</a></code> in interface <code><a href="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a MutablePeriod using the same field set and values</dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public boolean equals(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> period)</pre>
<div class="block">Compares this object with the specified object for equality based
on the value of each field. All ReadablePeriod instances are accepted.
<p>
Note that a period of 1 day is not equal to a period of 24 hours,
nor is 1 hour equal to 60 minutes. Only periods with the same amount
in each field are equal.
<p>
This is because periods represent an abstracted definition of a time
period (eg. a day may not actually be 24 hours, it might be 23 or 25
at daylight savings boundary).
<p>
To compare the actual duration of two periods, convert both to
<a href="../../../../org/joda/time/Duration.html" title="class in org.joda.time"><code>Duration</code></a>s, an operation that emphasises
that the result may differ according to the date you choose.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/joda/time/ReadablePeriod.html#equals-java.lang.Object-">equals</a></code> in interface <code><a href="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code> in class <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>period</code> - a readable period to check against</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if all the field values are equal, false if
not or the period is null or of an incorrect type</dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public int hashCode()</pre>
<div class="block">Gets a hash code for the period as defined by ReadablePeriod.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/joda/time/ReadablePeriod.html#hashCode--">hashCode</a></code> in interface <code><a href="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a hash code</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre>
<div class="block">Gets the value as a String in the ISO8601 duration format.
<p>
For example, "PT6H3M7S" represents 6 hours, 3 minutes, 7 seconds.
<p>
For more control over the output, see
<a href="../../../../org/joda/time/format/PeriodFormatterBuilder.html" title="class in org.joda.time.format"><code>PeriodFormatterBuilder</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/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/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value as an ISO8601 string</dd>
</dl>
</li>
</ul>
<a name="toString-org.joda.time.format.PeriodFormatter-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString(<a href="../../../../org/joda/time/format/PeriodFormatter.html" title="class in org.joda.time.format">PeriodFormatter</a> formatter)</pre>
<div class="block">Uses the specified formatter to convert this period to a String.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>formatter</code> - the formatter to use, null means use <code>toString()</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the formatted string</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.5</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/AbstractPeriod.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/base/AbstractPartial.html" title="class in org.joda.time.base"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/joda/time/base/BaseDateTime.html" title="class in org.joda.time.base"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/joda/time/base/AbstractPeriod.html" target="_top">Frames</a></li>
<li><a href="AbstractPeriod.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>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </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–2016 <a href="http://www.joda.org">Joda.org</a>. All rights reserved.</small></p>
</body>
</html>
|