/usr/share/doc/libbackport-util-concurrent-java/api/edu/emory/mathcs/backport/java/util/concurrent/atomic/AtomicMarkableReference.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 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>
<!-- Generated by javadoc (version 1.7.0_03) on Fri May 18 11:21:08 UTC 2012 -->
<title>AtomicMarkableReference</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="AtomicMarkableReference";
}
//-->
</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/atomic/AtomicLongArray.html" title="class in edu.emory.mathcs.backport.java.util.concurrent.atomic"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/atomic/AtomicReference.html" title="class in edu.emory.mathcs.backport.java.util.concurrent.atomic"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?edu/emory/mathcs/backport/java/util/concurrent/atomic/AtomicMarkableReference.html" target="_top">Frames</a></li>
<li><a href="AtomicMarkableReference.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><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </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">edu.emory.mathcs.backport.java.util.concurrent.atomic</div>
<h2 title="Class AtomicMarkableReference" class="title">Class AtomicMarkableReference</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.atomic.AtomicMarkableReference</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">AtomicMarkableReference</span>
extends java.lang.Object</pre>
<div class="block">An <code>AtomicMarkableReference</code> maintains an object reference
along with a mark bit, that can be updated atomically.
<p>
<p> Implementation note. This implementation maintains markable
references by creating internal objects representing "boxed"
[reference, boolean] pairs.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.5</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Doug Lea</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/atomic/AtomicMarkableReference.html#AtomicMarkableReference(java.lang.Object, boolean)">AtomicMarkableReference</a></strong>(java.lang.Object initialRef,
boolean initialMark)</code>
<div class="block">Creates a new <code>AtomicMarkableReference</code> with the given
initial values.</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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/atomic/AtomicMarkableReference.html#attemptMark(java.lang.Object, boolean)">attemptMark</a></strong>(java.lang.Object expectedReference,
boolean newMark)</code>
<div class="block">Atomically sets the value of the mark to the given update value
if the current reference is <code>==</code> to the expected
reference.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/atomic/AtomicMarkableReference.html#compareAndSet(java.lang.Object, java.lang.Object, boolean, boolean)">compareAndSet</a></strong>(java.lang.Object expectedReference,
java.lang.Object newReference,
boolean expectedMark,
boolean newMark)</code>
<div class="block">Atomically sets the value of both the reference and mark
to the given update values if the
current reference is <code>==</code> to the expected reference
and the current mark is equal to the expected mark.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/atomic/AtomicMarkableReference.html#get(boolean[])">get</a></strong>(boolean[] markHolder)</code>
<div class="block">Returns the current values of both the reference and the mark.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/atomic/AtomicMarkableReference.html#getReference()">getReference</a></strong>()</code>
<div class="block">Returns the current value of the reference.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/atomic/AtomicMarkableReference.html#isMarked()">isMarked</a></strong>()</code>
<div class="block">Returns the current value of the mark.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/atomic/AtomicMarkableReference.html#set(java.lang.Object, boolean)">set</a></strong>(java.lang.Object newReference,
boolean newMark)</code>
<div class="block">Unconditionally sets the value of both the reference and mark.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/atomic/AtomicMarkableReference.html#weakCompareAndSet(java.lang.Object, java.lang.Object, boolean, boolean)">weakCompareAndSet</a></strong>(java.lang.Object expectedReference,
java.lang.Object newReference,
boolean expectedMark,
boolean newMark)</code>
<div class="block">Atomically sets the value of both the reference and mark
to the given update values if the
current reference is <code>==</code> to the expected reference
and the current mark is equal to the expected mark.</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AtomicMarkableReference(java.lang.Object, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AtomicMarkableReference</h4>
<pre>public AtomicMarkableReference(java.lang.Object initialRef,
boolean initialMark)</pre>
<div class="block">Creates a new <code>AtomicMarkableReference</code> with the given
initial values.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>initialRef</code> - the initial reference</dd><dd><code>initialMark</code> - the initial mark</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getReference()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReference</h4>
<pre>public java.lang.Object getReference()</pre>
<div class="block">Returns the current value of the reference.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the current value of the reference</dd></dl>
</li>
</ul>
<a name="isMarked()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMarked</h4>
<pre>public boolean isMarked()</pre>
<div class="block">Returns the current value of the mark.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the current value of the mark</dd></dl>
</li>
</ul>
<a name="get(boolean[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public java.lang.Object get(boolean[] markHolder)</pre>
<div class="block">Returns the current values of both the reference and the mark.
Typical usage is <code>boolean[1] holder; ref = v.get(holder); </code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>markHolder</code> - an array of size of at least one. On return,
<code>markholder[0]</code> will hold the value of the mark.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the current value of the reference</dd></dl>
</li>
</ul>
<a name="weakCompareAndSet(java.lang.Object, java.lang.Object, boolean, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>weakCompareAndSet</h4>
<pre>public boolean weakCompareAndSet(java.lang.Object expectedReference,
java.lang.Object newReference,
boolean expectedMark,
boolean newMark)</pre>
<div class="block">Atomically sets the value of both the reference and mark
to the given update values if the
current reference is <code>==</code> to the expected reference
and the current mark is equal to the expected mark.
<p>May <a href="package-summary.html#Spurious">fail spuriously</a>
and does not provide ordering guarantees, so is only rarely an
appropriate alternative to <code>compareAndSet</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>expectedReference</code> - the expected value of the reference</dd><dd><code>newReference</code> - the new value for the reference</dd><dd><code>expectedMark</code> - the expected value of the mark</dd><dd><code>newMark</code> - the new value for the mark</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if successful</dd></dl>
</li>
</ul>
<a name="compareAndSet(java.lang.Object, java.lang.Object, boolean, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareAndSet</h4>
<pre>public boolean compareAndSet(java.lang.Object expectedReference,
java.lang.Object newReference,
boolean expectedMark,
boolean newMark)</pre>
<div class="block">Atomically sets the value of both the reference and mark
to the given update values if the
current reference is <code>==</code> to the expected reference
and the current mark is equal to the expected mark.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>expectedReference</code> - the expected value of the reference</dd><dd><code>newReference</code> - the new value for the reference</dd><dd><code>expectedMark</code> - the expected value of the mark</dd><dd><code>newMark</code> - the new value for the mark</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if successful</dd></dl>
</li>
</ul>
<a name="set(java.lang.Object, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>set</h4>
<pre>public void set(java.lang.Object newReference,
boolean newMark)</pre>
<div class="block">Unconditionally sets the value of both the reference and mark.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newReference</code> - the new value for the reference</dd><dd><code>newMark</code> - the new value for the mark</dd></dl>
</li>
</ul>
<a name="attemptMark(java.lang.Object, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>attemptMark</h4>
<pre>public boolean attemptMark(java.lang.Object expectedReference,
boolean newMark)</pre>
<div class="block">Atomically sets the value of the mark to the given update value
if the current reference is <code>==</code> to the expected
reference. Any given invocation of this operation may fail
(return <code>false</code>) spuriously, but repeated invocation
when the current value holds the expected value and no other
thread is also attempting to set the value will eventually
succeed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>expectedReference</code> - the expected value of the reference</dd><dd><code>newMark</code> - the new value for the mark</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if successful</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="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/atomic/AtomicLongArray.html" title="class in edu.emory.mathcs.backport.java.util.concurrent.atomic"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/atomic/AtomicReference.html" title="class in edu.emory.mathcs.backport.java.util.concurrent.atomic"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?edu/emory/mathcs/backport/java/util/concurrent/atomic/AtomicMarkableReference.html" target="_top">Frames</a></li>
<li><a href="AtomicMarkableReference.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><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </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 ======= -->
</body>
</html>
|