/usr/share/doc/libbackport-util-concurrent-java/api/edu/emory/mathcs/backport/java/util/concurrent/helpers/Utils.html is in libbackport-util-concurrent-java-doc 3.1-3build1.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Fri May 18 11:21:08 UTC 2012 -->
<title>Utils</title>
<meta name="date" content="2012-05-18">
<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="Utils";
}
//-->
</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="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="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/helpers/ThreadHelpers.UncaughtExceptionHandler.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent.helpers"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/helpers/WaitQueue.html" title="class in edu.emory.mathcs.backport.java.util.concurrent.helpers"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?edu/emory/mathcs/backport/java/util/concurrent/helpers/Utils.html" target="_top">Frames</a></li>
<li><a href="Utils.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">edu.emory.mathcs.backport.java.util.concurrent.helpers</div>
<h2 title="Class Utils" class="title">Class Utils</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>edu.emory.mathcs.backport.java.util.concurrent.helpers.Utils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="strong">Utils</span>
extends java.lang.Object</pre>
<div class="block"><p>
This class groups together the functionality of java.util.concurrent that
cannot be fully and reliably implemented in backport, but for which some
form of emulation is possible.
<p>
Currently, this class contains methods related to nanosecond-precision
timing, particularly via the <a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/helpers/Utils.html#nanoTime()"><code>nanoTime()</code></a> method. To measure time
accurately, this method by default uses <code>java.sun.Perf</code> on
JDK1.4.2 and it falls back to <code>System.currentTimeMillis</code>
on earlier JDKs.</div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>1.0</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Dawid Kurzyniec</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>static long</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/helpers/Utils.html#awaitNanos(edu.emory.mathcs.backport.java.util.concurrent.locks.Condition, long)">awaitNanos</a></strong>(<a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Condition.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent.locks">Condition</a> cond,
long nanosTimeout)</code>
<div class="block">Causes the current thread to wait until it is signalled or interrupted,
or the specified waiting time elapses.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.Object[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/helpers/Utils.html#collectionToArray(java.util.Collection)">collectionToArray</a></strong>(java.util.Collection c)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.Object[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/helpers/Utils.html#collectionToArray(java.util.Collection, java.lang.Object[])">collectionToArray</a></strong>(java.util.Collection c,
java.lang.Object[] a)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/helpers/Utils.html#nanoTime()">nanoTime</a></strong>()</code>
<div class="block">Returns the current value of the most precise available system timer,
in nanoseconds.</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.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="nanoTime()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nanoTime</h4>
<pre>public static long nanoTime()</pre>
<div class="block">Returns the current value of the most precise available system timer,
in nanoseconds. This method can only be used to measure elapsed time and
is not related to any other notion of system or wall-clock time. The
value returned represents nanoseconds since some fixed but arbitrary
time (perhaps in the future, so values may be negative). This method
provides nanosecond precision, but not necessarily nanosecond accuracy.
No guarantees are made about how frequently values change. Differences
in successive calls that span greater than approximately 292 years
(2^63 nanoseconds) will not accurately compute elapsed time due to
numerical overflow.
<p>
<em>Implementation note:</em>By default, this method uses
<code>sun.misc.Perf</code> on Java 1.4.2, and falls back to
System.currentTimeMillis() emulation on earlier JDKs. Custom
timer can be provided via the system property
<code>edu.emory.mathcs.backport.java.util.concurrent.NanoTimerProvider</code>.
The value of the property should name a class implementing
<a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/helpers/NanoTimer.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent.helpers"><code>NanoTimer</code></a> interface.
<p>
Note: on JDK 1.4.2, <code>sun.misc.Perf</code> timer seems to have
resolution of the order of 1 microsecond, measured on Linux.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The current value of the system timer, in nanoseconds.</dd></dl>
</li>
</ul>
<a name="awaitNanos(edu.emory.mathcs.backport.java.util.concurrent.locks.Condition, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>awaitNanos</h4>
<pre>public static long awaitNanos(<a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Condition.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent.locks">Condition</a> cond,
long nanosTimeout)
throws java.lang.InterruptedException</pre>
<div class="block">Causes the current thread to wait until it is signalled or interrupted,
or the specified waiting time elapses. This method originally appears
in the <a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Condition.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent.locks"><code>Condition</code></a> interface, but it was moved to here since it
can only be emulated, with very little accuracy guarantees: the
efficient implementation requires accurate nanosecond timer and native
support for nanosecond-precision wait queues, which are not usually
present in JVMs prior to 1.5. Loss of precision may cause total waiting
times to be systematically shorter than specified when re-waits occur.
<p>The lock associated with this condition is atomically
released and the current thread becomes disabled for thread scheduling
purposes and lies dormant until <em>one</em> of five things happens:
<ul>
<li>Some other thread invokes the <a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Condition.html#signal()"><code>Condition.signal()</code></a>
method for this
<tt>Condition</tt> and the current thread happens to be chosen as the
thread to be awakened; or
<li>Some other thread invokes the <a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Condition.html#signalAll()"><code>Condition.signalAll()</code></a>
method for this
<tt>Condition</tt>; or
<li>Some other thread <code>interrupts</code> the current
thread, and interruption of thread suspension is supported; or
<li>The specified waiting time elapses; or
<li>A "<em>spurious wakeup</em>" occurs.
</ul>
<p>In all cases, before this method can return the current thread must
re-acquire the lock associated with this condition. When the
thread returns it is <em>guaranteed</em> to hold this lock.
<p>If the current thread:
<ul>
<li>has its interrupted status set on entry to this method; or
<li>is <code>interrupted</code> while waiting
and interruption of thread suspension is supported,
</ul>
then <code>InterruptedException</code> is thrown and the current thread's
interrupted status is cleared. It is not specified, in the first
case, whether or not the test for interruption occurs before the lock
is released.
<p>The method returns an estimate of the number of nanoseconds
remaining to wait given the supplied <tt>nanosTimeout</tt>
value upon return, or a value less than or equal to zero if it
timed out. Accuracy of this estimate is directly dependent on the
accuracy of <a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/helpers/Utils.html#nanoTime()"><code>nanoTime()</code></a>. This value can be used to determine
whether and how long to re-wait in cases where the wait returns but an
awaited condition still does not hold. Typical uses of this method take
the following form:
<pre>
synchronized boolean aMethod(long timeout, TimeUnit unit) {
long nanosTimeout = unit.toNanos(timeout);
while (!conditionBeingWaitedFor) {
if (nanosTimeout > 0)
nanosTimeout = theCondition.awaitNanos(nanosTimeout);
else
return false;
}
// ...
}
</pre>
<p><b>Implementation Considerations</b>
<p>The current thread is assumed to hold the lock associated with this
<tt>Condition</tt> when this method is called.
It is up to the implementation to determine if this is
the case and if not, how to respond. Typically, an exception will be
thrown (such as <code>IllegalMonitorStateException</code>) and the
implementation must document that fact.
<p>A condition implementation can favor responding to an interrupt over
normal method return in response to a signal, or over indicating the
elapse of the specified waiting time. In either case the implementation
must ensure that the signal is redirected to another waiting thread, if
there is one.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cond</code> - the condition to wait for</dd><dd><code>nanosTimeout</code> - the maximum time to wait, in nanoseconds</dd>
<dt><span class="strong">Returns:</span></dt><dd>A value less than or equal to zero if the wait has
timed out; otherwise an estimate, that
is strictly less than the <tt>nanosTimeout</tt> argument,
of the time still remaining when this method returned.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code> - if the current thread is interrupted (and
interruption of thread suspension is supported).</dd></dl>
</li>
</ul>
<a name="collectionToArray(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>collectionToArray</h4>
<pre>public static java.lang.Object[] collectionToArray(java.util.Collection c)</pre>
</li>
</ul>
<a name="collectionToArray(java.util.Collection, java.lang.Object[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>collectionToArray</h4>
<pre>public static java.lang.Object[] collectionToArray(java.util.Collection c,
java.lang.Object[] a)</pre>
</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="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="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/helpers/ThreadHelpers.UncaughtExceptionHandler.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent.helpers"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/helpers/WaitQueue.html" title="class in edu.emory.mathcs.backport.java.util.concurrent.helpers"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?edu/emory/mathcs/backport/java/util/concurrent/helpers/Utils.html" target="_top">Frames</a></li>
<li><a href="Utils.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 ======= -->
</body>
</html>
|