/usr/share/doc/libjoda-time-java/api/org/joda/time/base/BasePeriod.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 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 | <!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:16 UTC 2012 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
BasePeriod (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="BasePeriod (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/BasePeriod.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/base/BasePartial.html" title="class in org.joda.time.base"><B>PREV CLASS</B></A>
<A HREF="../../../../org/joda/time/base/BaseSingleFieldPeriod.html" title="class in org.joda.time.base"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/joda/time/base/BasePeriod.html" target="_top"><B>FRAMES</B></A>
<A HREF="BasePeriod.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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.base</FONT>
<BR>
Class BasePeriod</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/joda/time/base/AbstractPeriod.html" title="class in org.joda.time.base">org.joda.time.base.AbstractPeriod</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.joda.time.base.BasePeriod</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, <A HREF="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</A></DD>
</DL>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/joda/time/MutablePeriod.html" title="class in org.joda.time">MutablePeriod</A>, <A HREF="../../../../org/joda/time/Period.html" title="class in org.joda.time">Period</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public abstract class <B>BasePeriod</B><DT>extends <A HREF="../../../../org/joda/time/base/AbstractPeriod.html" title="class in org.joda.time.base">AbstractPeriod</A><DT>implements <A HREF="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</A>, java.io.Serializable</DL>
</PRE>
<P>
BasePeriod is an abstract implementation of ReadablePeriod that stores
data in a <code>PeriodType</code> and an <code>int[]</code>.
<p>
This class should generally not be used directly by API users.
The <A HREF="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time"><CODE>ReadablePeriod</CODE></A> interface should be used when different
kinds of period objects are to be referenced.
<p>
BasePeriod subclasses may be mutable and not thread-safe.
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>1.0</DD>
<DT><B>Author:</B></DT>
<DD>Brian S O'Neill, Stephen Colebourne</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.joda.time.base.BasePeriod">Serialized Form</A></DL>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_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>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#BasePeriod(int[], org.joda.time.PeriodType)">BasePeriod</A></B>(int[] values,
<A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type)</CODE>
<BR>
Constructor used when we trust ourselves.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#BasePeriod(int, int, int, int, int, int, int, int, org.joda.time.PeriodType)">BasePeriod</A></B>(int years,
int months,
int weeks,
int days,
int hours,
int minutes,
int seconds,
int millis,
<A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type)</CODE>
<BR>
Creates a period from a set of field values.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#BasePeriod(long)">BasePeriod</A></B>(long duration)</CODE>
<BR>
Creates a period from the given millisecond duration with the standard period type
and ISO rules, ensuring that the calculation is performed with the time-only period type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#BasePeriod(long, long, org.joda.time.PeriodType, org.joda.time.Chronology)">BasePeriod</A></B>(long startInstant,
long endInstant,
<A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type,
<A HREF="../../../../org/joda/time/Chronology.html" title="class in org.joda.time">Chronology</A> chrono)</CODE>
<BR>
Creates a period from the given interval endpoints.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#BasePeriod(long, org.joda.time.PeriodType, org.joda.time.Chronology)">BasePeriod</A></B>(long duration,
<A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type,
<A HREF="../../../../org/joda/time/Chronology.html" title="class in org.joda.time">Chronology</A> chrono)</CODE>
<BR>
Creates a period from the given millisecond duration, which is only really
suitable for durations less than one day.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#BasePeriod(java.lang.Object, org.joda.time.PeriodType, org.joda.time.Chronology)">BasePeriod</A></B>(java.lang.Object period,
<A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type,
<A HREF="../../../../org/joda/time/Chronology.html" title="class in org.joda.time">Chronology</A> chrono)</CODE>
<BR>
Creates a new period based on another using the <A HREF="../../../../org/joda/time/convert/ConverterManager.html" title="class in org.joda.time.convert"><CODE>ConverterManager</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#BasePeriod(org.joda.time.ReadableDuration, org.joda.time.ReadableInstant, org.joda.time.PeriodType)">BasePeriod</A></B>(<A HREF="../../../../org/joda/time/ReadableDuration.html" title="interface in org.joda.time">ReadableDuration</A> duration,
<A HREF="../../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</A> endInstant,
<A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type)</CODE>
<BR>
Creates a period from the given duration and end point.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#BasePeriod(org.joda.time.ReadableInstant, org.joda.time.ReadableDuration, org.joda.time.PeriodType)">BasePeriod</A></B>(<A HREF="../../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</A> startInstant,
<A HREF="../../../../org/joda/time/ReadableDuration.html" title="interface in org.joda.time">ReadableDuration</A> duration,
<A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type)</CODE>
<BR>
Creates a period from the given start point and duration.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#BasePeriod(org.joda.time.ReadableInstant, org.joda.time.ReadableInstant, org.joda.time.PeriodType)">BasePeriod</A></B>(<A HREF="../../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</A> startInstant,
<A HREF="../../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</A> endInstant,
<A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type)</CODE>
<BR>
Creates a period from the given interval endpoints.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#BasePeriod(org.joda.time.ReadablePartial, org.joda.time.ReadablePartial, org.joda.time.PeriodType)">BasePeriod</A></B>(<A HREF="../../../../org/joda/time/ReadablePartial.html" title="interface in org.joda.time">ReadablePartial</A> start,
<A HREF="../../../../org/joda/time/ReadablePartial.html" title="interface in org.joda.time">ReadablePartial</A> end,
<A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type)</CODE>
<BR>
Creates a period from the given duration and end point.</TD>
</TR>
</TABLE>
<!-- ========== 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>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#addField(org.joda.time.DurationFieldType, int)">addField</A></B>(<A HREF="../../../../org/joda/time/DurationFieldType.html" title="class in org.joda.time">DurationFieldType</A> field,
int value)</CODE>
<BR>
Adds the value of a field in this period.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#addFieldInto(int[], org.joda.time.DurationFieldType, int)">addFieldInto</A></B>(int[] values,
<A HREF="../../../../org/joda/time/DurationFieldType.html" title="class in org.joda.time">DurationFieldType</A> field,
int value)</CODE>
<BR>
Adds the value of a field in this period.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#addPeriod(org.joda.time.ReadablePeriod)">addPeriod</A></B>(<A HREF="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</A> period)</CODE>
<BR>
Adds the fields from another period.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected int[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#addPeriodInto(int[], org.joda.time.ReadablePeriod)">addPeriodInto</A></B>(int[] values,
<A HREF="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</A> period)</CODE>
<BR>
Adds the fields from another period.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#checkPeriodType(org.joda.time.PeriodType)">checkPeriodType</A></B>(<A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type)</CODE>
<BR>
Validates a period type, converting nulls to a default value and
checking the type is suitable for this instance.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#getPeriodType()">getPeriodType</A></B>()</CODE>
<BR>
Gets the period type.</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/base/BasePeriod.html#getValue(int)">getValue</A></B>(int index)</CODE>
<BR>
Gets the value at the specified index.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#mergePeriod(org.joda.time.ReadablePeriod)">mergePeriod</A></B>(<A HREF="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</A> period)</CODE>
<BR>
Merges the fields from another period.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected int[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#mergePeriodInto(int[], org.joda.time.ReadablePeriod)">mergePeriodInto</A></B>(int[] values,
<A HREF="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</A> period)</CODE>
<BR>
Merges the fields from another period.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#setField(org.joda.time.DurationFieldType, int)">setField</A></B>(<A HREF="../../../../org/joda/time/DurationFieldType.html" title="class in org.joda.time">DurationFieldType</A> field,
int value)</CODE>
<BR>
Sets the value of a field in this period.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#setFieldInto(int[], org.joda.time.DurationFieldType, int)">setFieldInto</A></B>(int[] values,
<A HREF="../../../../org/joda/time/DurationFieldType.html" title="class in org.joda.time">DurationFieldType</A> field,
int value)</CODE>
<BR>
Sets the value of a field in this period.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#setPeriod(int, int, int, int, int, int, int, int)">setPeriod</A></B>(int years,
int months,
int weeks,
int days,
int hours,
int minutes,
int seconds,
int millis)</CODE>
<BR>
Sets the eight standard the fields in one go.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#setPeriod(org.joda.time.ReadablePeriod)">setPeriod</A></B>(<A HREF="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</A> period)</CODE>
<BR>
Sets all the fields of this period from another.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#setValue(int, int)">setValue</A></B>(int index,
int value)</CODE>
<BR>
Sets the value of the field at the specified index.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/base/BasePeriod.html#setValues(int[])">setValues</A></B>(int[] values)</CODE>
<BR>
Sets the values of all fields.</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/base/BasePeriod.html#toDurationFrom(org.joda.time.ReadableInstant)">toDurationFrom</A></B>(<A HREF="../../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</A> startInstant)</CODE>
<BR>
Gets the total millisecond duration of this period relative to a start instant.</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/base/BasePeriod.html#toDurationTo(org.joda.time.ReadableInstant)">toDurationTo</A></B>(<A HREF="../../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</A> endInstant)</CODE>
<BR>
Gets the total millisecond duration of this period relative to an
end instant.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.joda.time.base.AbstractPeriod"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class org.joda.time.base.<A HREF="../../../../org/joda/time/base/AbstractPeriod.html" title="class in org.joda.time.base">AbstractPeriod</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/joda/time/base/AbstractPeriod.html#equals(java.lang.Object)">equals</A>, <A HREF="../../../../org/joda/time/base/AbstractPeriod.html#get(org.joda.time.DurationFieldType)">get</A>, <A HREF="../../../../org/joda/time/base/AbstractPeriod.html#getFieldType(int)">getFieldType</A>, <A HREF="../../../../org/joda/time/base/AbstractPeriod.html#getFieldTypes()">getFieldTypes</A>, <A HREF="../../../../org/joda/time/base/AbstractPeriod.html#getValues()">getValues</A>, <A HREF="../../../../org/joda/time/base/AbstractPeriod.html#hashCode()">hashCode</A>, <A HREF="../../../../org/joda/time/base/AbstractPeriod.html#indexOf(org.joda.time.DurationFieldType)">indexOf</A>, <A HREF="../../../../org/joda/time/base/AbstractPeriod.html#isSupported(org.joda.time.DurationFieldType)">isSupported</A>, <A HREF="../../../../org/joda/time/base/AbstractPeriod.html#size()">size</A>, <A HREF="../../../../org/joda/time/base/AbstractPeriod.html#toMutablePeriod()">toMutablePeriod</A>, <A HREF="../../../../org/joda/time/base/AbstractPeriod.html#toPeriod()">toPeriod</A>, <A HREF="../../../../org/joda/time/base/AbstractPeriod.html#toString()">toString</A>, <A HREF="../../../../org/joda/time/base/AbstractPeriod.html#toString(org.joda.time.format.PeriodFormatter)">toString</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.joda.time.ReadablePeriod"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface org.joda.time.<A HREF="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/joda/time/ReadablePeriod.html#equals(java.lang.Object)">equals</A>, <A HREF="../../../../org/joda/time/ReadablePeriod.html#get(org.joda.time.DurationFieldType)">get</A>, <A HREF="../../../../org/joda/time/ReadablePeriod.html#getFieldType(int)">getFieldType</A>, <A HREF="../../../../org/joda/time/ReadablePeriod.html#hashCode()">hashCode</A>, <A HREF="../../../../org/joda/time/ReadablePeriod.html#isSupported(org.joda.time.DurationFieldType)">isSupported</A>, <A HREF="../../../../org/joda/time/ReadablePeriod.html#size()">size</A>, <A HREF="../../../../org/joda/time/ReadablePeriod.html#toMutablePeriod()">toMutablePeriod</A>, <A HREF="../../../../org/joda/time/ReadablePeriod.html#toPeriod()">toPeriod</A>, <A HREF="../../../../org/joda/time/ReadablePeriod.html#toString()">toString</A></CODE></TD>
</TR>
</TABLE>
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_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>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="BasePeriod(int, int, int, int, int, int, int, int, org.joda.time.PeriodType)"><!-- --></A><H3>
BasePeriod</H3>
<PRE>
protected <B>BasePeriod</B>(int years,
int months,
int weeks,
int days,
int hours,
int minutes,
int seconds,
int millis,
<A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type)</PRE>
<DL>
<DD>Creates a period from a set of field values.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>years</CODE> - amount of years in this period, which must be zero if unsupported<DD><CODE>months</CODE> - amount of months in this period, which must be zero if unsupported<DD><CODE>weeks</CODE> - amount of weeks in this period, which must be zero if unsupported<DD><CODE>days</CODE> - amount of days in this period, which must be zero if unsupported<DD><CODE>hours</CODE> - amount of hours in this period, which must be zero if unsupported<DD><CODE>minutes</CODE> - amount of minutes in this period, which must be zero if unsupported<DD><CODE>seconds</CODE> - amount of seconds in this period, which must be zero if unsupported<DD><CODE>millis</CODE> - amount of milliseconds in this period, which must be zero if unsupported<DD><CODE>type</CODE> - which set of fields this period supports
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if period type is invalid
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if an unsupported field's value is non-zero</DL>
</DL>
<HR>
<A NAME="BasePeriod(long, long, org.joda.time.PeriodType, org.joda.time.Chronology)"><!-- --></A><H3>
BasePeriod</H3>
<PRE>
protected <B>BasePeriod</B>(long startInstant,
long endInstant,
<A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type,
<A HREF="../../../../org/joda/time/Chronology.html" title="class in org.joda.time">Chronology</A> chrono)</PRE>
<DL>
<DD>Creates a period from the given interval endpoints.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>startInstant</CODE> - interval start, in milliseconds<DD><CODE>endInstant</CODE> - interval end, in milliseconds<DD><CODE>type</CODE> - which set of fields this period supports, null means standard<DD><CODE>chrono</CODE> - the chronology to use, null means ISO default
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if period type is invalid</DL>
</DL>
<HR>
<A NAME="BasePeriod(org.joda.time.ReadableInstant, org.joda.time.ReadableInstant, org.joda.time.PeriodType)"><!-- --></A><H3>
BasePeriod</H3>
<PRE>
protected <B>BasePeriod</B>(<A HREF="../../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</A> startInstant,
<A HREF="../../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</A> endInstant,
<A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type)</PRE>
<DL>
<DD>Creates a period from the given interval endpoints.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>startInstant</CODE> - interval start, null means now<DD><CODE>endInstant</CODE> - interval end, null means now<DD><CODE>type</CODE> - which set of fields this period supports, null means standard
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if period type is invalid</DL>
</DL>
<HR>
<A NAME="BasePeriod(org.joda.time.ReadablePartial, org.joda.time.ReadablePartial, org.joda.time.PeriodType)"><!-- --></A><H3>
BasePeriod</H3>
<PRE>
protected <B>BasePeriod</B>(<A HREF="../../../../org/joda/time/ReadablePartial.html" title="interface in org.joda.time">ReadablePartial</A> start,
<A HREF="../../../../org/joda/time/ReadablePartial.html" title="interface in org.joda.time">ReadablePartial</A> end,
<A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type)</PRE>
<DL>
<DD>Creates a period from the given duration and end point.
<p>
The two partials must contain the same fields, thus you can
specify two <code>LocalDate</code> objects, or two <code>LocalTime</code>
objects, but not one of each.
As these are Partial objects, time zones have no effect on the result.
<p>
The two partials must also both be contiguous - see
<A HREF="../../../../org/joda/time/DateTimeUtils.html#isContiguous(org.joda.time.ReadablePartial)"><CODE>DateTimeUtils.isContiguous(ReadablePartial)</CODE></A> for a
definition. Both <code>LocalDate</code> and <code>LocalTime</code> are contiguous.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>start</CODE> - the start of the period, must not be null<DD><CODE>end</CODE> - the end of the period, must not be null<DD><CODE>type</CODE> - which set of fields this period supports, null means standard
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the partials are null or invalid<DT><B>Since:</B></DT>
<DD>1.1</DD>
</DL>
</DL>
<HR>
<A NAME="BasePeriod(org.joda.time.ReadableInstant, org.joda.time.ReadableDuration, org.joda.time.PeriodType)"><!-- --></A><H3>
BasePeriod</H3>
<PRE>
protected <B>BasePeriod</B>(<A HREF="../../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</A> startInstant,
<A HREF="../../../../org/joda/time/ReadableDuration.html" title="interface in org.joda.time">ReadableDuration</A> duration,
<A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type)</PRE>
<DL>
<DD>Creates a period from the given start point and duration.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>startInstant</CODE> - the interval start, null means now<DD><CODE>duration</CODE> - the duration of the interval, null means zero-length<DD><CODE>type</CODE> - which set of fields this period supports, null means standard</DL>
</DL>
<HR>
<A NAME="BasePeriod(org.joda.time.ReadableDuration, org.joda.time.ReadableInstant, org.joda.time.PeriodType)"><!-- --></A><H3>
BasePeriod</H3>
<PRE>
protected <B>BasePeriod</B>(<A HREF="../../../../org/joda/time/ReadableDuration.html" title="interface in org.joda.time">ReadableDuration</A> duration,
<A HREF="../../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</A> endInstant,
<A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type)</PRE>
<DL>
<DD>Creates a period from the given duration and end point.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>duration</CODE> - the duration of the interval, null means zero-length<DD><CODE>endInstant</CODE> - the interval end, null means now<DD><CODE>type</CODE> - which set of fields this period supports, null means standard</DL>
</DL>
<HR>
<A NAME="BasePeriod(long)"><!-- --></A><H3>
BasePeriod</H3>
<PRE>
protected <B>BasePeriod</B>(long duration)</PRE>
<DL>
<DD>Creates a period from the given millisecond duration with the standard period type
and ISO rules, ensuring that the calculation is performed with the time-only period type.
<p>
The calculation uses the hour, minute, second and millisecond fields.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>duration</CODE> - the duration, in milliseconds</DL>
</DL>
<HR>
<A NAME="BasePeriod(long, org.joda.time.PeriodType, org.joda.time.Chronology)"><!-- --></A><H3>
BasePeriod</H3>
<PRE>
protected <B>BasePeriod</B>(long duration,
<A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type,
<A HREF="../../../../org/joda/time/Chronology.html" title="class in org.joda.time">Chronology</A> chrono)</PRE>
<DL>
<DD>Creates a period from the given millisecond duration, which is only really
suitable for durations less than one day.
<p>
Only fields that are precise will be used.
Thus the largest precise field may have a large value.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>duration</CODE> - the duration, in milliseconds<DD><CODE>type</CODE> - which set of fields this period supports, null means standard<DD><CODE>chrono</CODE> - the chronology to use, null means ISO default
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if period type is invalid</DL>
</DL>
<HR>
<A NAME="BasePeriod(java.lang.Object, org.joda.time.PeriodType, org.joda.time.Chronology)"><!-- --></A><H3>
BasePeriod</H3>
<PRE>
protected <B>BasePeriod</B>(java.lang.Object period,
<A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type,
<A HREF="../../../../org/joda/time/Chronology.html" title="class in org.joda.time">Chronology</A> chrono)</PRE>
<DL>
<DD>Creates a new period based on another using the <A HREF="../../../../org/joda/time/convert/ConverterManager.html" title="class in org.joda.time.convert"><CODE>ConverterManager</CODE></A>.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>period</CODE> - the period to convert<DD><CODE>type</CODE> - which set of fields this period supports, null means use type from object<DD><CODE>chrono</CODE> - the chronology to use, null means ISO default
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if period is invalid
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if an unsupported field's value is non-zero</DL>
</DL>
<HR>
<A NAME="BasePeriod(int[], org.joda.time.PeriodType)"><!-- --></A><H3>
BasePeriod</H3>
<PRE>
protected <B>BasePeriod</B>(int[] values,
<A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type)</PRE>
<DL>
<DD>Constructor used when we trust ourselves.
Do not expose publically.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>values</CODE> - the values to use, not null, not cloned<DD><CODE>type</CODE> - which set of fields this period supports, not null</DL>
</DL>
<!-- ============ 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="checkPeriodType(org.joda.time.PeriodType)"><!-- --></A><H3>
checkPeriodType</H3>
<PRE>
protected <A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> <B>checkPeriodType</B>(<A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type)</PRE>
<DL>
<DD>Validates a period type, converting nulls to a default value and
checking the type is suitable for this instance.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>type</CODE> - the type to check, may be null
<DT><B>Returns:</B><DD>the validated type to use, not null
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the period type is invalid</DL>
</DD>
</DL>
<HR>
<A NAME="getPeriodType()"><!-- --></A><H3>
getPeriodType</H3>
<PRE>
public <A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> <B>getPeriodType</B>()</PRE>
<DL>
<DD>Gets the period type.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/joda/time/ReadablePeriod.html#getPeriodType()">getPeriodType</A></CODE> in interface <CODE><A HREF="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the period type</DL>
</DD>
</DL>
<HR>
<A NAME="getValue(int)"><!-- --></A><H3>
getValue</H3>
<PRE>
public int <B>getValue</B>(int index)</PRE>
<DL>
<DD>Gets the value at the specified index.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/joda/time/ReadablePeriod.html#getValue(int)">getValue</A></CODE> in interface <CODE><A HREF="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - the index to retrieve
<DT><B>Returns:</B><DD>the value of the field at the specified index
<DT><B>Throws:</B>
<DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if the index is invalid</DL>
</DD>
</DL>
<HR>
<A NAME="toDurationFrom(org.joda.time.ReadableInstant)"><!-- --></A><H3>
toDurationFrom</H3>
<PRE>
public <A HREF="../../../../org/joda/time/Duration.html" title="class in org.joda.time">Duration</A> <B>toDurationFrom</B>(<A HREF="../../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</A> startInstant)</PRE>
<DL>
<DD>Gets the total millisecond duration of this period relative to a start instant.
<p>
This method adds the period to the specified instant in order to
calculate the duration.
<p>
An instant must be supplied as the duration of a period varies.
For example, a period of 1 month could vary between the equivalent of
28 and 31 days in milliseconds due to different length months.
Similarly, a day can vary at Daylight Savings cutover, typically between
23 and 25 hours.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>startInstant</CODE> - the instant to add the period to, thus obtaining the duration
<DT><B>Returns:</B><DD>the total length of the period as a duration relative to the start instant
<DT><B>Throws:</B>
<DD><CODE>java.lang.ArithmeticException</CODE> - if the millis exceeds the capacity of the duration</DL>
</DD>
</DL>
<HR>
<A NAME="toDurationTo(org.joda.time.ReadableInstant)"><!-- --></A><H3>
toDurationTo</H3>
<PRE>
public <A HREF="../../../../org/joda/time/Duration.html" title="class in org.joda.time">Duration</A> <B>toDurationTo</B>(<A HREF="../../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time">ReadableInstant</A> endInstant)</PRE>
<DL>
<DD>Gets the total millisecond duration of this period relative to an
end instant.
<p>
This method subtracts the period from the specified instant in order
to calculate the duration.
<p>
An instant must be supplied as the duration of a period varies.
For example, a period of 1 month could vary between the equivalent of
28 and 31 days in milliseconds due to different length months.
Similarly, a day can vary at Daylight Savings cutover, typically between
23 and 25 hours.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>endInstant</CODE> - the instant to subtract the period from, thus obtaining the duration
<DT><B>Returns:</B><DD>the total length of the period as a duration relative to the end instant
<DT><B>Throws:</B>
<DD><CODE>java.lang.ArithmeticException</CODE> - if the millis exceeds the capacity of the duration</DL>
</DD>
</DL>
<HR>
<A NAME="setPeriod(org.joda.time.ReadablePeriod)"><!-- --></A><H3>
setPeriod</H3>
<PRE>
protected void <B>setPeriod</B>(<A HREF="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</A> period)</PRE>
<DL>
<DD>Sets all the fields of this period from another.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>period</CODE> - the period to copy from, not null
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if an unsupported field's value is non-zero</DL>
</DD>
</DL>
<HR>
<A NAME="setPeriod(int, int, int, int, int, int, int, int)"><!-- --></A><H3>
setPeriod</H3>
<PRE>
protected void <B>setPeriod</B>(int years,
int months,
int weeks,
int days,
int hours,
int minutes,
int seconds,
int millis)</PRE>
<DL>
<DD>Sets the eight standard the fields in one go.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>years</CODE> - amount of years in this period, which must be zero if unsupported<DD><CODE>months</CODE> - amount of months in this period, which must be zero if unsupported<DD><CODE>weeks</CODE> - amount of weeks in this period, which must be zero if unsupported<DD><CODE>days</CODE> - amount of days in this period, which must be zero if unsupported<DD><CODE>hours</CODE> - amount of hours in this period, which must be zero if unsupported<DD><CODE>minutes</CODE> - amount of minutes in this period, which must be zero if unsupported<DD><CODE>seconds</CODE> - amount of seconds in this period, which must be zero if unsupported<DD><CODE>millis</CODE> - amount of milliseconds in this period, which must be zero if unsupported
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if an unsupported field's value is non-zero</DL>
</DD>
</DL>
<HR>
<A NAME="setField(org.joda.time.DurationFieldType, int)"><!-- --></A><H3>
setField</H3>
<PRE>
protected void <B>setField</B>(<A HREF="../../../../org/joda/time/DurationFieldType.html" title="class in org.joda.time">DurationFieldType</A> field,
int value)</PRE>
<DL>
<DD>Sets the value of a field in this period.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>field</CODE> - the field to set<DD><CODE>value</CODE> - the value to set
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if field is is null or not supported.</DL>
</DD>
</DL>
<HR>
<A NAME="setFieldInto(int[], org.joda.time.DurationFieldType, int)"><!-- --></A><H3>
setFieldInto</H3>
<PRE>
protected void <B>setFieldInto</B>(int[] values,
<A HREF="../../../../org/joda/time/DurationFieldType.html" title="class in org.joda.time">DurationFieldType</A> field,
int value)</PRE>
<DL>
<DD>Sets the value of a field in this period.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>values</CODE> - the array of values to update<DD><CODE>field</CODE> - the field to set<DD><CODE>value</CODE> - the value to set
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if field is null or not supported.</DL>
</DD>
</DL>
<HR>
<A NAME="addField(org.joda.time.DurationFieldType, int)"><!-- --></A><H3>
addField</H3>
<PRE>
protected void <B>addField</B>(<A HREF="../../../../org/joda/time/DurationFieldType.html" title="class in org.joda.time">DurationFieldType</A> field,
int value)</PRE>
<DL>
<DD>Adds the value of a field in this period.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>field</CODE> - the field to set<DD><CODE>value</CODE> - the value to set
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if field is is null or not supported.</DL>
</DD>
</DL>
<HR>
<A NAME="addFieldInto(int[], org.joda.time.DurationFieldType, int)"><!-- --></A><H3>
addFieldInto</H3>
<PRE>
protected void <B>addFieldInto</B>(int[] values,
<A HREF="../../../../org/joda/time/DurationFieldType.html" title="class in org.joda.time">DurationFieldType</A> field,
int value)</PRE>
<DL>
<DD>Adds the value of a field in this period.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>values</CODE> - the array of values to update<DD><CODE>field</CODE> - the field to set<DD><CODE>value</CODE> - the value to set
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if field is is null or not supported.</DL>
</DD>
</DL>
<HR>
<A NAME="mergePeriod(org.joda.time.ReadablePeriod)"><!-- --></A><H3>
mergePeriod</H3>
<PRE>
protected void <B>mergePeriod</B>(<A HREF="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</A> period)</PRE>
<DL>
<DD>Merges the fields from another period.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>period</CODE> - the period to add from, not null
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if an unsupported field's value is non-zero</DL>
</DD>
</DL>
<HR>
<A NAME="mergePeriodInto(int[], org.joda.time.ReadablePeriod)"><!-- --></A><H3>
mergePeriodInto</H3>
<PRE>
protected int[] <B>mergePeriodInto</B>(int[] values,
<A HREF="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</A> period)</PRE>
<DL>
<DD>Merges the fields from another period.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>values</CODE> - the array of values to update<DD><CODE>period</CODE> - the period to add from, not null
<DT><B>Returns:</B><DD>the updated values
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if an unsupported field's value is non-zero</DL>
</DD>
</DL>
<HR>
<A NAME="addPeriod(org.joda.time.ReadablePeriod)"><!-- --></A><H3>
addPeriod</H3>
<PRE>
protected void <B>addPeriod</B>(<A HREF="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</A> period)</PRE>
<DL>
<DD>Adds the fields from another period.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>period</CODE> - the period to add from, not null
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if an unsupported field's value is non-zero</DL>
</DD>
</DL>
<HR>
<A NAME="addPeriodInto(int[], org.joda.time.ReadablePeriod)"><!-- --></A><H3>
addPeriodInto</H3>
<PRE>
protected int[] <B>addPeriodInto</B>(int[] values,
<A HREF="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</A> period)</PRE>
<DL>
<DD>Adds the fields from another period.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>values</CODE> - the array of values to update<DD><CODE>period</CODE> - the period to add from, not null
<DT><B>Returns:</B><DD>the updated values
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if an unsupported field's value is non-zero</DL>
</DD>
</DL>
<HR>
<A NAME="setValue(int, int)"><!-- --></A><H3>
setValue</H3>
<PRE>
protected void <B>setValue</B>(int index,
int value)</PRE>
<DL>
<DD>Sets the value of the field at the specified index.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - the index<DD><CODE>value</CODE> - the value to set
<DT><B>Throws:</B>
<DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if the index is invalid</DL>
</DD>
</DL>
<HR>
<A NAME="setValues(int[])"><!-- --></A><H3>
setValues</H3>
<PRE>
protected void <B>setValues</B>(int[] values)</PRE>
<DL>
<DD>Sets the values of all fields.
<p>
In version 2.0 and later, this method copies the array into the original.
This is because the instance variable has been changed to be final to satisfy the Java Memory Model.
This only impacts subclasses that are mutable.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>values</CODE> - the array of values</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/BasePeriod.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/base/BasePartial.html" title="class in org.joda.time.base"><B>PREV CLASS</B></A>
<A HREF="../../../../org/joda/time/base/BaseSingleFieldPeriod.html" title="class in org.joda.time.base"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/joda/time/base/BasePeriod.html" target="_top"><B>FRAMES</B></A>
<A HREF="BasePeriod.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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>
|