/usr/share/doc/libjoda-time-java/api/org/joda/time/field/DividedDateTimeField.html is in libjoda-time-java-doc 2.3-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 | <!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>DividedDateTimeField (Joda-Time 2.3 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="DividedDateTimeField (Joda-Time 2.3 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/DividedDateTimeField.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/field/DelegatedDurationField.html" title="class in org.joda.time.field"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/joda/time/field/FieldUtils.html" title="class in org.joda.time.field"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/joda/time/field/DividedDateTimeField.html" target="_top">Frames</a></li>
<li><a href="DividedDateTimeField.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.field</div>
<h2 title="Class DividedDateTimeField" class="title">Class DividedDateTimeField</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/joda/time/DateTimeField.html" title="class in org.joda.time">org.joda.time.DateTimeField</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/joda/time/field/BaseDateTimeField.html" title="class in org.joda.time.field">org.joda.time.field.BaseDateTimeField</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/joda/time/field/DecoratedDateTimeField.html" title="class in org.joda.time.field">org.joda.time.field.DecoratedDateTimeField</a></li>
<li>
<ul class="inheritance">
<li>org.joda.time.field.DividedDateTimeField</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">DividedDateTimeField</span>
extends <a href="../../../../org/joda/time/field/DecoratedDateTimeField.html" title="class in org.joda.time.field">DecoratedDateTimeField</a></pre>
<div class="block">Divides a DateTimeField such that the retrieved values are reduced by a
fixed divisor. The field's unit duration is scaled accordingly, but the
range duration is unchanged.
<p>
DividedDateTimeField is thread-safe and immutable.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.0</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/joda/time/field/RemainderDateTimeField.html" title="class in org.joda.time.field"><code>RemainderDateTimeField</code></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="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/joda/time/field/DividedDateTimeField.html#DividedDateTimeField(org.joda.time.DateTimeField, org.joda.time.DateTimeFieldType, int)">DividedDateTimeField</a></strong>(<a href="../../../../org/joda/time/DateTimeField.html" title="class in org.joda.time">DateTimeField</a> field,
<a href="../../../../org/joda/time/DateTimeFieldType.html" title="class in org.joda.time">DateTimeFieldType</a> type,
int divisor)</code>
<div class="block">Constructor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/joda/time/field/DividedDateTimeField.html#DividedDateTimeField(org.joda.time.field.RemainderDateTimeField, org.joda.time.DateTimeFieldType)">DividedDateTimeField</a></strong>(<a href="../../../../org/joda/time/field/RemainderDateTimeField.html" title="class in org.joda.time.field">RemainderDateTimeField</a> remainderField,
<a href="../../../../org/joda/time/DateTimeFieldType.html" title="class in org.joda.time">DateTimeFieldType</a> type)</code>
<div class="block">Construct a DividedDateTimeField that compliments the given
RemainderDateTimeField.</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>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/field/DividedDateTimeField.html#add(long, int)">add</a></strong>(long instant,
int amount)</code>
<div class="block">Add the specified amount of scaled units to the specified time
instant.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/field/DividedDateTimeField.html#add(long, long)">add</a></strong>(long instant,
long amount)</code>
<div class="block">Add the specified amount of scaled units to the specified time
instant.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/field/DividedDateTimeField.html#addWrapField(long, int)">addWrapField</a></strong>(long instant,
int amount)</code>
<div class="block">Add to the scaled component of the specified time instant,
wrapping around within that component if necessary.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/field/DividedDateTimeField.html#get(long)">get</a></strong>(long instant)</code>
<div class="block">Get the amount of scaled units from the specified time instant.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/field/DividedDateTimeField.html#getDifference(long, long)">getDifference</a></strong>(long minuendInstant,
long subtrahendInstant)</code>
<div class="block">Computes the difference between two instants, as measured in the units
of this field.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/field/DividedDateTimeField.html#getDifferenceAsLong(long, long)">getDifferenceAsLong</a></strong>(long minuendInstant,
long subtrahendInstant)</code>
<div class="block">Computes the difference between two instants, as measured in the units
of this field.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/field/DividedDateTimeField.html#getDivisor()">getDivisor</a></strong>()</code>
<div class="block">Returns the divisor applied, in the field's units.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/joda/time/DurationField.html" title="class in org.joda.time">DurationField</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/field/DividedDateTimeField.html#getDurationField()">getDurationField</a></strong>()</code>
<div class="block">Returns a scaled version of the wrapped field's unit duration field.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/field/DividedDateTimeField.html#getMaximumValue()">getMaximumValue</a></strong>()</code>
<div class="block">Get the maximum value for the field.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/field/DividedDateTimeField.html#getMinimumValue()">getMinimumValue</a></strong>()</code>
<div class="block">Get the minimum value for the field.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/field/DividedDateTimeField.html#remainder(long)">remainder</a></strong>(long instant)</code>
<div class="block">Returns the fractional duration milliseconds of this field.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/field/DividedDateTimeField.html#roundFloor(long)">roundFloor</a></strong>(long instant)</code>
<div class="block">Round to the lowest whole unit of this field.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/joda/time/field/DividedDateTimeField.html#set(long, int)">set</a></strong>(long instant,
int value)</code>
<div class="block">Set the specified amount of scaled units to the specified time instant.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.joda.time.field.DecoratedDateTimeField">
<!-- -->
</a>
<h3>Methods inherited from class org.joda.time.field.<a href="../../../../org/joda/time/field/DecoratedDateTimeField.html" title="class in org.joda.time.field">DecoratedDateTimeField</a></h3>
<code><a href="../../../../org/joda/time/field/DecoratedDateTimeField.html#getRangeDurationField()">getRangeDurationField</a>, <a href="../../../../org/joda/time/field/DecoratedDateTimeField.html#getWrappedField()">getWrappedField</a>, <a href="../../../../org/joda/time/field/DecoratedDateTimeField.html#isLenient()">isLenient</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.joda.time.field.BaseDateTimeField">
<!-- -->
</a>
<h3>Methods inherited from class org.joda.time.field.<a href="../../../../org/joda/time/field/BaseDateTimeField.html" title="class in org.joda.time.field">BaseDateTimeField</a></h3>
<code><a href="../../../../org/joda/time/field/BaseDateTimeField.html#add(org.joda.time.ReadablePartial, int, int[], int)">add</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#addWrapField(org.joda.time.ReadablePartial, int, int[], int)">addWrapField</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#addWrapPartial(org.joda.time.ReadablePartial, int, int[], int)">addWrapPartial</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#convertText(java.lang.String, java.util.Locale)">convertText</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#getAsShortText(int, java.util.Locale)">getAsShortText</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#getAsShortText(long)">getAsShortText</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#getAsShortText(long, java.util.Locale)">getAsShortText</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#getAsShortText(org.joda.time.ReadablePartial, int, java.util.Locale)">getAsShortText</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#getAsShortText(org.joda.time.ReadablePartial, java.util.Locale)">getAsShortText</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#getAsText(int, java.util.Locale)">getAsText</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#getAsText(long)">getAsText</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#getAsText(long, java.util.Locale)">getAsText</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#getAsText(org.joda.time.ReadablePartial, int, java.util.Locale)">getAsText</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#getAsText(org.joda.time.ReadablePartial, java.util.Locale)">getAsText</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#getLeapAmount(long)">getLeapAmount</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#getLeapDurationField()">getLeapDurationField</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#getMaximumShortTextLength(java.util.Locale)">getMaximumShortTextLength</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#getMaximumTextLength(java.util.Locale)">getMaximumTextLength</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#getMaximumValue(long)">getMaximumValue</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#getMaximumValue(org.joda.time.ReadablePartial)">getMaximumValue</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#getMaximumValue(org.joda.time.ReadablePartial, int[])">getMaximumValue</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#getMinimumValue(long)">getMinimumValue</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#getMinimumValue(org.joda.time.ReadablePartial)">getMinimumValue</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#getMinimumValue(org.joda.time.ReadablePartial, int[])">getMinimumValue</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#getName()">getName</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#getType()">getType</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#isLeap(long)">isLeap</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#isSupported()">isSupported</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#roundCeiling(long)">roundCeiling</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#roundHalfCeiling(long)">roundHalfCeiling</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#roundHalfEven(long)">roundHalfEven</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#roundHalfFloor(long)">roundHalfFloor</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#set(long, java.lang.String)">set</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#set(long, java.lang.String, java.util.Locale)">set</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#set(org.joda.time.ReadablePartial, int, int[], int)">set</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#set(org.joda.time.ReadablePartial, int, int[], java.lang.String, java.util.Locale)">set</a>, <a href="../../../../org/joda/time/field/BaseDateTimeField.html#toString()">toString</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.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="DividedDateTimeField(org.joda.time.DateTimeField, org.joda.time.DateTimeFieldType, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DividedDateTimeField</h4>
<pre>public DividedDateTimeField(<a href="../../../../org/joda/time/DateTimeField.html" title="class in org.joda.time">DateTimeField</a> field,
<a href="../../../../org/joda/time/DateTimeFieldType.html" title="class in org.joda.time">DateTimeFieldType</a> type,
int divisor)</pre>
<div class="block">Constructor.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>field</code> - the field to wrap, like "year()".</dd><dd><code>type</code> - the field type this field will actually use</dd><dd><code>divisor</code> - divisor, such as 100 years in a century</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if divisor is less than two</dd></dl>
</li>
</ul>
<a name="DividedDateTimeField(org.joda.time.field.RemainderDateTimeField, org.joda.time.DateTimeFieldType)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DividedDateTimeField</h4>
<pre>public DividedDateTimeField(<a href="../../../../org/joda/time/field/RemainderDateTimeField.html" title="class in org.joda.time.field">RemainderDateTimeField</a> remainderField,
<a href="../../../../org/joda/time/DateTimeFieldType.html" title="class in org.joda.time">DateTimeFieldType</a> type)</pre>
<div class="block">Construct a DividedDateTimeField that compliments the given
RemainderDateTimeField.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>remainderField</code> - complimentary remainder field, like "yearOfCentury()".</dd><dd><code>type</code> - the field type this field will actually use</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="get(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public int get(long instant)</pre>
<div class="block">Get the amount of scaled units from the specified time instant.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/joda/time/field/DecoratedDateTimeField.html#get(long)">get</a></code> in class <code><a href="../../../../org/joda/time/field/DecoratedDateTimeField.html" title="class in org.joda.time.field">DecoratedDateTimeField</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>instant</code> - the time instant in millis to query.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the amount of scaled units extracted from the input.</dd></dl>
</li>
</ul>
<a name="add(long, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public long add(long instant,
int amount)</pre>
<div class="block">Add the specified amount of scaled units to the specified time
instant. The amount added may be negative.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/joda/time/field/BaseDateTimeField.html#add(long, int)">add</a></code> in class <code><a href="../../../../org/joda/time/field/BaseDateTimeField.html" title="class in org.joda.time.field">BaseDateTimeField</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>instant</code> - the time instant in millis to update.</dd><dd><code>amount</code> - the amount of scaled units to add (can be negative).</dd>
<dt><span class="strong">Returns:</span></dt><dd>the updated time instant.</dd></dl>
</li>
</ul>
<a name="add(long, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public long add(long instant,
long amount)</pre>
<div class="block">Add the specified amount of scaled units to the specified time
instant. The amount added may be negative.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/joda/time/field/BaseDateTimeField.html#add(long, long)">add</a></code> in class <code><a href="../../../../org/joda/time/field/BaseDateTimeField.html" title="class in org.joda.time.field">BaseDateTimeField</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>instant</code> - the time instant in millis to update.</dd><dd><code>amount</code> - the amount of scaled units to add (can be negative).</dd>
<dt><span class="strong">Returns:</span></dt><dd>the updated time instant.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/joda/time/field/BaseDateTimeField.html#add(long, int)"><code>BaseDateTimeField.add(long,int)</code></a></dd></dl>
</li>
</ul>
<a name="addWrapField(long, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addWrapField</h4>
<pre>public long addWrapField(long instant,
int amount)</pre>
<div class="block">Add to the scaled component of the specified time instant,
wrapping around within that component if necessary.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/joda/time/field/BaseDateTimeField.html#addWrapField(long, int)">addWrapField</a></code> in class <code><a href="../../../../org/joda/time/field/BaseDateTimeField.html" title="class in org.joda.time.field">BaseDateTimeField</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>instant</code> - the time instant in millis to update.</dd><dd><code>amount</code> - the amount of scaled units to add (can be negative).</dd>
<dt><span class="strong">Returns:</span></dt><dd>the updated time instant.</dd></dl>
</li>
</ul>
<a name="getDifference(long, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDifference</h4>
<pre>public int getDifference(long minuendInstant,
long subtrahendInstant)</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../../../org/joda/time/field/BaseDateTimeField.html#getDifference(long, long)">BaseDateTimeField</a></code></strong></div>
<div class="block">Computes the difference between two instants, as measured in the units
of this field. Any fractional units are dropped from the result. Calling
getDifference reverses the effect of calling add. In the following code:
<pre>
long instant = ...
int v = ...
int age = getDifference(add(instant, v), instant);
</pre>
The value 'age' is the same as the value 'v'.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/joda/time/field/BaseDateTimeField.html#getDifference(long, long)">getDifference</a></code> in class <code><a href="../../../../org/joda/time/field/BaseDateTimeField.html" title="class in org.joda.time.field">BaseDateTimeField</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>minuendInstant</code> - the milliseconds from 1970-01-01T00:00:00Z to
subtract from</dd><dd><code>subtrahendInstant</code> - the milliseconds from 1970-01-01T00:00:00Z to
subtract off the minuend</dd>
<dt><span class="strong">Returns:</span></dt><dd>the difference in the units of this field</dd></dl>
</li>
</ul>
<a name="getDifferenceAsLong(long, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDifferenceAsLong</h4>
<pre>public long getDifferenceAsLong(long minuendInstant,
long subtrahendInstant)</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../../../org/joda/time/field/BaseDateTimeField.html#getDifferenceAsLong(long, long)">BaseDateTimeField</a></code></strong></div>
<div class="block">Computes the difference between two instants, as measured in the units
of this field. Any fractional units are dropped from the result. Calling
getDifference reverses the effect of calling add. In the following code:
<pre>
long instant = ...
long v = ...
long age = getDifferenceAsLong(add(instant, v), instant);
</pre>
The value 'age' is the same as the value 'v'.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/joda/time/field/BaseDateTimeField.html#getDifferenceAsLong(long, long)">getDifferenceAsLong</a></code> in class <code><a href="../../../../org/joda/time/field/BaseDateTimeField.html" title="class in org.joda.time.field">BaseDateTimeField</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>minuendInstant</code> - the milliseconds from 1970-01-01T00:00:00Z to
subtract from</dd><dd><code>subtrahendInstant</code> - the milliseconds from 1970-01-01T00:00:00Z to
subtract off the minuend</dd>
<dt><span class="strong">Returns:</span></dt><dd>the difference in the units of this field</dd></dl>
</li>
</ul>
<a name="set(long, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>set</h4>
<pre>public long set(long instant,
int value)</pre>
<div class="block">Set the specified amount of scaled units to the specified time instant.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/joda/time/field/DecoratedDateTimeField.html#set(long, int)">set</a></code> in class <code><a href="../../../../org/joda/time/field/DecoratedDateTimeField.html" title="class in org.joda.time.field">DecoratedDateTimeField</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>instant</code> - the time instant in millis to update.</dd><dd><code>value</code> - value of scaled units to set.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the updated time instant.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if value is too large or too small.</dd></dl>
</li>
</ul>
<a name="getDurationField()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDurationField</h4>
<pre>public <a href="../../../../org/joda/time/DurationField.html" title="class in org.joda.time">DurationField</a> getDurationField()</pre>
<div class="block">Returns a scaled version of the wrapped field's unit duration field.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/joda/time/field/DecoratedDateTimeField.html#getDurationField()">getDurationField</a></code> in class <code><a href="../../../../org/joda/time/field/DecoratedDateTimeField.html" title="class in org.joda.time.field">DecoratedDateTimeField</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the duration of this field, or UnsupportedDurationField if field
has no duration</dd></dl>
</li>
</ul>
<a name="getMinimumValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMinimumValue</h4>
<pre>public int getMinimumValue()</pre>
<div class="block">Get the minimum value for the field.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/joda/time/field/DecoratedDateTimeField.html#getMinimumValue()">getMinimumValue</a></code> in class <code><a href="../../../../org/joda/time/field/DecoratedDateTimeField.html" title="class in org.joda.time.field">DecoratedDateTimeField</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the minimum value</dd></dl>
</li>
</ul>
<a name="getMaximumValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaximumValue</h4>
<pre>public int getMaximumValue()</pre>
<div class="block">Get the maximum value for the field.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/joda/time/field/DecoratedDateTimeField.html#getMaximumValue()">getMaximumValue</a></code> in class <code><a href="../../../../org/joda/time/field/DecoratedDateTimeField.html" title="class in org.joda.time.field">DecoratedDateTimeField</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the maximum value</dd></dl>
</li>
</ul>
<a name="roundFloor(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>roundFloor</h4>
<pre>public long roundFloor(long instant)</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../../../org/joda/time/field/BaseDateTimeField.html#roundFloor(long)">BaseDateTimeField</a></code></strong></div>
<div class="block">Round to the lowest whole unit of this field. After rounding, the value
of this field and all fields of a higher magnitude are retained. The
fractional millis that cannot be expressed in whole increments of this
field are set to minimum.
<p>
For example, a datetime of 2002-11-02T23:34:56.789, rounded to the
lowest whole hour is 2002-11-02T23:00:00.000.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/joda/time/field/DecoratedDateTimeField.html#roundFloor(long)">roundFloor</a></code> in class <code><a href="../../../../org/joda/time/field/DecoratedDateTimeField.html" title="class in org.joda.time.field">DecoratedDateTimeField</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>instant</code> - the milliseconds from 1970-01-01T00:00:00Z to round</dd>
<dt><span class="strong">Returns:</span></dt><dd>rounded milliseconds</dd></dl>
</li>
</ul>
<a name="remainder(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remainder</h4>
<pre>public long remainder(long instant)</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../../../org/joda/time/field/BaseDateTimeField.html#remainder(long)">BaseDateTimeField</a></code></strong></div>
<div class="block">Returns the fractional duration milliseconds of this field. In other
words, calling remainder returns the duration that roundFloor would
subtract.
<p>
For example, on a datetime of 2002-11-02T23:34:56.789, the remainder by
hour is 34 minutes and 56.789 seconds.
<p>
The default implementation computes
<code>instant - roundFloor(instant)</code>. Subclasses are encouraged to
provide a more efficient implementation.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/joda/time/field/BaseDateTimeField.html#remainder(long)">remainder</a></code> in class <code><a href="../../../../org/joda/time/field/BaseDateTimeField.html" title="class in org.joda.time.field">BaseDateTimeField</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>instant</code> - the milliseconds from 1970-01-01T00:00:00Z to get the
remainder</dd>
<dt><span class="strong">Returns:</span></dt><dd>remainder duration, in milliseconds</dd></dl>
</li>
</ul>
<a name="getDivisor()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDivisor</h4>
<pre>public int getDivisor()</pre>
<div class="block">Returns the divisor applied, in the field's units.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the divisor</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/DividedDateTimeField.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/field/DelegatedDurationField.html" title="class in org.joda.time.field"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/joda/time/field/FieldUtils.html" title="class in org.joda.time.field"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/joda/time/field/DividedDateTimeField.html" target="_top">Frames</a></li>
<li><a href="DividedDateTimeField.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-2013 <a href="http://www.joda.org">Joda.org</a>. All Rights Reserved.</small></p>
</body>
</html>
|