/usr/share/doc/libjoda-time-java/api/org/joda/time/base/BaseSingleFieldPeriod.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 | <!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>BaseSingleFieldPeriod (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="BaseSingleFieldPeriod (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/BaseSingleFieldPeriod.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/BasePeriod.html" title="class in org.joda.time.base"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/joda/time/base/BaseSingleFieldPeriod.html" target="_top">Frames</a></li>
<li><a href="BaseSingleFieldPeriod.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 BaseSingleFieldPeriod" class="title">Class BaseSingleFieldPeriod</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>org.joda.time.base.BaseSingleFieldPeriod</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>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/joda/time/Days.html" title="class in org.joda.time">Days</a>, <a href="../../../../org/joda/time/Hours.html" title="class in org.joda.time">Hours</a>, <a href="../../../../org/joda/time/Minutes.html" title="class in org.joda.time">Minutes</a>, <a href="../../../../org/joda/time/Months.html" title="class in org.joda.time">Months</a>, <a href="../../../../org/joda/time/Seconds.html" title="class in org.joda.time">Seconds</a>, <a href="../../../../org/joda/time/Weeks.html" title="class in org.joda.time">Weeks</a>, <a href="../../../../org/joda/time/Years.html" title="class in org.joda.time">Years</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">BaseSingleFieldPeriod</span>
extends <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>
implements <a href="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</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="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
<div class="block">BaseSingleFieldPeriod is an abstract implementation of ReadablePeriod that
manages a single duration field, such as days or minutes.
<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 period objects are to be referenced.
<p>
BaseSingleFieldPeriod subclasses may be mutable and not thread-safe.</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.base.BaseSingleFieldPeriod">Serialized Form</a></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="overviewSummary" 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><strong><a href="../../../../org/joda/time/base/BaseSingleFieldPeriod.html#BaseSingleFieldPeriod(int)">BaseSingleFieldPeriod</a></strong>(int period)</code>
<div class="block">Creates a new instance representing the specified period.</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>protected static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/base/BaseSingleFieldPeriod.html#between(org.joda.time.ReadableInstant,%20org.joda.time.ReadableInstant,%20org.joda.time.DurationFieldType)">between</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,
<a href="../../../../org/joda/time/DurationFieldType.html" title="class in org.joda.time">DurationFieldType</a> field)</code>
<div class="block">Calculates the number of whole units between the two specified datetimes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/base/BaseSingleFieldPeriod.html#between(org.joda.time.ReadablePartial,%20org.joda.time.ReadablePartial,%20org.joda.time.ReadablePeriod)">between</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,
<a href="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</a> zeroInstance)</code>
<div class="block">Calculates the number of whole units between the two specified partial datetimes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/base/BaseSingleFieldPeriod.html#compareTo(org.joda.time.base.BaseSingleFieldPeriod)">compareTo</a></strong>(<a href="../../../../org/joda/time/base/BaseSingleFieldPeriod.html" title="class in org.joda.time.base">BaseSingleFieldPeriod</a> other)</code>
<div class="block">Compares this period to another object of the same class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/base/BaseSingleFieldPeriod.html#equals(java.lang.Object)">equals</a></strong>(<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> 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 class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/base/BaseSingleFieldPeriod.html#get(org.joda.time.DurationFieldType)">get</a></strong>(<a href="../../../../org/joda/time/DurationFieldType.html" title="class in org.joda.time">DurationFieldType</a> type)</code>
<div class="block">Gets the value of a duration field represented by this period.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract <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/base/BaseSingleFieldPeriod.html#getFieldType()">getFieldType</a></strong>()</code>
<div class="block">Gets the single duration field type.</div>
</td>
</tr>
<tr 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><strong><a href="../../../../org/joda/time/base/BaseSingleFieldPeriod.html#getFieldType(int)">getFieldType</a></strong>(int index)</code>
<div class="block">Gets the field type at the specified index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract <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/base/BaseSingleFieldPeriod.html#getPeriodType()">getPeriodType</a></strong>()</code>
<div class="block">Gets the period type which matches the duration field type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/base/BaseSingleFieldPeriod.html#getValue()">getValue</a></strong>()</code>
<div class="block">Gets the amount of this period.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/base/BaseSingleFieldPeriod.html#getValue(int)">getValue</a></strong>(int index)</code>
<div class="block">Gets the value at the specified index.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/base/BaseSingleFieldPeriod.html#hashCode()">hashCode</a></strong>()</code>
<div class="block">Gets a hash code for the period as defined by ReadablePeriod.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/base/BaseSingleFieldPeriod.html#isSupported(org.joda.time.DurationFieldType)">isSupported</a></strong>(<a href="../../../../org/joda/time/DurationFieldType.html" title="class in org.joda.time">DurationFieldType</a> type)</code>
<div class="block">Checks whether the duration field specified is supported by this period.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/base/BaseSingleFieldPeriod.html#setValue(int)">setValue</a></strong>(int value)</code>
<div class="block">Sets the amount of this period.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/base/BaseSingleFieldPeriod.html#size()">size</a></strong>()</code>
<div class="block">Gets the number of fields that this period supports, which is one.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/base/BaseSingleFieldPeriod.html#standardPeriodIn(org.joda.time.ReadablePeriod,%20long)">standardPeriodIn</a></strong>(<a href="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</a> period,
long millisPerUnit)</code>
<div class="block">Creates a new instance representing the number of complete standard length units
in the specified period.</div>
</td>
</tr>
<tr 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><strong><a href="../../../../org/joda/time/base/BaseSingleFieldPeriod.html#toMutablePeriod()">toMutablePeriod</a></strong>()</code>
<div class="block">Get this object as a <code>MutablePeriod</code>.</div>
</td>
</tr>
<tr 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><strong><a href="../../../../org/joda/time/base/BaseSingleFieldPeriod.html#toPeriod()">toPeriod</a></strong>()</code>
<div class="block">Get this period as an immutable <code>Period</code> object.</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/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#toString()" title="class or interface in java.lang">toString</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>
<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#toString()">toString</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="BaseSingleFieldPeriod(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BaseSingleFieldPeriod</h4>
<pre>protected BaseSingleFieldPeriod(int period)</pre>
<div class="block">Creates a new instance representing the specified period.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>period</code> - the period to represent</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="between(org.joda.time.ReadableInstant, org.joda.time.ReadableInstant, org.joda.time.DurationFieldType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>between</h4>
<pre>protected static int between(<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,
<a href="../../../../org/joda/time/DurationFieldType.html" title="class in org.joda.time">DurationFieldType</a> field)</pre>
<div class="block">Calculates the number of whole units between the two specified datetimes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>start</code> - the start instant, validated to not be null</dd><dd><code>end</code> - the end instant, validated to not be null</dd><dd><code>field</code> - the field type to use, must not be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>the period</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="between(org.joda.time.ReadablePartial, org.joda.time.ReadablePartial, org.joda.time.ReadablePeriod)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>between</h4>
<pre>protected static int between(<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,
<a href="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</a> zeroInstance)</pre>
<div class="block">Calculates the number of whole units 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, validated to not be null</dd><dd><code>end</code> - the end partial date, validated to not be null</dd><dd><code>zeroInstance</code> - the zero instance constant, must not be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>the period</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="standardPeriodIn(org.joda.time.ReadablePeriod, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>standardPeriodIn</h4>
<pre>protected static int standardPeriodIn(<a href="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</a> period,
long millisPerUnit)</pre>
<div class="block">Creates a new instance representing the number of complete standard length units
in the specified period.
<p>
This factory method converts all fields from the period to hours using standardised
durations for each field. Only those fields which have a precise duration in
the ISO UTC chronology can be converted.
<ul>
<li>One week consists of 7 days.
<li>One day consists of 24 hours.
<li>One hour consists of 60 minutes.
<li>One minute consists of 60 seconds.
<li>One second consists of 1000 milliseconds.
</ul>
Months and Years are imprecise and periods containing these values cannot be converted.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>period</code> - the period to get the number of hours from, must not be null</dd><dd><code>millisPerUnit</code> - the number of milliseconds in one standard unit of this period</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 period contains imprecise duration values</dd></dl>
</li>
</ul>
<a name="getValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>protected int getValue()</pre>
<div class="block">Gets the amount of this period.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the period value</dd></dl>
</li>
</ul>
<a name="setValue(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValue</h4>
<pre>protected void setValue(int value)</pre>
<div class="block">Sets the amount of this period.
To make a subclass immutable you must declare it final, or block this method.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the period value</dd></dl>
</li>
</ul>
<a name="getFieldType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFieldType</h4>
<pre>public abstract <a href="../../../../org/joda/time/DurationFieldType.html" title="class in org.joda.time">DurationFieldType</a> getFieldType()</pre>
<div class="block">Gets the single duration field type.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the duration field type, not null</dd></dl>
</li>
</ul>
<a name="getPeriodType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPeriodType</h4>
<pre>public abstract <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 matches the duration field type.</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><span class="strong">Returns:</span></dt><dd>the period type, not null</dd></dl>
</li>
</ul>
<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, which is one.</div>
<dl>
<dt><strong>Specified by:</strong></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="strong">Returns:</span></dt><dd>the number of fields supported, which is one</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.
<p>
The only index supported by this period is zero which returns the
field type of this class.</div>
<dl>
<dt><strong>Specified by:</strong></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="strong">Parameters:</span></dt><dd><code>index</code> - the index to retrieve, which must be zero</dd>
<dt><span class="strong">Returns:</span></dt><dd>the field at the specified index</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/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></dl>
</li>
</ul>
<a name="getValue(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>public int getValue(int index)</pre>
<div class="block">Gets the value at the specified index.
<p>
The only index supported by this period is zero.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/joda/time/ReadablePeriod.html#getValue(int)">getValue</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="strong">Parameters:</span></dt><dd><code>index</code> - the index to retrieve, which must be zero</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value of the field at the specified index</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/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></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 a duration field represented by this period.
<p>
If the field type specified does not match the type used by this class
then zero is returned.</div>
<dl>
<dt><strong>Specified by:</strong></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="strong">Parameters:</span></dt><dd><code>type</code> - the field type to query, null returns zero</dd>
<dt><span class="strong">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 duration field specified is supported by this period.</div>
<dl>
<dt><strong>Specified by:</strong></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="strong">Parameters:</span></dt><dd><code>type</code> - the type to check, may be null which returns false</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the field is 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.
The period will use <code>PeriodType.standard()</code>.</div>
<dl>
<dt><strong>Specified by:</strong></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="strong">Returns:</span></dt><dd>a <code>Period</code> representing the same number of days</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.
The period will use <code>PeriodType.standard()</code>.</div>
<dl>
<dt><strong>Specified by:</strong></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="strong">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/7/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, but only
those with a matching <code>PeriodType</code> can return true.</div>
<dl>
<dt><strong>Specified by:</strong></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><strong>Overrides:</strong></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/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/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">Parameters:</span></dt><dd><code>period</code> - a readable period to check against</dd>
<dt><span class="strong">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><strong>Specified by:</strong></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><strong>Overrides:</strong></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/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/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>a hash code</dd></dl>
</li>
</ul>
<a name="compareTo(org.joda.time.base.BaseSingleFieldPeriod)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>compareTo</h4>
<pre>public int compareTo(<a href="../../../../org/joda/time/base/BaseSingleFieldPeriod.html" title="class in org.joda.time.base">BaseSingleFieldPeriod</a> other)</pre>
<div class="block">Compares this period to another object of the same class.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true#compareTo(T)" title="class or interface in java.lang">compareTo</a></code> in interface <code><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>></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>other</code> - the other period, must not be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>zero if equal, positive if greater, negative if less</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the other period is null</dd>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang">ClassCastException</a></code> - if the other period is of a different type</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/BaseSingleFieldPeriod.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/BasePeriod.html" title="class in org.joda.time.base"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/joda/time/base/BaseSingleFieldPeriod.html" target="_top">Frames</a></li>
<li><a href="BaseSingleFieldPeriod.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–2014 <a href="http://www.joda.org">Joda.org</a>. All rights reserved.</small></p>
</body>
</html>
|