/usr/share/doc/libjoda-time-java/api/org/joda/time/Instant.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 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 | <!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>Instant (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="Instant (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/Instant.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/IllegalInstantException.html" title="class in org.joda.time"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/joda/time/Interval.html" title="class in org.joda.time"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/joda/time/Instant.html" target="_top">Frames</a></li>
<li><a href="Instant.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</div>
<h2 title="Class Instant" class="title">Class Instant</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../org/joda/time/base/AbstractInstant.html" title="class in org.joda.time.base">org.joda.time.base.AbstractInstant</a></li>
<li>
<ul class="inheritance">
<li>org.joda.time.Instant</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</a>>, <a href="../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</a></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="strong">Instant</span>
extends <a href="../../../org/joda/time/base/AbstractInstant.html" title="class in org.joda.time.base">AbstractInstant</a>
implements <a href="../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</a>, java.io.Serializable</pre>
<div class="block">Instant is the standard implementation of a fully immutable instant in time.
<p>
<code>Instant</code> is an implementation of <a href="../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time"><code>ReadableInstant</code></a>.
As with all instants, it represents an exact point on the time-line,
but limited to the precision of milliseconds. An <code>Instant</code>
should be used to represent a point in time irrespective of any other
factor, such as chronology or time zone.
<p>
Internally, the class holds one piece of data, the instant as milliseconds
from the Java epoch of 1970-01-01T00:00:00Z.
<p>
For example, an Instant can be used to compare two <code>DateTime</code>
objects irrespective of chronology or time zone.
<pre>
boolean sameInstant = dt1.toInstant().equals(dt2.toInstant());
</pre>
Note that the following code will also perform the same check:
<pre>
boolean sameInstant = dt1.isEqual(dt2);
</pre>
<p>
Instant 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="../../../serialized-form.html#org.joda.time.Instant">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="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/joda/time/Instant.html#Instant()">Instant</a></strong>()</code>
<div class="block">Constructs an instance set to the current system millisecond time.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/joda/time/Instant.html#Instant(long)">Instant</a></strong>(long instant)</code>
<div class="block">Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/joda/time/Instant.html#Instant(java.lang.Object)">Instant</a></strong>(java.lang.Object instant)</code>
<div class="block">Constructs an instance from an Object that represents a datetime.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/joda/time/Chronology.html" title="class in org.joda.time">Chronology</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Instant.html#getChronology()">getChronology</a></strong>()</code>
<div class="block">Gets the chronology of the instant, which is ISO in the UTC zone.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Instant.html#getMillis()">getMillis</a></strong>()</code>
<div class="block">Gets the milliseconds of the instant.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/joda/time/Instant.html" title="class in org.joda.time">Instant</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Instant.html#minus(long)">minus</a></strong>(long duration)</code>
<div class="block">Gets a copy of this instant with the specified duration taken away.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/joda/time/Instant.html" title="class in org.joda.time">Instant</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Instant.html#minus(org.joda.time.ReadableDuration)">minus</a></strong>(<a href="../../../org/joda/time/ReadableDuration.html" title="interface in org.joda.time">ReadableDuration</a> duration)</code>
<div class="block">Gets a copy of this instant with the specified duration taken away.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/joda/time/Instant.html" title="class in org.joda.time">Instant</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Instant.html#now()">now</a></strong>()</code>
<div class="block">Obtains an <code>Instant</code> set to the current system millisecond time.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/joda/time/Instant.html" title="class in org.joda.time">Instant</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Instant.html#parse(java.lang.String)">parse</a></strong>(java.lang.String str)</code>
<div class="block">Parses a <code>Instant</code> from the specified string.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/joda/time/Instant.html" title="class in org.joda.time">Instant</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Instant.html#parse(java.lang.String, org.joda.time.format.DateTimeFormatter)">parse</a></strong>(java.lang.String str,
<a href="../../../org/joda/time/format/DateTimeFormatter.html" title="class in org.joda.time.format">DateTimeFormatter</a> formatter)</code>
<div class="block">Parses a <code>Instant</code> from the specified string using a formatter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/joda/time/Instant.html" title="class in org.joda.time">Instant</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Instant.html#plus(long)">plus</a></strong>(long duration)</code>
<div class="block">Gets a copy of this instant with the specified duration added.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/joda/time/Instant.html" title="class in org.joda.time">Instant</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Instant.html#plus(org.joda.time.ReadableDuration)">plus</a></strong>(<a href="../../../org/joda/time/ReadableDuration.html" title="interface in org.joda.time">ReadableDuration</a> duration)</code>
<div class="block">Gets a copy of this instant with the specified duration added.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/joda/time/DateTime.html" title="class in org.joda.time">DateTime</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Instant.html#toDateTime()">toDateTime</a></strong>()</code>
<div class="block">Get this object as a DateTime using ISOChronology in the default zone.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/joda/time/DateTime.html" title="class in org.joda.time">DateTime</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Instant.html#toDateTimeISO()">toDateTimeISO</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>
<div class="block"><i>Use toDateTime() as it is identical</i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/joda/time/Instant.html" title="class in org.joda.time">Instant</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Instant.html#toInstant()">toInstant</a></strong>()</code>
<div class="block">Get this object as an Instant by returning <code>this</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/joda/time/MutableDateTime.html" title="class in org.joda.time">MutableDateTime</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Instant.html#toMutableDateTime()">toMutableDateTime</a></strong>()</code>
<div class="block">Get this object as a MutableDateTime using ISOChronology in the default zone.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/joda/time/MutableDateTime.html" title="class in org.joda.time">MutableDateTime</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Instant.html#toMutableDateTimeISO()">toMutableDateTimeISO</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>
<div class="block"><i>Use toMutableDateTime() as it is identical</i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/joda/time/Instant.html" title="class in org.joda.time">Instant</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Instant.html#withDurationAdded(long, int)">withDurationAdded</a></strong>(long durationToAdd,
int scalar)</code>
<div class="block">Gets a copy of this instant with the specified duration added.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/joda/time/Instant.html" title="class in org.joda.time">Instant</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Instant.html#withDurationAdded(org.joda.time.ReadableDuration, int)">withDurationAdded</a></strong>(<a href="../../../org/joda/time/ReadableDuration.html" title="interface in org.joda.time">ReadableDuration</a> durationToAdd,
int scalar)</code>
<div class="block">Gets a copy of this instant with the specified duration added.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/joda/time/Instant.html" title="class in org.joda.time">Instant</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/Instant.html#withMillis(long)">withMillis</a></strong>(long newMillis)</code>
<div class="block">Gets a copy of this instant with different millis.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.joda.time.base.AbstractInstant">
<!-- -->
</a>
<h3>Methods inherited from class org.joda.time.base.<a href="../../../org/joda/time/base/AbstractInstant.html" title="class in org.joda.time.base">AbstractInstant</a></h3>
<code><a href="../../../org/joda/time/base/AbstractInstant.html#compareTo(org.joda.time.ReadableInstant)">compareTo</a>, <a href="../../../org/joda/time/base/AbstractInstant.html#equals(java.lang.Object)">equals</a>, <a href="../../../org/joda/time/base/AbstractInstant.html#get(org.joda.time.DateTimeField)">get</a>, <a href="../../../org/joda/time/base/AbstractInstant.html#get(org.joda.time.DateTimeFieldType)">get</a>, <a href="../../../org/joda/time/base/AbstractInstant.html#getZone()">getZone</a>, <a href="../../../org/joda/time/base/AbstractInstant.html#hashCode()">hashCode</a>, <a href="../../../org/joda/time/base/AbstractInstant.html#isAfter(long)">isAfter</a>, <a href="../../../org/joda/time/base/AbstractInstant.html#isAfter(org.joda.time.ReadableInstant)">isAfter</a>, <a href="../../../org/joda/time/base/AbstractInstant.html#isAfterNow()">isAfterNow</a>, <a href="../../../org/joda/time/base/AbstractInstant.html#isBefore(long)">isBefore</a>, <a href="../../../org/joda/time/base/AbstractInstant.html#isBefore(org.joda.time.ReadableInstant)">isBefore</a>, <a href="../../../org/joda/time/base/AbstractInstant.html#isBeforeNow()">isBeforeNow</a>, <a href="../../../org/joda/time/base/AbstractInstant.html#isEqual(long)">isEqual</a>, <a href="../../../org/joda/time/base/AbstractInstant.html#isEqual(org.joda.time.ReadableInstant)">isEqual</a>, <a href="../../../org/joda/time/base/AbstractInstant.html#isEqualNow()">isEqualNow</a>, <a href="../../../org/joda/time/base/AbstractInstant.html#isSupported(org.joda.time.DateTimeFieldType)">isSupported</a>, <a href="../../../org/joda/time/base/AbstractInstant.html#toDate()">toDate</a>, <a href="../../../org/joda/time/base/AbstractInstant.html#toDateTime(org.joda.time.Chronology)">toDateTime</a>, <a href="../../../org/joda/time/base/AbstractInstant.html#toDateTime(org.joda.time.DateTimeZone)">toDateTime</a>, <a href="../../../org/joda/time/base/AbstractInstant.html#toMutableDateTime(org.joda.time.Chronology)">toMutableDateTime</a>, <a href="../../../org/joda/time/base/AbstractInstant.html#toMutableDateTime(org.joda.time.DateTimeZone)">toMutableDateTime</a>, <a href="../../../org/joda/time/base/AbstractInstant.html#toString()">toString</a>, <a href="../../../org/joda/time/base/AbstractInstant.html#toString(org.joda.time.format.DateTimeFormatter)">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, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.joda.time.ReadableInstant">
<!-- -->
</a>
<h3>Methods inherited from interface org.joda.time.<a href="../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</a></h3>
<code><a href="../../../org/joda/time/ReadableInstant.html#equals(java.lang.Object)">equals</a>, <a href="../../../org/joda/time/ReadableInstant.html#get(org.joda.time.DateTimeFieldType)">get</a>, <a href="../../../org/joda/time/ReadableInstant.html#getZone()">getZone</a>, <a href="../../../org/joda/time/ReadableInstant.html#hashCode()">hashCode</a>, <a href="../../../org/joda/time/ReadableInstant.html#isAfter(org.joda.time.ReadableInstant)">isAfter</a>, <a href="../../../org/joda/time/ReadableInstant.html#isBefore(org.joda.time.ReadableInstant)">isBefore</a>, <a href="../../../org/joda/time/ReadableInstant.html#isEqual(org.joda.time.ReadableInstant)">isEqual</a>, <a href="../../../org/joda/time/ReadableInstant.html#isSupported(org.joda.time.DateTimeFieldType)">isSupported</a>, <a href="../../../org/joda/time/ReadableInstant.html#toString()">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Comparable">
<!-- -->
</a>
<h3>Methods inherited from interface java.lang.Comparable</h3>
<code>compareTo</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="Instant()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Instant</h4>
<pre>public Instant()</pre>
<div class="block">Constructs an instance set to the current system millisecond time.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/joda/time/Instant.html#now()"><code>now()</code></a></dd></dl>
</li>
</ul>
<a name="Instant(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Instant</h4>
<pre>public Instant(long instant)</pre>
<div class="block">Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>instant</code> - the milliseconds from 1970-01-01T00:00:00Z</dd></dl>
</li>
</ul>
<a name="Instant(java.lang.Object)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Instant</h4>
<pre>public Instant(java.lang.Object instant)</pre>
<div class="block">Constructs an instance from an Object that represents a datetime.
<p>
The recognised object types are defined in <a href="../../../org/joda/time/convert/ConverterManager.html" title="class in org.joda.time.convert"><code>ConverterManager</code></a> and
include String, Calendar and Date.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>instant</code> - the datetime object, null means now</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the instant is invalid</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="now()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>now</h4>
<pre>public static <a href="../../../org/joda/time/Instant.html" title="class in org.joda.time">Instant</a> now()</pre>
<div class="block">Obtains an <code>Instant</code> set to the current system millisecond time.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the current instant, not null</dd><dt><span class="strong">Since:</span></dt>
<dd>2.0</dd></dl>
</li>
</ul>
<a name="parse(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre>public static <a href="../../../org/joda/time/Instant.html" title="class in org.joda.time">Instant</a> parse(java.lang.String str)</pre>
<div class="block">Parses a <code>Instant</code> from the specified string.
<p>
This uses <a href="../../../org/joda/time/format/ISODateTimeFormat.html#dateTimeParser()"><code>ISODateTimeFormat.dateTimeParser()</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>str</code> - the string to parse, not null</dd><dt><span class="strong">Since:</span></dt>
<dd>2.0</dd></dl>
</li>
</ul>
<a name="parse(java.lang.String, org.joda.time.format.DateTimeFormatter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre>public static <a href="../../../org/joda/time/Instant.html" title="class in org.joda.time">Instant</a> parse(java.lang.String str,
<a href="../../../org/joda/time/format/DateTimeFormatter.html" title="class in org.joda.time.format">DateTimeFormatter</a> formatter)</pre>
<div class="block">Parses a <code>Instant</code> from the specified string using a formatter.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>str</code> - the string to parse, not null</dd><dd><code>formatter</code> - the formatter to use, not null</dd><dt><span class="strong">Since:</span></dt>
<dd>2.0</dd></dl>
</li>
</ul>
<a name="toInstant()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toInstant</h4>
<pre>public <a href="../../../org/joda/time/Instant.html" title="class in org.joda.time">Instant</a> toInstant()</pre>
<div class="block">Get this object as an Instant by returning <code>this</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/joda/time/ReadableInstant.html#toInstant()">toInstant</a></code> in interface <code><a href="../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../org/joda/time/base/AbstractInstant.html#toInstant()">toInstant</a></code> in class <code><a href="../../../org/joda/time/base/AbstractInstant.html" title="class in org.joda.time.base">AbstractInstant</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd><code>this</code></dd></dl>
</li>
</ul>
<a name="withMillis(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withMillis</h4>
<pre>public <a href="../../../org/joda/time/Instant.html" title="class in org.joda.time">Instant</a> withMillis(long newMillis)</pre>
<div class="block">Gets a copy of this instant with different millis.
<p>
The returned object will be either be a new Instant or <code>this</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newMillis</code> - the new millis, from 1970-01-01T00:00:00Z</dd>
<dt><span class="strong">Returns:</span></dt><dd>a copy of this instant with different millis</dd></dl>
</li>
</ul>
<a name="withDurationAdded(long, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withDurationAdded</h4>
<pre>public <a href="../../../org/joda/time/Instant.html" title="class in org.joda.time">Instant</a> withDurationAdded(long durationToAdd,
int scalar)</pre>
<div class="block">Gets a copy of this instant with the specified duration added.
<p>
If the addition is zero, then <code>this</code> is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>durationToAdd</code> - the duration to add to this one</dd><dd><code>scalar</code> - the amount of times to add, such as -1 to subtract once</dd>
<dt><span class="strong">Returns:</span></dt><dd>a copy of this instant with the duration added</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ArithmeticException</code> - if the new instant exceeds the capacity of a long</dd></dl>
</li>
</ul>
<a name="withDurationAdded(org.joda.time.ReadableDuration, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withDurationAdded</h4>
<pre>public <a href="../../../org/joda/time/Instant.html" title="class in org.joda.time">Instant</a> withDurationAdded(<a href="../../../org/joda/time/ReadableDuration.html" title="interface in org.joda.time">ReadableDuration</a> durationToAdd,
int scalar)</pre>
<div class="block">Gets a copy of this instant with the specified duration added.
<p>
If the addition is zero, then <code>this</code> is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>durationToAdd</code> - the duration to add to this one, null means zero</dd><dd><code>scalar</code> - the amount of times to add, such as -1 to subtract once</dd>
<dt><span class="strong">Returns:</span></dt><dd>a copy of this instant with the duration added</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ArithmeticException</code> - if the new instant exceeds the capacity of a long</dd></dl>
</li>
</ul>
<a name="plus(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>plus</h4>
<pre>public <a href="../../../org/joda/time/Instant.html" title="class in org.joda.time">Instant</a> plus(long duration)</pre>
<div class="block">Gets a copy of this instant with the specified duration added.
<p>
If the amount is zero or null, then <code>this</code> is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>duration</code> - the duration to add to this one</dd>
<dt><span class="strong">Returns:</span></dt><dd>a copy of this instant with the duration added</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ArithmeticException</code> - if the new instant exceeds the capacity of a long</dd></dl>
</li>
</ul>
<a name="plus(org.joda.time.ReadableDuration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>plus</h4>
<pre>public <a href="../../../org/joda/time/Instant.html" title="class in org.joda.time">Instant</a> plus(<a href="../../../org/joda/time/ReadableDuration.html" title="interface in org.joda.time">ReadableDuration</a> duration)</pre>
<div class="block">Gets a copy of this instant with the specified duration added.
<p>
If the amount is zero or null, then <code>this</code> is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>duration</code> - the duration to add to this one, null means zero</dd>
<dt><span class="strong">Returns:</span></dt><dd>a copy of this instant with the duration added</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ArithmeticException</code> - if the new instant exceeds the capacity of a long</dd></dl>
</li>
</ul>
<a name="minus(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>minus</h4>
<pre>public <a href="../../../org/joda/time/Instant.html" title="class in org.joda.time">Instant</a> minus(long duration)</pre>
<div class="block">Gets a copy of this instant with the specified duration taken away.
<p>
If the amount is zero or null, then <code>this</code> is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>duration</code> - the duration to reduce this instant by</dd>
<dt><span class="strong">Returns:</span></dt><dd>a copy of this instant with the duration taken away</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ArithmeticException</code> - if the new instant exceeds the capacity of a long</dd></dl>
</li>
</ul>
<a name="minus(org.joda.time.ReadableDuration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>minus</h4>
<pre>public <a href="../../../org/joda/time/Instant.html" title="class in org.joda.time">Instant</a> minus(<a href="../../../org/joda/time/ReadableDuration.html" title="interface in org.joda.time">ReadableDuration</a> duration)</pre>
<div class="block">Gets a copy of this instant with the specified duration taken away.
<p>
If the amount is zero or null, then <code>this</code> is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>duration</code> - the duration to reduce this instant by</dd>
<dt><span class="strong">Returns:</span></dt><dd>a copy of this instant with the duration taken away</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ArithmeticException</code> - if the new instant exceeds the capacity of a long</dd></dl>
</li>
</ul>
<a name="getMillis()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMillis</h4>
<pre>public long getMillis()</pre>
<div class="block">Gets the milliseconds of the instant.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/joda/time/ReadableInstant.html#getMillis()">getMillis</a></code> in interface <code><a href="../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the number of milliseconds since 1970-01-01T00:00:00Z</dd></dl>
</li>
</ul>
<a name="getChronology()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChronology</h4>
<pre>public <a href="../../../org/joda/time/Chronology.html" title="class in org.joda.time">Chronology</a> getChronology()</pre>
<div class="block">Gets the chronology of the instant, which is ISO in the UTC zone.
<p>
This method returns <a href="../../../org/joda/time/chrono/ISOChronology.html#getInstanceUTC()"><code>ISOChronology.getInstanceUTC()</code></a> which
corresponds to the definition of the Java epoch 1970-01-01T00:00:00Z.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/joda/time/ReadableInstant.html#getChronology()">getChronology</a></code> in interface <code><a href="../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>ISO in the UTC zone</dd></dl>
</li>
</ul>
<a name="toDateTime()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toDateTime</h4>
<pre>public <a href="../../../org/joda/time/DateTime.html" title="class in org.joda.time">DateTime</a> toDateTime()</pre>
<div class="block">Get this object as a DateTime using ISOChronology in the default zone.
<p>
This method returns a DateTime object in the default zone.
This differs from the similarly named method on DateTime, DateMidnight
or MutableDateTime which retains the time zone. The difference is
because Instant really represents a time <i>without</i> a zone,
thus calling this method we really have no zone to 'retain' and
hence expect to switch to the default zone.
<p>
This method definition preserves compatibility with earlier versions
of Joda-Time.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../org/joda/time/base/AbstractInstant.html#toDateTime()">toDateTime</a></code> in class <code><a href="../../../org/joda/time/base/AbstractInstant.html" title="class in org.joda.time.base">AbstractInstant</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a DateTime using the same millis</dd></dl>
</li>
</ul>
<a name="toDateTimeISO()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toDateTimeISO</h4>
<pre>@Deprecated
public <a href="../../../org/joda/time/DateTime.html" title="class in org.joda.time">DateTime</a> toDateTimeISO()</pre>
<div class="block"><span class="strong">Deprecated.</span> <i>Use toDateTime() as it is identical</i></div>
<div class="block">Get this object as a DateTime using ISOChronology in the default zone.
This method is identical to <code>toDateTime()</code>.
<p>
This method returns a DateTime object in the default zone.
This differs from the similarly named method on DateTime, DateMidnight
or MutableDateTime which retains the time zone. The difference is
because Instant really represents a time <i>without</i> a zone,
thus calling this method we really have no zone to 'retain' and
hence expect to switch to the default zone.
<p>
This method is deprecated because it is a duplicate of <a href="../../../org/joda/time/Instant.html#toDateTime()"><code>toDateTime()</code></a>.
However, removing it would cause the superclass implementation to be used,
which would create silent bugs in any caller depending on this implementation.
As such, the method itself is not currently planned to be removed.
<p>
This method definition preserves compatibility with earlier versions
of Joda-Time.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../org/joda/time/base/AbstractInstant.html#toDateTimeISO()">toDateTimeISO</a></code> in class <code><a href="../../../org/joda/time/base/AbstractInstant.html" title="class in org.joda.time.base">AbstractInstant</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a DateTime using the same millis with ISOChronology</dd></dl>
</li>
</ul>
<a name="toMutableDateTime()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toMutableDateTime</h4>
<pre>public <a href="../../../org/joda/time/MutableDateTime.html" title="class in org.joda.time">MutableDateTime</a> toMutableDateTime()</pre>
<div class="block">Get this object as a MutableDateTime using ISOChronology in the default zone.
<p>
This method returns a MutableDateTime object in the default zone.
This differs from the similarly named method on DateTime, DateMidnight
or MutableDateTime which retains the time zone. The difference is
because Instant really represents a time <i>without</i> a zone,
thus calling this method we really have no zone to 'retain' and
hence expect to switch to the default zone.
<p>
This method definition preserves compatibility with earlier versions
of Joda-Time.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../org/joda/time/base/AbstractInstant.html#toMutableDateTime()">toMutableDateTime</a></code> in class <code><a href="../../../org/joda/time/base/AbstractInstant.html" title="class in org.joda.time.base">AbstractInstant</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a MutableDateTime using the same millis</dd></dl>
</li>
</ul>
<a name="toMutableDateTimeISO()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toMutableDateTimeISO</h4>
<pre>@Deprecated
public <a href="../../../org/joda/time/MutableDateTime.html" title="class in org.joda.time">MutableDateTime</a> toMutableDateTimeISO()</pre>
<div class="block"><span class="strong">Deprecated.</span> <i>Use toMutableDateTime() as it is identical</i></div>
<div class="block">Get this object as a MutableDateTime using ISOChronology in the default zone.
This method is identical to <code>toMutableDateTime()</code>.
<p>
This method returns a MutableDateTime object in the default zone.
This differs from the similarly named method on DateTime, DateMidnight
or MutableDateTime which retains the time zone. The difference is
because Instant really represents a time <i>without</i> a zone,
thus calling this method we really have no zone to 'retain' and
hence expect to switch to the default zone.
<p>
This method is deprecated because it is a duplicate of <a href="../../../org/joda/time/Instant.html#toMutableDateTime()"><code>toMutableDateTime()</code></a>.
However, removing it would cause the superclass implementation to be used,
which would create silent bugs in any caller depending on this implementation.
As such, the method itself is not currently planned to be removed.
<p>
This method definition preserves compatibility with earlier versions
of Joda-Time.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../org/joda/time/base/AbstractInstant.html#toMutableDateTimeISO()">toMutableDateTimeISO</a></code> in class <code><a href="../../../org/joda/time/base/AbstractInstant.html" title="class in org.joda.time.base">AbstractInstant</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a MutableDateTime using the same millis with ISOChronology</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/Instant.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/IllegalInstantException.html" title="class in org.joda.time"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/joda/time/Interval.html" title="class in org.joda.time"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/joda/time/Instant.html" target="_top">Frames</a></li>
<li><a href="Instant.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>
|