/usr/share/doc/libcommons-lang3-java/api/org/apache/commons/lang3/time/DurationFormatUtils.html is in libcommons-lang3-java-doc 3.4-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>DurationFormatUtils (Apache Commons Lang 3.4 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DurationFormatUtils (Apache Commons Lang 3.4 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DurationFormatUtils.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/commons/lang3/time/DateUtils.html" title="class in org.apache.commons.lang3.time"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/commons/lang3/time/FastDateFormat.html" title="class in org.apache.commons.lang3.time"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/lang3/time/DurationFormatUtils.html" target="_top">Frames</a></li>
<li><a href="DurationFormatUtils.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.commons.lang3.time</div>
<h2 title="Class DurationFormatUtils" class="title">Class DurationFormatUtils</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.commons.lang3.time.DurationFormatUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">DurationFormatUtils</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block"><p>Duration formatting utilities and constants. The following table describes the tokens
used in the pattern language for formatting. </p>
<table border="1" summary="Pattern Tokens">
<tr><th>character</th><th>duration element</th></tr>
<tr><td>y</td><td>years</td></tr>
<tr><td>M</td><td>months</td></tr>
<tr><td>d</td><td>days</td></tr>
<tr><td>H</td><td>hours</td></tr>
<tr><td>m</td><td>minutes</td></tr>
<tr><td>s</td><td>seconds</td></tr>
<tr><td>S</td><td>milliseconds</td></tr>
<tr><td>'text'</td><td>arbitrary text content</td></tr>
</table>
<b>Note: It's not currently possible to include a single-quote in a format.</b>
<br>
Token values are printed using decimal digits.
A token character can be repeated to ensure that the field occupies a certain minimum
size. Values will be left-padded with 0 unless padding is disabled in the method invocation.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>2.1</dd>
<dt><span class="strong">Version:</span></dt>
<dd>$Id: DurationFormatUtils.java 1606051 2014-06-27 12:22:17Z ggregory $</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/time/DurationFormatUtils.html#ISO_EXTENDED_FORMAT_PATTERN">ISO_EXTENDED_FORMAT_PATTERN</a></strong></code>
<div class="block">Pattern used with <code>FastDateFormat</code> and <code>SimpleDateFormat</code>
for the ISO 8601 period format used in durations.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/lang3/time/DurationFormatUtils.html#DurationFormatUtils()">DurationFormatUtils</a></strong>()</code>
<div class="block">DurationFormatUtils instances should NOT be constructed in standard programming.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/time/DurationFormatUtils.html#formatDuration(long,%20java.lang.String)">formatDuration</a></strong>(long durationMillis,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> format)</code>
<div class="block">Formats the time gap as a string, using the specified format, and padding with zeros.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/time/DurationFormatUtils.html#formatDuration(long,%20java.lang.String,%20boolean)">formatDuration</a></strong>(long durationMillis,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> format,
boolean padWithZeros)</code>
<div class="block">Formats the time gap as a string, using the specified format.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/time/DurationFormatUtils.html#formatDurationHMS(long)">formatDurationHMS</a></strong>(long durationMillis)</code>
<div class="block">Formats the time gap as a string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/time/DurationFormatUtils.html#formatDurationISO(long)">formatDurationISO</a></strong>(long durationMillis)</code>
<div class="block">Formats the time gap as a string.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/time/DurationFormatUtils.html#formatDurationWords(long,%20boolean,%20boolean)">formatDurationWords</a></strong>(long durationMillis,
boolean suppressLeadingZeroElements,
boolean suppressTrailingZeroElements)</code>
<div class="block">Formats an elapsed time into a plurialization correct string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/time/DurationFormatUtils.html#formatPeriod(long,%20long,%20java.lang.String)">formatPeriod</a></strong>(long startMillis,
long endMillis,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> format)</code>
<div class="block">Formats the time gap as a string, using the specified format.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/time/DurationFormatUtils.html#formatPeriod(long,%20long,%20java.lang.String,%20boolean,%20java.util.TimeZone)">formatPeriod</a></strong>(long startMillis,
long endMillis,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> format,
boolean padWithZeros,
<a href="http://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html?is-external=true" title="class or interface in java.util">TimeZone</a> timezone)</code>
<div class="block">Formats the time gap as a string, using the specified format.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/time/DurationFormatUtils.html#formatPeriodISO(long,%20long)">formatPeriodISO</a></strong>(long startMillis,
long endMillis)</code>
<div class="block">Formats the time gap as a string.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="ISO_EXTENDED_FORMAT_PATTERN">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ISO_EXTENDED_FORMAT_PATTERN</h4>
<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ISO_EXTENDED_FORMAT_PATTERN</pre>
<div class="block"><p>Pattern used with <code>FastDateFormat</code> and <code>SimpleDateFormat</code>
for the ISO 8601 period format used in durations.</p></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/lang3/time/FastDateFormat.html" title="class in org.apache.commons.lang3.time"><code>FastDateFormat</code></a>,
<a href="http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text"><code>SimpleDateFormat</code></a>,
<a href="../../../../../constant-values.html#org.apache.commons.lang3.time.DurationFormatUtils.ISO_EXTENDED_FORMAT_PATTERN">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DurationFormatUtils()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DurationFormatUtils</h4>
<pre>public DurationFormatUtils()</pre>
<div class="block"><p>DurationFormatUtils instances should NOT be constructed in standard programming.</p>
<p>This constructor is public to permit tools that require a JavaBean instance
to operate.</p></div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="formatDurationHMS(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>formatDurationHMS</h4>
<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> formatDurationHMS(long durationMillis)</pre>
<div class="block"><p>Formats the time gap as a string.</p>
<p>The format used is ISO 8601-like: <code>HH:mm:ss.SSS</code>.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>durationMillis</code> - the duration to format</dd>
<dt><span class="strong">Returns:</span></dt><dd>the formatted duration, not null</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if durationMillis is negative</dd></dl>
</li>
</ul>
<a name="formatDurationISO(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>formatDurationISO</h4>
<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> formatDurationISO(long durationMillis)</pre>
<div class="block"><p>Formats the time gap as a string.</p>
<p>The format used is the ISO 8601 period format.</p>
<p>This method formats durations using the days and lower fields of the
ISO format pattern, such as P7D6TH5M4.321S.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>durationMillis</code> - the duration to format</dd>
<dt><span class="strong">Returns:</span></dt><dd>the formatted duration, not null</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if durationMillis is negative</dd></dl>
</li>
</ul>
<a name="formatDuration(long, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>formatDuration</h4>
<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> formatDuration(long durationMillis,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> format)</pre>
<div class="block"><p>Formats the time gap as a string, using the specified format, and padding with zeros.</p>
<p>This method formats durations using the days and lower fields of the
format pattern. Months and larger are not used.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>durationMillis</code> - the duration to format</dd><dd><code>format</code> - the way in which to format the duration, not null</dd>
<dt><span class="strong">Returns:</span></dt><dd>the formatted duration, not null</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if durationMillis is negative</dd></dl>
</li>
</ul>
<a name="formatDuration(long, java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>formatDuration</h4>
<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> formatDuration(long durationMillis,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> format,
boolean padWithZeros)</pre>
<div class="block"><p>Formats the time gap as a string, using the specified format.
Padding the left hand side of numbers with zeroes is optional.</p>
<p>This method formats durations using the days and lower fields of the
format pattern. Months and larger are not used.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>durationMillis</code> - the duration to format</dd><dd><code>format</code> - the way in which to format the duration, not null</dd><dd><code>padWithZeros</code> - whether to pad the left hand side of numbers with 0's</dd>
<dt><span class="strong">Returns:</span></dt><dd>the formatted duration, not null</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if durationMillis is negative</dd></dl>
</li>
</ul>
<a name="formatDurationWords(long, boolean, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>formatDurationWords</h4>
<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> formatDurationWords(long durationMillis,
boolean suppressLeadingZeroElements,
boolean suppressTrailingZeroElements)</pre>
<div class="block"><p>Formats an elapsed time into a plurialization correct string.</p>
<p>This method formats durations using the days and lower fields of the
format pattern. Months and larger are not used.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>durationMillis</code> - the elapsed time to report in milliseconds</dd><dd><code>suppressLeadingZeroElements</code> - suppresses leading 0 elements</dd><dd><code>suppressTrailingZeroElements</code> - suppresses trailing 0 elements</dd>
<dt><span class="strong">Returns:</span></dt><dd>the formatted text in days/hours/minutes/seconds, not null</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if durationMillis is negative</dd></dl>
</li>
</ul>
<a name="formatPeriodISO(long, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>formatPeriodISO</h4>
<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> formatPeriodISO(long startMillis,
long endMillis)</pre>
<div class="block"><p>Formats the time gap as a string.</p>
<p>The format used is the ISO 8601 period format.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>startMillis</code> - the start of the duration to format</dd><dd><code>endMillis</code> - the end of the duration to format</dd>
<dt><span class="strong">Returns:</span></dt><dd>the formatted duration, not null</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if startMillis is greater than endMillis</dd></dl>
</li>
</ul>
<a name="formatPeriod(long, long, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>formatPeriod</h4>
<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> formatPeriod(long startMillis,
long endMillis,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> format)</pre>
<div class="block"><p>Formats the time gap as a string, using the specified format.
Padding the left hand side of numbers with zeroes is optional.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>startMillis</code> - the start of the duration</dd><dd><code>endMillis</code> - the end of the duration</dd><dd><code>format</code> - the way in which to format the duration, not null</dd>
<dt><span class="strong">Returns:</span></dt><dd>the formatted duration, not null</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if startMillis is greater than endMillis</dd></dl>
</li>
</ul>
<a name="formatPeriod(long, long, java.lang.String, boolean, java.util.TimeZone)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>formatPeriod</h4>
<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> formatPeriod(long startMillis,
long endMillis,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> format,
boolean padWithZeros,
<a href="http://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html?is-external=true" title="class or interface in java.util">TimeZone</a> timezone)</pre>
<div class="block"><p>Formats the time gap as a string, using the specified format.
Padding the left hand side of numbers with zeroes is optional and
the timezone may be specified. </p>
<p>When calculating the difference between months/days, it chooses to
calculate months first. So when working out the number of months and
days between January 15th and March 10th, it choose 1 month and
23 days gained by choosing January->February = 1 month and then
calculating days forwards, and not the 1 month and 26 days gained by
choosing March -> February = 1 month and then calculating days
backwards. </p>
<p>For more control, the <a href="http://joda-time.sf.net/">Joda-Time</a>
library is recommended.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>startMillis</code> - the start of the duration</dd><dd><code>endMillis</code> - the end of the duration</dd><dd><code>format</code> - the way in which to format the duration, not null</dd><dd><code>padWithZeros</code> - whether to pad the left hand side of numbers with 0's</dd><dd><code>timezone</code> - the millis are defined in</dd>
<dt><span class="strong">Returns:</span></dt><dd>the formatted duration, not null</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if startMillis is greater than endMillis</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DurationFormatUtils.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/commons/lang3/time/DateUtils.html" title="class in org.apache.commons.lang3.time"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/commons/lang3/time/FastDateFormat.html" title="class in org.apache.commons.lang3.time"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/lang3/time/DurationFormatUtils.html" target="_top">Frames</a></li>
<li><a href="DurationFormatUtils.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2001–2015. All rights reserved.</small></p>
</body>
</html>
|