/usr/share/doc/libjoda-time-java/api/org/joda/time/ReadableInterval.html is in libjoda-time-java-doc 2.1-2.
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 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_24) on Mon Apr 09 15:49:13 UTC 2012 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
ReadableInterval (Joda time 2.1 API)
</TITLE>
<META NAME="date" CONTENT="2012-04-09">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ReadableInterval (Joda time 2.1 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ReadableInterval.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time"><B>PREV CLASS</B></A>
<A HREF="../../../org/joda/time/ReadablePartial.html" title="interface in org.joda.time"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?org/joda/time/ReadableInterval.html" target="_top"><B>FRAMES</B></A>
<A HREF="ReadableInterval.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.joda.time</FONT>
<BR>
Interface ReadableInterval</H2>
<DL>
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../org/joda/time/ReadWritableInterval.html" title="interface in org.joda.time">ReadWritableInterval</A></DD>
</DL>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/joda/time/base/AbstractInterval.html" title="class in org.joda.time.base">AbstractInterval</A>, <A HREF="../../../org/joda/time/base/BaseInterval.html" title="class in org.joda.time.base">BaseInterval</A>, <A HREF="../../../org/joda/time/Interval.html" title="class in org.joda.time">Interval</A>, <A HREF="../../../org/joda/time/MutableInterval.html" title="class in org.joda.time">MutableInterval</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>ReadableInterval</B></DL>
</PRE>
<P>
Readable interface for an interval of time between two instants.
<p>
A time interval represents a period of time between two instants.
Intervals are inclusive of the start instant and exclusive of the end.
The end instant is always greater than or equal to the start instant.
<p>
Intervals have a fixed millisecond duration.
This is the difference between the start and end instants.
The duration is represented separately by <A HREF="../../../org/joda/time/ReadableDuration.html" title="interface in org.joda.time"><CODE>ReadableDuration</CODE></A>.
As a result, intervals are not comparable.
To compare the length of two intervals, you should compare their durations.
<p>
An interval can also be converted to a <A HREF="../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time"><CODE>ReadablePeriod</CODE></A>.
This represents the difference between the start and end points in terms of fields
such as years and days.
<p>
Methods that are passed an interval as a parameter will treat <code>null</code>
as a zero length interval at the current instant in time.
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>1.0</DD>
<DT><B>Author:</B></DT>
<DD>Sean Geoghegan, Brian S O'Neill, Stephen Colebourne</DD>
</DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/joda/time/ReadableInterval.html#contains(org.joda.time.ReadableInstant)">contains</A></B>(<A HREF="../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</A> instant)</CODE>
<BR>
Does this time interval contain the specified instant.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/joda/time/ReadableInterval.html#contains(org.joda.time.ReadableInterval)">contains</A></B>(<A HREF="../../../org/joda/time/ReadableInterval.html" title="interface in org.joda.time">ReadableInterval</A> interval)</CODE>
<BR>
Does this time interval contain the specified time interval.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/joda/time/ReadableInterval.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object readableInterval)</CODE>
<BR>
Compares this object with the specified object for equality based
on start and end millis plus the chronology.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/joda/time/Chronology.html" title="class in org.joda.time">Chronology</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/joda/time/ReadableInterval.html#getChronology()">getChronology</A></B>()</CODE>
<BR>
Gets the chronology of the interval, which is the chronology of the first datetime.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/joda/time/DateTime.html" title="class in org.joda.time">DateTime</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/joda/time/ReadableInterval.html#getEnd()">getEnd</A></B>()</CODE>
<BR>
Gets the end of this time interval, which is exclusive, as a DateTime.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/joda/time/ReadableInterval.html#getEndMillis()">getEndMillis</A></B>()</CODE>
<BR>
Gets the end of this time interval which is exclusive.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/joda/time/DateTime.html" title="class in org.joda.time">DateTime</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/joda/time/ReadableInterval.html#getStart()">getStart</A></B>()</CODE>
<BR>
Gets the start of this time interval, which is inclusive, as a DateTime.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/joda/time/ReadableInterval.html#getStartMillis()">getStartMillis</A></B>()</CODE>
<BR>
Gets the start of this time interval which is inclusive.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/joda/time/ReadableInterval.html#hashCode()">hashCode</A></B>()</CODE>
<BR>
Gets a hash code for the time interval that is compatable with the
equals method.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/joda/time/ReadableInterval.html#isAfter(org.joda.time.ReadableInstant)">isAfter</A></B>(<A HREF="../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</A> instant)</CODE>
<BR>
Is this time interval after the specified instant.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/joda/time/ReadableInterval.html#isAfter(org.joda.time.ReadableInterval)">isAfter</A></B>(<A HREF="../../../org/joda/time/ReadableInterval.html" title="interface in org.joda.time">ReadableInterval</A> interval)</CODE>
<BR>
Is this time interval entirely after the specified interval.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/joda/time/ReadableInterval.html#isBefore(org.joda.time.ReadableInstant)">isBefore</A></B>(<A HREF="../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</A> instant)</CODE>
<BR>
Is this time interval before the specified instant.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/joda/time/ReadableInterval.html#isBefore(org.joda.time.ReadableInterval)">isBefore</A></B>(<A HREF="../../../org/joda/time/ReadableInterval.html" title="interface in org.joda.time">ReadableInterval</A> interval)</CODE>
<BR>
Is this time interval entirely before the specified interval.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/joda/time/ReadableInterval.html#overlaps(org.joda.time.ReadableInterval)">overlaps</A></B>(<A HREF="../../../org/joda/time/ReadableInterval.html" title="interface in org.joda.time">ReadableInterval</A> interval)</CODE>
<BR>
Does this time interval overlap the specified time interval.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/joda/time/Duration.html" title="class in org.joda.time">Duration</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/joda/time/ReadableInterval.html#toDuration()">toDuration</A></B>()</CODE>
<BR>
Gets the millisecond duration of this time interval.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/joda/time/ReadableInterval.html#toDurationMillis()">toDurationMillis</A></B>()</CODE>
<BR>
Gets the millisecond duration of this time interval.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/joda/time/Interval.html" title="class in org.joda.time">Interval</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/joda/time/ReadableInterval.html#toInterval()">toInterval</A></B>()</CODE>
<BR>
Get this interval as an immutable <code>Interval</code> object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/joda/time/MutableInterval.html" title="class in org.joda.time">MutableInterval</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/joda/time/ReadableInterval.html#toMutableInterval()">toMutableInterval</A></B>()</CODE>
<BR>
Get this time interval as a <code>MutableInterval</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/joda/time/Period.html" title="class in org.joda.time">Period</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/joda/time/ReadableInterval.html#toPeriod()">toPeriod</A></B>()</CODE>
<BR>
Converts the duration of the interval to a period using the
standard period type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/joda/time/Period.html" title="class in org.joda.time">Period</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/joda/time/ReadableInterval.html#toPeriod(org.joda.time.PeriodType)">toPeriod</A></B>(<A HREF="../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type)</CODE>
<BR>
Converts the duration of the interval to a period using the
specified period type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/joda/time/ReadableInterval.html#toString()">toString</A></B>()</CODE>
<BR>
Get the value as a String in the ISO8601 interval format.</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getChronology()"><!-- --></A><H3>
getChronology</H3>
<PRE>
<A HREF="../../../org/joda/time/Chronology.html" title="class in org.joda.time">Chronology</A> <B>getChronology</B>()</PRE>
<DL>
<DD>Gets the chronology of the interval, which is the chronology of the first datetime.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the chronology of the interval</DL>
</DD>
</DL>
<HR>
<A NAME="getStartMillis()"><!-- --></A><H3>
getStartMillis</H3>
<PRE>
long <B>getStartMillis</B>()</PRE>
<DL>
<DD>Gets the start of this time interval which is inclusive.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the start of the time interval,
millisecond instant from 1970-01-01T00:00:00Z</DL>
</DD>
</DL>
<HR>
<A NAME="getStart()"><!-- --></A><H3>
getStart</H3>
<PRE>
<A HREF="../../../org/joda/time/DateTime.html" title="class in org.joda.time">DateTime</A> <B>getStart</B>()</PRE>
<DL>
<DD>Gets the start of this time interval, which is inclusive, as a DateTime.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the start of the time interval</DL>
</DD>
</DL>
<HR>
<A NAME="getEndMillis()"><!-- --></A><H3>
getEndMillis</H3>
<PRE>
long <B>getEndMillis</B>()</PRE>
<DL>
<DD>Gets the end of this time interval which is exclusive.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the end of the time interval,
millisecond instant from 1970-01-01T00:00:00Z</DL>
</DD>
</DL>
<HR>
<A NAME="getEnd()"><!-- --></A><H3>
getEnd</H3>
<PRE>
<A HREF="../../../org/joda/time/DateTime.html" title="class in org.joda.time">DateTime</A> <B>getEnd</B>()</PRE>
<DL>
<DD>Gets the end of this time interval, which is exclusive, as a DateTime.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the end of the time interval</DL>
</DD>
</DL>
<HR>
<A NAME="contains(org.joda.time.ReadableInstant)"><!-- --></A><H3>
contains</H3>
<PRE>
boolean <B>contains</B>(<A HREF="../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</A> instant)</PRE>
<DL>
<DD>Does this time interval contain the specified instant.
<p>
Non-zero duration intervals are inclusive of the start instant and
exclusive of the end. A zero duration interval cannot contain anything.
<p>
For example:
<pre>
[09:00 to 10:00) contains 08:59 = false (before start)
[09:00 to 10:00) contains 09:00 = true
[09:00 to 10:00) contains 09:59 = true
[09:00 to 10:00) contains 10:00 = false (equals end)
[09:00 to 10:00) contains 10:01 = false (after end)
[14:00 to 14:00) contains 14:00 = false (zero duration contains nothing)
</pre>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>instant</CODE> - the instant, null means now
<DT><B>Returns:</B><DD>true if this time interval contains the instant</DL>
</DD>
</DL>
<HR>
<A NAME="contains(org.joda.time.ReadableInterval)"><!-- --></A><H3>
contains</H3>
<PRE>
boolean <B>contains</B>(<A HREF="../../../org/joda/time/ReadableInterval.html" title="interface in org.joda.time">ReadableInterval</A> interval)</PRE>
<DL>
<DD>Does this time interval contain the specified time interval.
<p>
Non-zero duration intervals are inclusive of the start instant and
exclusive of the end. The other interval is contained if this interval
wholly contains, starts, finishes or equals it.
A zero duration interval cannot contain anything.
<p>
When two intervals are compared the result is one of three states:
(a) they abut, (b) there is a gap between them, (c) they overlap.
The <code>contains</code> method is not related to these states.
In particular, a zero duration interval is contained at the start of
a larger interval, but does not overlap (it abuts instead).
<p>
For example:
<pre>
[09:00 to 10:00) contains [09:00 to 10:00) = true
[09:00 to 10:00) contains [09:00 to 09:30) = true
[09:00 to 10:00) contains [09:30 to 10:00) = true
[09:00 to 10:00) contains [09:15 to 09:45) = true
[09:00 to 10:00) contains [09:00 to 09:00) = true
[09:00 to 10:00) contains [08:59 to 10:00) = false (otherStart before thisStart)
[09:00 to 10:00) contains [09:00 to 10:01) = false (otherEnd after thisEnd)
[09:00 to 10:00) contains [10:00 to 10:00) = false (otherStart equals thisEnd)
[14:00 to 14:00) contains [14:00 to 14:00) = false (zero duration contains nothing)
</pre>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>interval</CODE> - the time interval to compare to, null means a zero duration interval now
<DT><B>Returns:</B><DD>true if this time interval contains the time interval</DL>
</DD>
</DL>
<HR>
<A NAME="overlaps(org.joda.time.ReadableInterval)"><!-- --></A><H3>
overlaps</H3>
<PRE>
boolean <B>overlaps</B>(<A HREF="../../../org/joda/time/ReadableInterval.html" title="interface in org.joda.time">ReadableInterval</A> interval)</PRE>
<DL>
<DD>Does this time interval overlap the specified time interval.
<p>
Intervals are inclusive of the start instant and exclusive of the end.
An interval overlaps another if it shares some common part of the
datetime continuum.
<p>
When two intervals are compared the result is one of three states:
(a) they abut, (b) there is a gap between them, (c) they overlap.
The abuts state takes precedence over the other two, thus a zero duration
interval at the start of a larger interval abuts and does not overlap.
<p>
For example:
<pre>
[09:00 to 10:00) overlaps [08:00 to 08:30) = false (completely before)
[09:00 to 10:00) overlaps [08:00 to 09:00) = false (abuts before)
[09:00 to 10:00) overlaps [08:00 to 09:30) = true
[09:00 to 10:00) overlaps [08:00 to 10:00) = true
[09:00 to 10:00) overlaps [08:00 to 11:00) = true
[09:00 to 10:00) overlaps [09:00 to 09:00) = false (abuts before)
[09:00 to 10:00) overlaps [09:00 to 09:30) = true
[09:00 to 10:00) overlaps [09:00 to 10:00) = true
[09:00 to 10:00) overlaps [09:00 to 11:00) = true
[09:00 to 10:00) overlaps [09:30 to 09:30) = true
[09:00 to 10:00) overlaps [09:30 to 10:00) = true
[09:00 to 10:00) overlaps [09:30 to 11:00) = true
[09:00 to 10:00) overlaps [10:00 to 10:00) = false (abuts after)
[09:00 to 10:00) overlaps [10:00 to 11:00) = false (abuts after)
[09:00 to 10:00) overlaps [10:30 to 11:00) = false (completely after)
[14:00 to 14:00) overlaps [14:00 to 14:00) = false (abuts before and after)
[14:00 to 14:00) overlaps [13:00 to 15:00) = true
</pre>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>interval</CODE> - the time interval to compare to, null means a zero length interval now
<DT><B>Returns:</B><DD>true if the time intervals overlap</DL>
</DD>
</DL>
<HR>
<A NAME="isAfter(org.joda.time.ReadableInstant)"><!-- --></A><H3>
isAfter</H3>
<PRE>
boolean <B>isAfter</B>(<A HREF="../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</A> instant)</PRE>
<DL>
<DD>Is this time interval after the specified instant.
<p>
Intervals are inclusive of the start instant and exclusive of the end.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>instant</CODE> - the instant to compare to, null means now
<DT><B>Returns:</B><DD>true if this time interval is after the instant</DL>
</DD>
</DL>
<HR>
<A NAME="isAfter(org.joda.time.ReadableInterval)"><!-- --></A><H3>
isAfter</H3>
<PRE>
boolean <B>isAfter</B>(<A HREF="../../../org/joda/time/ReadableInterval.html" title="interface in org.joda.time">ReadableInterval</A> interval)</PRE>
<DL>
<DD>Is this time interval entirely after the specified interval.
<p>
Intervals are inclusive of the start instant and exclusive of the end.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>interval</CODE> - the interval to compare to, null means now
<DT><B>Returns:</B><DD>true if this time interval is after the interval specified</DL>
</DD>
</DL>
<HR>
<A NAME="isBefore(org.joda.time.ReadableInstant)"><!-- --></A><H3>
isBefore</H3>
<PRE>
boolean <B>isBefore</B>(<A HREF="../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</A> instant)</PRE>
<DL>
<DD>Is this time interval before the specified instant.
<p>
Intervals are inclusive of the start instant and exclusive of the end.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>instant</CODE> - the instant to compare to, null means now
<DT><B>Returns:</B><DD>true if this time interval is before the instant</DL>
</DD>
</DL>
<HR>
<A NAME="isBefore(org.joda.time.ReadableInterval)"><!-- --></A><H3>
isBefore</H3>
<PRE>
boolean <B>isBefore</B>(<A HREF="../../../org/joda/time/ReadableInterval.html" title="interface in org.joda.time">ReadableInterval</A> interval)</PRE>
<DL>
<DD>Is this time interval entirely before the specified interval.
<p>
Intervals are inclusive of the start instant and exclusive of the end.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>interval</CODE> - the interval to compare to, null means now
<DT><B>Returns:</B><DD>true if this time interval is before the interval specified</DL>
</DD>
</DL>
<HR>
<A NAME="toInterval()"><!-- --></A><H3>
toInterval</H3>
<PRE>
<A HREF="../../../org/joda/time/Interval.html" title="class in org.joda.time">Interval</A> <B>toInterval</B>()</PRE>
<DL>
<DD>Get this interval as an immutable <code>Interval</code> object.
<p>
This will either typecast this instance, or create a new <code>Interval</code>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the interval as an Interval object</DL>
</DD>
</DL>
<HR>
<A NAME="toMutableInterval()"><!-- --></A><H3>
toMutableInterval</H3>
<PRE>
<A HREF="../../../org/joda/time/MutableInterval.html" title="class in org.joda.time">MutableInterval</A> <B>toMutableInterval</B>()</PRE>
<DL>
<DD>Get this time interval as a <code>MutableInterval</code>.
<p>
This will always return a new <code>MutableInterval</code> with the same interval.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the time interval as a MutableInterval object</DL>
</DD>
</DL>
<HR>
<A NAME="toDuration()"><!-- --></A><H3>
toDuration</H3>
<PRE>
<A HREF="../../../org/joda/time/Duration.html" title="class in org.joda.time">Duration</A> <B>toDuration</B>()</PRE>
<DL>
<DD>Gets the millisecond duration of this time interval.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the millisecond duration of the time interval
<DT><B>Throws:</B>
<DD><CODE>java.lang.ArithmeticException</CODE> - if the duration exceeds the capacity of a long</DL>
</DD>
</DL>
<HR>
<A NAME="toDurationMillis()"><!-- --></A><H3>
toDurationMillis</H3>
<PRE>
long <B>toDurationMillis</B>()</PRE>
<DL>
<DD>Gets the millisecond duration of this time interval.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the millisecond duration of the time interval
<DT><B>Throws:</B>
<DD><CODE>java.lang.ArithmeticException</CODE> - if the duration exceeds the capacity of a long</DL>
</DD>
</DL>
<HR>
<A NAME="toPeriod()"><!-- --></A><H3>
toPeriod</H3>
<PRE>
<A HREF="../../../org/joda/time/Period.html" title="class in org.joda.time">Period</A> <B>toPeriod</B>()</PRE>
<DL>
<DD>Converts the duration of the interval to a period using the
standard period type.
<p>
This method should be used to exract the field values describing the
difference between the start and end instants.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a time period derived from the interval</DL>
</DD>
</DL>
<HR>
<A NAME="toPeriod(org.joda.time.PeriodType)"><!-- --></A><H3>
toPeriod</H3>
<PRE>
<A HREF="../../../org/joda/time/Period.html" title="class in org.joda.time">Period</A> <B>toPeriod</B>(<A HREF="../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type)</PRE>
<DL>
<DD>Converts the duration of the interval to a period using the
specified period type.
<p>
This method should be used to exract the field values describing the
difference between the start and end instants.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>type</CODE> - the requested type of the duration, null means standard
<DT><B>Returns:</B><DD>a time period derived from the interval</DL>
</DD>
</DL>
<HR>
<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
boolean <B>equals</B>(java.lang.Object readableInterval)</PRE>
<DL>
<DD>Compares this object with the specified object for equality based
on start and end millis plus the chronology.
All ReadableInterval instances are accepted.
<p>
To compare the duration of two time intervals, use <A HREF="../../../org/joda/time/ReadableInterval.html#toDuration()"><CODE>toDuration()</CODE></A>
to get the durations and compare those.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>readableInterval</CODE> - a readable interval to check against
<DT><B>Returns:</B><DD>true if the start and end millis are equal</DL>
</DD>
</DL>
<HR>
<A NAME="hashCode()"><!-- --></A><H3>
hashCode</H3>
<PRE>
int <B>hashCode</B>()</PRE>
<DL>
<DD>Gets a hash code for the time interval that is compatable with the
equals method.
<p>
The formula used must be as follows:
<pre>int result = 97;
result = 31 * result + ((int) (getStartMillis() ^ (getStartMillis() >>> 32)));
result = 31 * result + ((int) (getEndMillis() ^ (getEndMillis() >>> 32)));
result = 31 * result + getChronology().hashCode();
return result;</pre>
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>hashCode</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>a hash code</DL>
</DD>
</DL>
<HR>
<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
java.lang.String <B>toString</B>()</PRE>
<DL>
<DD>Get the value as a String in the ISO8601 interval format.
<p>
For example, "2004-06-09T12:30:00.000/2004-07-10T13:30:00.000".
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the value as an ISO8601 string</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ReadableInterval.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time"><B>PREV CLASS</B></A>
<A HREF="../../../org/joda/time/ReadablePartial.html" title="interface in org.joda.time"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?org/joda/time/ReadableInterval.html" target="_top"><B>FRAMES</B></A>
<A HREF="ReadableInterval.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright © 2002-2012 <a href="http://www.joda.org">Joda.org</a>. All Rights Reserved.
</BODY>
</HTML>
|