/usr/share/doc/libglazedlists-java-doc/api/ca/odell/glazedlists/util/concurrent/J2SE14ReadWriteLock.html is in libglazedlists-java-doc 1.9.0+dfsg-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 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<title>J2SE14ReadWriteLock (Glazed Lists)</title>
<meta name="date" content="2016-02-14">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="J2SE14ReadWriteLock (Glazed Lists)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/J2SE14ReadWriteLock.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>Prev Class</li>
<li><a href="../../../../../ca/odell/glazedlists/util/concurrent/J2SE14ReadWriteLock.ReadLock.html" title="class in ca.odell.glazedlists.util.concurrent"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?ca/odell/glazedlists/util/concurrent/J2SE14ReadWriteLock.html" target="_top">Frames</a></li>
<li><a href="J2SE14ReadWriteLock.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><a href="#nested.class.summary">Nested</a> | </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">ca.odell.glazedlists.util.concurrent</div>
<h2 title="Class J2SE14ReadWriteLock" class="title">Class J2SE14ReadWriteLock</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>ca.odell.glazedlists.util.concurrent.J2SE14ReadWriteLock</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../ca/odell/glazedlists/util/concurrent/ReadWriteLock.html" title="interface in ca.odell.glazedlists.util.concurrent">ReadWriteLock</a>, java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">J2SE14ReadWriteLock</span>
extends java.lang.Object
implements <a href="../../../../../ca/odell/glazedlists/util/concurrent/ReadWriteLock.html" title="interface in ca.odell.glazedlists.util.concurrent">ReadWriteLock</a>, java.io.Serializable</pre>
<div class="block">An implementation of <a href="../../../../../ca/odell/glazedlists/util/concurrent/LockFactory.html" title="interface in ca.odell.glazedlists.util.concurrent"><code>LockFactory</code></a> that has been derived from
<a href="http://dcl.mathcs.emory.edu/util/backport-util-concurrent/">backport-util-concurrent</a>.
<p>An implementation of <a href="../../../../../ca/odell/glazedlists/util/concurrent/ReadWriteLock.html" title="interface in ca.odell.glazedlists.util.concurrent"><code>ReadWriteLock</code></a> supporting similar
semantics to <code>java.util.concurrent.locks.ReentrantLock</code>.
<p>This class has the following properties:
<ul>
<li><b>Acquisition order</b>
<p>The order of entry
to the read and write lock is unspecified, subject to reentrancy
constraints. A nonfair lock that is continously contended may
indefinitely postpone one or more reader or writer threads, but
will normally have higher throughput than a fair lock.
<p>
DEPARTURE FROM java.util.concurrent: this implementation impose
a writer-preferrence and thus its acquisition order may be different
than in java.util.concurrent.
<li><b>Reentrancy</b>
<p>This lock allows both readers and writers to reacquire read or
write locks in the style of a <code>ReentrantLock</code>. Non-reentrant
readers are not allowed until all write locks held by the writing
thread have been released.
<p>Additionally, a writer can acquire the read lock, but not
vice-versa. Among other applications, reentrancy can be useful
when write locks are held during calls or callbacks to methods that
perform reads under read locks. If a reader tries to acquire the
write lock it will never succeed.
<li><b>Lock downgrading</b>
<p>Reentrancy also allows downgrading from the write lock to a read lock,
by acquiring the write lock, then the read lock and then releasing the
write lock. However, upgrading from a read lock to the write lock is
<b>not</b> possible.
<li><b>Interruption of lock acquisition</b>
<p>The read lock and write lock both support interruption during lock
acquisition.
<li><b><code>Condition</code> support</b>
<p>The write lock provides a <code>Condition</code> implementation that
behaves in the same way, with respect to the write lock, as the
<code>Condition</code> implementation provided by
<code>ReentrantLock#newCondition</code> does for <code>ReentrantLock</code>.
This <code>Condition</code> can, of course, only be used with the write lock.
<p>The read lock does not support a <code>Condition</code> and
<code>readLock().newCondition()</code> throws
<code>UnsupportedOperationException</code>.
<li><b>Instrumentation</b>
<p>This class supports methods to determine whether locks
are held or contended. These methods are designed for monitoring
system state, not for synchronization control.
</ul>
<p>Serialization of this class behaves in the same way as built-in
locks: a deserialized lock is in the unlocked state, regardless of
its state when serialized.
<p><b>Sample usages</b>. Here is a code sketch showing how to exploit
reentrancy to perform lock downgrading after updating a cache (exception
handling is elided for simplicity):
<pre>
class CachedData {
Object data;
volatile boolean cacheValid;
ReentrantReadWriteLock rwl = new ReentrantReadWriteLock();
void processCachedData() {
rwl.readLock().lock();
if (!cacheValid) {
// Must release read lock before acquiring write lock
rwl.readLock().unlock();
rwl.writeLock().lock();
// Recheck state because another thread might have acquired
// write lock and changed state before we did.
if (!cacheValid) {
data = ...
cacheValid = true;
}
// Downgrade by acquiring read lock before releasing write lock
rwl.readLock().lock();
rwl.writeLock().unlock(); // Unlock write, still hold read
}
use(data);
rwl.readLock().unlock();
}
}
</pre>
ReentrantReadWriteLocks can be used to improve concurrency in some
uses of some kinds of Collections. This is typically worthwhile
only when the collections are expected to be large, accessed by
more reader threads than writer threads, and entail operations with
overhead that outweighs synchronization overhead. For example, here
is a class using a TreeMap that is expected to be large and
concurrently accessed.
<pre><code>
class RWDictionary {
private final Map<String, Data> m = new TreeMap<String, Data>();
private final ReentrantReadWriteLock rwl = new ReentrantReadWriteLock();
private final Lock r = rwl.readLock();
private final Lock w = rwl.writeLock();
public Data get(String key) {
r.lock();
try { return m.get(key); }
finally { r.unlock(); }
}
public String[] allKeys() {
r.lock();
try { return m.keySet().toArray(); }
finally { r.unlock(); }
}
public Data put(String key, Data value) {
w.lock();
try { return m.put(key, value); }
finally { w.unlock(); }
}
public void clear() {
w.lock();
try { m.clear(); }
finally { w.unlock(); }
}
}</code></pre>
<h3>Implementation Notes</h3>
<p>This lock supports a maximum of 65535 recursive write locks
and 65535 read locks. Attempts to exceed these limits result in
<code>Error</code> throws from locking methods.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.5</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Doug Lea</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#ca.odell.glazedlists.util.concurrent.J2SE14ReadWriteLock">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ca/odell/glazedlists/util/concurrent/J2SE14ReadWriteLock.ReadLock.html" title="class in ca.odell.glazedlists.util.concurrent">J2SE14ReadWriteLock.ReadLock</a></span></code>
<div class="block">The lock returned by method <a href="../../../../../ca/odell/glazedlists/util/concurrent/J2SE14ReadWriteLock.html#readLock--"><code>readLock()</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ca/odell/glazedlists/util/concurrent/J2SE14ReadWriteLock.WriteLock.html" title="class in ca.odell.glazedlists.util.concurrent">J2SE14ReadWriteLock.WriteLock</a></span></code>
<div class="block">The lock returned by method <a href="../../../../../ca/odell/glazedlists/util/concurrent/J2SE14ReadWriteLock.html#writeLock--"><code>writeLock()</code></a>.</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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../ca/odell/glazedlists/util/concurrent/J2SE14ReadWriteLock.html#J2SE14ReadWriteLock--">J2SE14ReadWriteLock</a></span>()</code>
<div class="block">Creates a new <code>ReentrantReadWriteLock</code> with
default (nonfair) ordering properties.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected java.lang.Thread</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ca/odell/glazedlists/util/concurrent/J2SE14ReadWriteLock.html#getOwner--">getOwner</a></span>()</code>
<div class="block">Returns the thread that currently owns the write lock, or
<code>null</code> if not owned.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ca/odell/glazedlists/util/concurrent/J2SE14ReadWriteLock.html#getQueueLength--">getQueueLength</a></span>()</code>
<div class="block">Returns an estimate of the number of threads waiting to acquire
either the read or write lock.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ca/odell/glazedlists/util/concurrent/J2SE14ReadWriteLock.html#getReadHoldCount--">getReadHoldCount</a></span>()</code>
<div class="block">Queries the number of reentrant read holds on this lock by the
current thread.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ca/odell/glazedlists/util/concurrent/J2SE14ReadWriteLock.html#getReadLockCount--">getReadLockCount</a></span>()</code>
<div class="block">Queries the number of read locks held for this lock.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ca/odell/glazedlists/util/concurrent/J2SE14ReadWriteLock.html#getWriteHoldCount--">getWriteHoldCount</a></span>()</code>
<div class="block">Queries the number of reentrant write holds on this lock by the
current thread.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ca/odell/glazedlists/util/concurrent/J2SE14ReadWriteLock.html#hasQueuedThreads--">hasQueuedThreads</a></span>()</code>
<div class="block">Queries whether any threads are waiting to acquire the read or
write lock.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ca/odell/glazedlists/util/concurrent/J2SE14ReadWriteLock.html#isFair--">isFair</a></span>()</code>
<div class="block">Returns <code>true</code> if this lock has fairness set true.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ca/odell/glazedlists/util/concurrent/J2SE14ReadWriteLock.html#isWriteLocked--">isWriteLocked</a></span>()</code>
<div class="block">Queries if the write lock is held by any thread.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ca/odell/glazedlists/util/concurrent/J2SE14ReadWriteLock.html#isWriteLockedByCurrentThread--">isWriteLockedByCurrentThread</a></span>()</code>
<div class="block">Queries if the write lock is held by the current thread.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../ca/odell/glazedlists/util/concurrent/Lock.html" title="interface in ca.odell.glazedlists.util.concurrent">Lock</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ca/odell/glazedlists/util/concurrent/J2SE14ReadWriteLock.html#readLock--">readLock</a></span>()</code>
<div class="block">Return the lock used for reading.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ca/odell/glazedlists/util/concurrent/J2SE14ReadWriteLock.html#toString--">toString</a></span>()</code>
<div class="block">Returns a string identifying this lock, as well as its lock state.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../ca/odell/glazedlists/util/concurrent/Lock.html" title="interface in ca.odell.glazedlists.util.concurrent">Lock</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ca/odell/glazedlists/util/concurrent/J2SE14ReadWriteLock.html#writeLock--">writeLock</a></span>()</code>
<div class="block">Return the lock used for writing.</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, 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="J2SE14ReadWriteLock--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>J2SE14ReadWriteLock</h4>
<pre>public J2SE14ReadWriteLock()</pre>
<div class="block">Creates a new <code>ReentrantReadWriteLock</code> with
default (nonfair) ordering properties.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="writeLock--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeLock</h4>
<pre>public <a href="../../../../../ca/odell/glazedlists/util/concurrent/Lock.html" title="interface in ca.odell.glazedlists.util.concurrent">Lock</a> writeLock()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../ca/odell/glazedlists/util/concurrent/ReadWriteLock.html#writeLock--">ReadWriteLock</a></code></span></div>
<div class="block">Return the lock used for writing.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../ca/odell/glazedlists/util/concurrent/ReadWriteLock.html#writeLock--">writeLock</a></code> in interface <code><a href="../../../../../ca/odell/glazedlists/util/concurrent/ReadWriteLock.html" title="interface in ca.odell.glazedlists.util.concurrent">ReadWriteLock</a></code></dd>
</dl>
</li>
</ul>
<a name="readLock--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readLock</h4>
<pre>public <a href="../../../../../ca/odell/glazedlists/util/concurrent/Lock.html" title="interface in ca.odell.glazedlists.util.concurrent">Lock</a> readLock()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../ca/odell/glazedlists/util/concurrent/ReadWriteLock.html#readLock--">ReadWriteLock</a></code></span></div>
<div class="block">Return the lock used for reading.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../ca/odell/glazedlists/util/concurrent/ReadWriteLock.html#readLock--">readLock</a></code> in interface <code><a href="../../../../../ca/odell/glazedlists/util/concurrent/ReadWriteLock.html" title="interface in ca.odell.glazedlists.util.concurrent">ReadWriteLock</a></code></dd>
</dl>
</li>
</ul>
<a name="isFair--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFair</h4>
<pre>public final boolean isFair()</pre>
<div class="block">Returns <code>true</code> if this lock has fairness set true.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this lock has fairness set true</dd>
</dl>
</li>
</ul>
<a name="getOwner--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOwner</h4>
<pre>protected java.lang.Thread getOwner()</pre>
<div class="block">Returns the thread that currently owns the write lock, or
<code>null</code> if not owned. When this method is called by a
thread that is not the owner, the return value reflects a
best-effort approximation of current lock status. For example,
the owner may be momentarily <code>null</code> even if there are
threads trying to acquire the lock but have not yet done so.
This method is designed to facilitate construction of
subclasses that provide more extensive lock monitoring
facilities.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the owner, or <code>null</code> if not owned</dd>
</dl>
</li>
</ul>
<a name="getReadLockCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReadLockCount</h4>
<pre>public int getReadLockCount()</pre>
<div class="block">Queries the number of read locks held for this lock. This
method is designed for use in monitoring system state, not for
synchronization control.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of read locks held.</dd>
</dl>
</li>
</ul>
<a name="isWriteLocked--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isWriteLocked</h4>
<pre>public boolean isWriteLocked()</pre>
<div class="block">Queries if the write lock is held by any thread. This method is
designed for use in monitoring system state, not for
synchronization control.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if any thread holds the write lock and
<code>false</code> otherwise</dd>
</dl>
</li>
</ul>
<a name="isWriteLockedByCurrentThread--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isWriteLockedByCurrentThread</h4>
<pre>public boolean isWriteLockedByCurrentThread()</pre>
<div class="block">Queries if the write lock is held by the current thread.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the current thread holds the write lock and
<code>false</code> otherwise</dd>
</dl>
</li>
</ul>
<a name="getWriteHoldCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteHoldCount</h4>
<pre>public int getWriteHoldCount()</pre>
<div class="block">Queries the number of reentrant write holds on this lock by the
current thread. A writer thread has a hold on a lock for
each lock action that is not matched by an unlock action.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of holds on the write lock by the current thread,
or zero if the write lock is not held by the current thread</dd>
</dl>
</li>
</ul>
<a name="getReadHoldCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReadHoldCount</h4>
<pre>public int getReadHoldCount()</pre>
<div class="block">Queries the number of reentrant read holds on this lock by the
current thread. A reader thread has a hold on a lock for
each lock action that is not matched by an unlock action.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of holds on the read lock by the current thread,
or zero if the read lock is not held by the current thread</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6</dd>
</dl>
</li>
</ul>
<a name="hasQueuedThreads--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasQueuedThreads</h4>
<pre>public final boolean hasQueuedThreads()</pre>
<div class="block">Queries whether any threads are waiting to acquire the read or
write lock. Note that because cancellations may occur at any
time, a <code>true</code> return does not guarantee that any other
thread will ever acquire a lock. This method is designed
primarily for use in monitoring of the system state.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if there may be other threads waiting to
acquire the lock</dd>
</dl>
</li>
</ul>
<a name="getQueueLength--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueueLength</h4>
<pre>public final int getQueueLength()</pre>
<div class="block">Returns an estimate of the number of threads waiting to acquire
either the read or write lock. The value is only an estimate
because the number of threads may change dynamically while this
method traverses internal data structures. This method is
designed for use in monitoring of the system state, not for
synchronization control.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the estimated number of threads waiting for this lock</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<div class="block">Returns a string identifying this lock, as well as its lock state.
The state, in brackets, includes the String <code>"Write locks ="</code>
followed by the number of reentrantly held write locks, and the
String <code>"Read locks ="</code> followed by the number of held
read locks.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string identifying this lock, as well as its lock state</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/J2SE14ReadWriteLock.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>Prev Class</li>
<li><a href="../../../../../ca/odell/glazedlists/util/concurrent/J2SE14ReadWriteLock.ReadLock.html" title="class in ca.odell.glazedlists.util.concurrent"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?ca/odell/glazedlists/util/concurrent/J2SE14ReadWriteLock.html" target="_top">Frames</a></li>
<li><a href="J2SE14ReadWriteLock.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><a href="#nested.class.summary">Nested</a> | </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 ======= -->
<p class="legalCopy"><small><a href="http://www.glazedlists.com" target="_top">Glazed Lists</a>, Copyright © 2003 publicobject.com, O'Dell Engineering.<br>Documentation build by buildd at 2016-02-14 5:12</small></p>
</body>
</html>
|