/usr/share/doc/libjoda-time-java/api/org/joda/time/ReadableDuration.html is in libjoda-time-java-doc 2.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 | <!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>ReadableDuration (Joda-Time 2.3 API)</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ReadableDuration (Joda-Time 2.3 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ReadableDuration.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/joda/time/ReadableDateTime.html" title="interface in org.joda.time"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/joda/time/ReadableDuration.html" target="_top">Frames</a></li>
<li><a href="ReadableDuration.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.joda.time</div>
<h2 title="Interface ReadableDuration" class="title">Interface ReadableDuration</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>java.lang.Comparable<<a href="../../../org/joda/time/ReadableDuration.html" title="interface in org.joda.time">ReadableDuration</a>></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../org/joda/time/base/AbstractDuration.html" title="class in org.joda.time.base">AbstractDuration</a>, <a href="../../../org/joda/time/base/BaseDuration.html" title="class in org.joda.time.base">BaseDuration</a>, <a href="../../../org/joda/time/Duration.html" title="class in org.joda.time">Duration</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ReadableDuration</span>
extends java.lang.Comparable<<a href="../../../org/joda/time/ReadableDuration.html" title="interface in org.joda.time">ReadableDuration</a>></pre>
<div class="block">Defines an exact duration of time in milliseconds.
<p>
The implementation of this interface may be mutable or immutable. This
interface only gives access to retrieve data, never to change it.
<p>
Methods that are passed a duration as a parameter will treat <code>null</code>
as a zero length duration.
<p>
The <code>compareTo</code> method is no longer defined in this class in version 2.0.
Instead, the definition is simply inherited from the <code>Comparable</code> interface.
This approach is necessary to preserve binary compatibility.
The definition of the comparison is ascending order by millisecond duration.
Implementors are recommended to extend <code>AbstractInstant</code> instead of this interface.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.0</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/joda/time/ReadableInterval.html" title="interface in org.joda.time"><code>ReadableInterval</code></a>,
<a href="../../../org/joda/time/ReadablePeriod.html" title="interface in org.joda.time"><code>ReadablePeriod</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/ReadableDuration.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object readableDuration)</code>
<div class="block">Compares this object with the specified object for equality based
on the millisecond length.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/ReadableDuration.html#getMillis()">getMillis</a></strong>()</code>
<div class="block">Gets the total length of this duration in milliseconds.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/ReadableDuration.html#hashCode()">hashCode</a></strong>()</code>
<div class="block">Gets a hash code for the duration that is compatable with the
equals method.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/ReadableDuration.html#isEqual(org.joda.time.ReadableDuration)">isEqual</a></strong>(<a href="../../../org/joda/time/ReadableDuration.html" title="interface in org.joda.time">ReadableDuration</a> duration)</code>
<div class="block">Is the length of this duration equal to the duration passed in.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/ReadableDuration.html#isLongerThan(org.joda.time.ReadableDuration)">isLongerThan</a></strong>(<a href="../../../org/joda/time/ReadableDuration.html" title="interface in org.joda.time">ReadableDuration</a> duration)</code>
<div class="block">Is the length of this duration longer than the duration passed in.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/ReadableDuration.html#isShorterThan(org.joda.time.ReadableDuration)">isShorterThan</a></strong>(<a href="../../../org/joda/time/ReadableDuration.html" title="interface in org.joda.time">ReadableDuration</a> duration)</code>
<div class="block">Is the length of this duration shorter than the duration passed in.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/joda/time/Duration.html" title="class in org.joda.time">Duration</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/ReadableDuration.html#toDuration()">toDuration</a></strong>()</code>
<div class="block">Get this duration as an immutable <code>Duration</code> object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/joda/time/Period.html" title="class in org.joda.time">Period</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/ReadableDuration.html#toPeriod()">toPeriod</a></strong>()</code>
<div class="block">Converts this duration to a Period instance using the standard period type
and the ISO chronology.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/joda/time/ReadableDuration.html#toString()">toString</a></strong>()</code>
<div class="block">Gets the value as a String in the ISO8601 duration format using hours,
minutes and seconds (including fractional milliseconds).</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Comparable">
<!-- -->
</a>
<h3>Methods inherited from interface java.lang.Comparable</h3>
<code>compareTo</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getMillis()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMillis</h4>
<pre>long getMillis()</pre>
<div class="block">Gets the total length of this duration in milliseconds.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the total length of the time duration in milliseconds.</dd></dl>
</li>
</ul>
<a name="toDuration()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toDuration</h4>
<pre><a href="../../../org/joda/time/Duration.html" title="class in org.joda.time">Duration</a> toDuration()</pre>
<div class="block">Get this duration as an immutable <code>Duration</code> object.
<p>
This will either typecast this instance, or create a new <code>Duration</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a Duration created using the millisecond duration from this instance</dd></dl>
</li>
</ul>
<a name="toPeriod()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toPeriod</h4>
<pre><a href="../../../org/joda/time/Period.html" title="class in org.joda.time">Period</a> toPeriod()</pre>
<div class="block">Converts this duration to a Period instance using the standard period type
and the ISO chronology.
<p>
Only precise fields in the period type will be used. Thus, only the hour,
minute, second and millisecond fields on the period will be used.
The year, month, week and day fields will not be populated.
<p>
If the duration is small, less than one day, then this method will perform
as you might expect and split the fields evenly.
If the duration is larger than one day then all the remaining duration will
be stored in the largest available field, hours in this case.
<p>
For example, a duration effectively equal to (365 + 60 + 5) days will be
converted to ((365 + 60 + 5) * 24) hours by this constructor.
<p>
For more control over the conversion process, you must pair the duration with
an instant, see <a href="../../../org/joda/time/Period.html#Period(org.joda.time.ReadableInstant, org.joda.time.ReadableDuration)"><code>Period.Period(ReadableInstant,ReadableDuration)</code></a>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a Period created using the millisecond duration from this instance</dd></dl>
</li>
</ul>
<a name="isEqual(org.joda.time.ReadableDuration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEqual</h4>
<pre>boolean isEqual(<a href="../../../org/joda/time/ReadableDuration.html" title="interface in org.joda.time">ReadableDuration</a> duration)</pre>
<div class="block">Is the length of this duration equal to the duration passed in.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>duration</code> - another duration to compare to, null means zero milliseconds</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if this duration is equal to than the duration passed in</dd></dl>
</li>
</ul>
<a name="isLongerThan(org.joda.time.ReadableDuration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLongerThan</h4>
<pre>boolean isLongerThan(<a href="../../../org/joda/time/ReadableDuration.html" title="interface in org.joda.time">ReadableDuration</a> duration)</pre>
<div class="block">Is the length of this duration longer than the duration passed in.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>duration</code> - another duration to compare to, null means zero milliseconds</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if this duration is equal to than the duration passed in</dd></dl>
</li>
</ul>
<a name="isShorterThan(org.joda.time.ReadableDuration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isShorterThan</h4>
<pre>boolean isShorterThan(<a href="../../../org/joda/time/ReadableDuration.html" title="interface in org.joda.time">ReadableDuration</a> duration)</pre>
<div class="block">Is the length of this duration shorter than the duration passed in.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>duration</code> - another duration to compare to, null means zero milliseconds</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if this duration is equal to than the duration passed in</dd></dl>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>boolean equals(java.lang.Object readableDuration)</pre>
<div class="block">Compares this object with the specified object for equality based
on the millisecond length. All ReadableDuration instances are accepted.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>readableDuration</code> - a readable duration to check against</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the length of the duration is equal</dd></dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>int hashCode()</pre>
<div class="block">Gets a hash code for the duration that is compatable with the
equals method.
The following formula must be used:
<pre>
long len = getMillis();
return (int) (len ^ (len >>> 32));
</pre></div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a hash code</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>java.lang.String toString()</pre>
<div class="block">Gets the value as a String in the ISO8601 duration format using hours,
minutes and seconds (including fractional milliseconds).
<p>
For example, "PT6H3M7S" represents 6 hours, 3 minutes, 7 seconds.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the value as an ISO8601 string</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/ReadableDuration.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/joda/time/ReadableDateTime.html" title="interface in org.joda.time"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/joda/time/ReadableInstant.html" title="interface in org.joda.time"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/joda/time/ReadableDuration.html" target="_top">Frames</a></li>
<li><a href="ReadableDuration.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2002-2013 <a href="http://www.joda.org">Joda.org</a>. All Rights Reserved.</small></p>
</body>
</html>
|