/usr/share/doc/libjoda-time-java/api/org/joda/time/format/PeriodFormatter.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 | <!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:15 UTC 2012 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
PeriodFormatter (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="PeriodFormatter (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/PeriodFormatter.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/format/PeriodFormat.html" title="class in org.joda.time.format"><B>PREV CLASS</B></A>
<A HREF="../../../../org/joda/time/format/PeriodFormatterBuilder.html" title="class in org.joda.time.format"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/joda/time/format/PeriodFormatter.html" target="_top"><B>FRAMES</B></A>
<A HREF="PeriodFormatter.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.format</FONT>
<BR>
Class PeriodFormatter</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.joda.time.format.PeriodFormatter</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>PeriodFormatter</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
Controls the printing and parsing of a time period to and from a string.
<p>
This class is the main API for printing and parsing used by most applications.
Instances of this class are created via one of three factory classes:
<ul>
<li><A HREF="../../../../org/joda/time/format/PeriodFormat.html" title="class in org.joda.time.format"><CODE>PeriodFormat</CODE></A> - formats by pattern and style</li>
<li><A HREF="../../../../org/joda/time/format/ISOPeriodFormat.html" title="class in org.joda.time.format"><CODE>ISOPeriodFormat</CODE></A> - ISO8601 formats</li>
<li><A HREF="../../../../org/joda/time/format/PeriodFormatterBuilder.html" title="class in org.joda.time.format"><CODE>PeriodFormatterBuilder</CODE></A> - complex formats created via method calls</li>
</ul>
<p>
An instance of this class holds a reference internally to one printer and
one parser. It is possible that one of these may be null, in which case the
formatter cannot print/parse. This can be checked via the <A HREF="../../../../org/joda/time/format/PeriodFormatter.html#isPrinter()"><CODE>isPrinter()</CODE></A>
and <A HREF="../../../../org/joda/time/format/PeriodFormatter.html#isParser()"><CODE>isParser()</CODE></A> methods.
<p>
The underlying printer/parser can be altered to behave exactly as required
by using a decorator modifier:
<ul>
<li><A HREF="../../../../org/joda/time/format/PeriodFormatter.html#withLocale(java.util.Locale)"><CODE>withLocale(Locale)</CODE></A> - returns a new formatter that uses the specified locale</li>
</ul>
This returns a new formatter (instances of this class are immutable).
<p>
The main methods of the class are the <code>printXxx</code> and
<code>parseXxx</code> methods. These are used as follows:
<pre>
// print using the default locale
String periodStr = formatter.print(period);
// print using the French locale
String periodStr = formatter.withLocale(Locale.FRENCH).print(period);
// parse using the French locale
Period date = formatter.withLocale(Locale.FRENCH).parsePeriod(str);
</pre>
<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>
</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><CODE><B><A HREF="../../../../org/joda/time/format/PeriodFormatter.html#PeriodFormatter(org.joda.time.format.PeriodPrinter, org.joda.time.format.PeriodParser)">PeriodFormatter</A></B>(<A HREF="../../../../org/joda/time/format/PeriodPrinter.html" title="interface in org.joda.time.format">PeriodPrinter</A> printer,
<A HREF="../../../../org/joda/time/format/PeriodParser.html" title="interface in org.joda.time.format">PeriodParser</A> parser)</CODE>
<BR>
Creates a new formatter, however you will normally use the factory
or the builder.</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> java.util.Locale</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/format/PeriodFormatter.html#getLocale()">getLocale</A></B>()</CODE>
<BR>
Gets the locale that will be used for printing and parsing.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/joda/time/format/PeriodParser.html" title="interface in org.joda.time.format">PeriodParser</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/format/PeriodFormatter.html#getParser()">getParser</A></B>()</CODE>
<BR>
Gets the internal parser object that performs the real parsing work.</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/format/PeriodFormatter.html#getParseType()">getParseType</A></B>()</CODE>
<BR>
Gets the PeriodType that will be used for parsing.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/joda/time/format/PeriodPrinter.html" title="interface in org.joda.time.format">PeriodPrinter</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/format/PeriodFormatter.html#getPrinter()">getPrinter</A></B>()</CODE>
<BR>
Gets the internal printer object that performs the real printing work.</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/format/PeriodFormatter.html#isParser()">isParser</A></B>()</CODE>
<BR>
Is this formatter capable of parsing.</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/format/PeriodFormatter.html#isPrinter()">isPrinter</A></B>()</CODE>
<BR>
Is this formatter capable of printing.</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/format/PeriodFormatter.html#parseInto(org.joda.time.ReadWritablePeriod, java.lang.String, int)">parseInto</A></B>(<A HREF="../../../../org/joda/time/ReadWritablePeriod.html" title="interface in org.joda.time">ReadWritablePeriod</A> period,
java.lang.String text,
int position)</CODE>
<BR>
Parses a period from the given text, at the given position, saving the
result into the fields of the given ReadWritablePeriod.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/joda/time/MutablePeriod.html" title="class in org.joda.time">MutablePeriod</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/format/PeriodFormatter.html#parseMutablePeriod(java.lang.String)">parseMutablePeriod</A></B>(java.lang.String text)</CODE>
<BR>
Parses a period from the given text, returning a new MutablePeriod.</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/format/PeriodFormatter.html#parsePeriod(java.lang.String)">parsePeriod</A></B>(java.lang.String text)</CODE>
<BR>
Parses a period from the given text, returning a new Period.</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/format/PeriodFormatter.html#print(org.joda.time.ReadablePeriod)">print</A></B>(<A HREF="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</A> period)</CODE>
<BR>
Prints a ReadablePeriod to a new String.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/format/PeriodFormatter.html#printTo(java.lang.StringBuffer, org.joda.time.ReadablePeriod)">printTo</A></B>(java.lang.StringBuffer buf,
<A HREF="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</A> period)</CODE>
<BR>
Prints a ReadablePeriod to a StringBuffer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/format/PeriodFormatter.html#printTo(java.io.Writer, org.joda.time.ReadablePeriod)">printTo</A></B>(java.io.Writer out,
<A HREF="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</A> period)</CODE>
<BR>
Prints a ReadablePeriod to a Writer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/joda/time/format/PeriodFormatter.html" title="class in org.joda.time.format">PeriodFormatter</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/format/PeriodFormatter.html#withLocale(java.util.Locale)">withLocale</A></B>(java.util.Locale locale)</CODE>
<BR>
Returns a new formatter with a different locale that will be used
for printing and parsing.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/joda/time/format/PeriodFormatter.html" title="class in org.joda.time.format">PeriodFormatter</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/joda/time/format/PeriodFormatter.html#withParseType(org.joda.time.PeriodType)">withParseType</A></B>(<A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type)</CODE>
<BR>
Returns a new formatter with a different PeriodType for parsing.</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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="PeriodFormatter(org.joda.time.format.PeriodPrinter, org.joda.time.format.PeriodParser)"><!-- --></A><H3>
PeriodFormatter</H3>
<PRE>
public <B>PeriodFormatter</B>(<A HREF="../../../../org/joda/time/format/PeriodPrinter.html" title="interface in org.joda.time.format">PeriodPrinter</A> printer,
<A HREF="../../../../org/joda/time/format/PeriodParser.html" title="interface in org.joda.time.format">PeriodParser</A> parser)</PRE>
<DL>
<DD>Creates a new formatter, however you will normally use the factory
or the builder.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>printer</CODE> - the internal printer, null if cannot print<DD><CODE>parser</CODE> - the internal parser, null if cannot parse</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="isPrinter()"><!-- --></A><H3>
isPrinter</H3>
<PRE>
public boolean <B>isPrinter</B>()</PRE>
<DL>
<DD>Is this formatter capable of printing.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if this is a printer</DL>
</DD>
</DL>
<HR>
<A NAME="getPrinter()"><!-- --></A><H3>
getPrinter</H3>
<PRE>
public <A HREF="../../../../org/joda/time/format/PeriodPrinter.html" title="interface in org.joda.time.format">PeriodPrinter</A> <B>getPrinter</B>()</PRE>
<DL>
<DD>Gets the internal printer object that performs the real printing work.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the internal printer</DL>
</DD>
</DL>
<HR>
<A NAME="isParser()"><!-- --></A><H3>
isParser</H3>
<PRE>
public boolean <B>isParser</B>()</PRE>
<DL>
<DD>Is this formatter capable of parsing.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if this is a parser</DL>
</DD>
</DL>
<HR>
<A NAME="getParser()"><!-- --></A><H3>
getParser</H3>
<PRE>
public <A HREF="../../../../org/joda/time/format/PeriodParser.html" title="interface in org.joda.time.format">PeriodParser</A> <B>getParser</B>()</PRE>
<DL>
<DD>Gets the internal parser object that performs the real parsing work.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the internal parser</DL>
</DD>
</DL>
<HR>
<A NAME="withLocale(java.util.Locale)"><!-- --></A><H3>
withLocale</H3>
<PRE>
public <A HREF="../../../../org/joda/time/format/PeriodFormatter.html" title="class in org.joda.time.format">PeriodFormatter</A> <B>withLocale</B>(java.util.Locale locale)</PRE>
<DL>
<DD>Returns a new formatter with a different locale that will be used
for printing and parsing.
<p>
A PeriodFormatter is immutable, so a new instance is returned,
and the original is unaltered and still usable.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>locale</CODE> - the locale to use
<DT><B>Returns:</B><DD>the new formatter</DL>
</DD>
</DL>
<HR>
<A NAME="getLocale()"><!-- --></A><H3>
getLocale</H3>
<PRE>
public java.util.Locale <B>getLocale</B>()</PRE>
<DL>
<DD>Gets the locale that will be used for printing and parsing.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the locale to use</DL>
</DD>
</DL>
<HR>
<A NAME="withParseType(org.joda.time.PeriodType)"><!-- --></A><H3>
withParseType</H3>
<PRE>
public <A HREF="../../../../org/joda/time/format/PeriodFormatter.html" title="class in org.joda.time.format">PeriodFormatter</A> <B>withParseType</B>(<A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> type)</PRE>
<DL>
<DD>Returns a new formatter with a different PeriodType for parsing.
<p>
A PeriodFormatter is immutable, so a new instance is returned,
and the original is unaltered and still usable.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>type</CODE> - the type to use in parsing
<DT><B>Returns:</B><DD>the new formatter</DL>
</DD>
</DL>
<HR>
<A NAME="getParseType()"><!-- --></A><H3>
getParseType</H3>
<PRE>
public <A HREF="../../../../org/joda/time/PeriodType.html" title="class in org.joda.time">PeriodType</A> <B>getParseType</B>()</PRE>
<DL>
<DD>Gets the PeriodType that will be used for parsing.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the parse type to use</DL>
</DD>
</DL>
<HR>
<A NAME="printTo(java.lang.StringBuffer, org.joda.time.ReadablePeriod)"><!-- --></A><H3>
printTo</H3>
<PRE>
public void <B>printTo</B>(java.lang.StringBuffer buf,
<A HREF="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</A> period)</PRE>
<DL>
<DD>Prints a ReadablePeriod to a StringBuffer.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>buf</CODE> - the formatted period is appended to this buffer<DD><CODE>period</CODE> - the period to format, not null</DL>
</DD>
</DL>
<HR>
<A NAME="printTo(java.io.Writer, org.joda.time.ReadablePeriod)"><!-- --></A><H3>
printTo</H3>
<PRE>
public void <B>printTo</B>(java.io.Writer out,
<A HREF="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</A> period)
throws java.io.IOException</PRE>
<DL>
<DD>Prints a ReadablePeriod to a Writer.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>out</CODE> - the formatted period is written out<DD><CODE>period</CODE> - the period to format, not null
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="print(org.joda.time.ReadablePeriod)"><!-- --></A><H3>
print</H3>
<PRE>
public java.lang.String <B>print</B>(<A HREF="../../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time">ReadablePeriod</A> period)</PRE>
<DL>
<DD>Prints a ReadablePeriod to a new String.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>period</CODE> - the period to format, not null
<DT><B>Returns:</B><DD>the printed result</DL>
</DD>
</DL>
<HR>
<A NAME="parseInto(org.joda.time.ReadWritablePeriod, java.lang.String, int)"><!-- --></A><H3>
parseInto</H3>
<PRE>
public int <B>parseInto</B>(<A HREF="../../../../org/joda/time/ReadWritablePeriod.html" title="interface in org.joda.time">ReadWritablePeriod</A> period,
java.lang.String text,
int position)</PRE>
<DL>
<DD>Parses a period from the given text, at the given position, saving the
result into the fields of the given ReadWritablePeriod. If the parse
succeeds, the return value is the new text position. Note that the parse
may succeed without fully reading the text.
<p>
The parse type of the formatter is not used by this method.
<p>
If it fails, the return value is negative, but the period may still be
modified. To determine the position where the parse failed, apply the
one's complement operator (~) on the return value.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>period</CODE> - a period that will be modified<DD><CODE>text</CODE> - text to parse<DD><CODE>position</CODE> - position to start parsing from
<DT><B>Returns:</B><DD>new position, if negative, parse failed. Apply complement
operator (~) to get position of failure
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if any field is out of range</DL>
</DD>
</DL>
<HR>
<A NAME="parsePeriod(java.lang.String)"><!-- --></A><H3>
parsePeriod</H3>
<PRE>
public <A HREF="../../../../org/joda/time/Period.html" title="class in org.joda.time">Period</A> <B>parsePeriod</B>(java.lang.String text)</PRE>
<DL>
<DD>Parses a period from the given text, returning a new Period.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>text</CODE> - text to parse
<DT><B>Returns:</B><DD>parsed value in a Period object
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if any field is out of range</DL>
</DD>
</DL>
<HR>
<A NAME="parseMutablePeriod(java.lang.String)"><!-- --></A><H3>
parseMutablePeriod</H3>
<PRE>
public <A HREF="../../../../org/joda/time/MutablePeriod.html" title="class in org.joda.time">MutablePeriod</A> <B>parseMutablePeriod</B>(java.lang.String text)</PRE>
<DL>
<DD>Parses a period from the given text, returning a new MutablePeriod.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>text</CODE> - text to parse
<DT><B>Returns:</B><DD>parsed value in a MutablePeriod object
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if any field is out of range</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/PeriodFormatter.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/format/PeriodFormat.html" title="class in org.joda.time.format"><B>PREV CLASS</B></A>
<A HREF="../../../../org/joda/time/format/PeriodFormatterBuilder.html" title="class in org.joda.time.format"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/joda/time/format/PeriodFormatter.html" target="_top"><B>FRAMES</B></A>
<A HREF="PeriodFormatter.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>
|