This file is indexed.

/usr/share/doc/libbackport-util-concurrent-java/api/edu/emory/mathcs/backport/java/util/concurrent/locks/ReentrantLock.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
 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
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
<!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>ReentrantLock</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="ReentrantLock";
    }
//-->
</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/locks/ReadWriteLock.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent.locks"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/ReentrantReadWriteLock.html" title="class in edu.emory.mathcs.backport.java.util.concurrent.locks"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?edu/emory/mathcs/backport/java/util/concurrent/locks/ReentrantLock.html" target="_top">Frames</a></li>
<li><a href="ReentrantLock.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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.locks</div>
<h2 title="Class ReentrantLock" class="title">Class ReentrantLock</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.locks.ReentrantLock</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Lock.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent.locks">Lock</a>, java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">ReentrantLock</span>
extends java.lang.Object
implements <a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Lock.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent.locks">Lock</a>, java.io.Serializable</pre>
<div class="block">A reentrant mutual exclusion <a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Lock.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent.locks"><code>Lock</code></a> with the same basic
 behavior and semantics as the implicit monitor lock accessed using
 <code>synchronized</code> methods and statements, but with extended
 capabilities.

 <p>A <code>ReentrantLock</code> is <em>owned</em> by the thread last
 successfully locking, but not yet unlocking it. A thread invoking
 <code>lock</code> will return, successfully acquiring the lock, when
 the lock is not owned by another thread. The method will return
 immediately if the current thread already owns the lock. This can
 be checked using methods <a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/ReentrantLock.html#isHeldByCurrentThread()"><code>isHeldByCurrentThread()</code></a>, and <a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/ReentrantLock.html#getHoldCount()"><code>getHoldCount()</code></a>.

 <p>The constructor for this class accepts an optional
 <em>fairness</em> parameter.  When set <code>true</code>, under
 contention, locks favor granting access to the longest-waiting
 thread.  Otherwise this lock does not guarantee any particular
 access order.  Programs using fair locks accessed by many threads
 may display lower overall throughput (i.e., are slower; often much
 slower) than those using the default setting, but have smaller
 variances in times to obtain locks and guarantee lack of
 starvation. Note however, that fairness of locks does not guarantee
 fairness of thread scheduling. Thus, one of many threads using a
 fair lock may obtain it multiple times in succession while other
 active threads are not progressing and not currently holding the
 lock.
 Also note that the untimed <a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/ReentrantLock.html#tryLock()"><code>tryLock</code></a> method does not
 honor the fairness setting. It will succeed if the lock
 is available even if other threads are waiting.

 <p>It is recommended practice to <em>always</em> immediately
 follow a call to <code>lock</code> with a <code>try</code> block, most
 typically in a before/after construction such as:

 <pre>
 class X {
   private final ReentrantLock lock = new ReentrantLock();
   // ...

   public void m() {
     lock.lock();  // block until condition holds
     try {
       // ... method body
     } finally {
       lock.unlock()
     }
   }
 }
 </pre>

 <p>In addition to implementing the <a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Lock.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent.locks"><code>Lock</code></a> interface, this
 class defines methods <code>isLocked</code> and
 <code>getLockQueueLength</code>, as well as some associated
 <code>protected</code> access methods that may be useful for
 instrumentation and monitoring.

 <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>This lock supports a maximum of 2147483647 recursive locks by
 the same thread. Attempts to exceed this limit result in
 <code>Error</code> throws from locking methods.</div>
<dl><dt><span class="strong">Since:</span></dt>
  <dd>1.5</dd>
<dt><span class="strong">Author:</span></dt>
  <dd>Doug Lea, Dawid Kurzyniec</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../../serialized-form.html#edu.emory.mathcs.backport.java.util.concurrent.locks.ReentrantLock">Serialized Form</a></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">&nbsp;</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/locks/ReentrantLock.html#ReentrantLock()">ReentrantLock</a></strong>()</code>
<div class="block">Creates an instance of <code>ReentrantLock</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/ReentrantLock.html#ReentrantLock(boolean)">ReentrantLock</a></strong>(boolean&nbsp;fair)</code>
<div class="block">Creates an instance of <code>ReentrantLock</code> with the
 given fairness policy.</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">&nbsp;</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>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/ReentrantLock.html#getHoldCount()">getHoldCount</a></strong>()</code>
<div class="block">Queries the number of holds on this lock by the current thread.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.Thread</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/ReentrantLock.html#getOwner()">getOwner</a></strong>()</code>
<div class="block">Returns the thread that currently owns this lock, or
 <code>null</code> if not owned.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Collection</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/ReentrantLock.html#getQueuedThreads()">getQueuedThreads</a></strong>()</code>
<div class="block">Returns a collection containing threads that may be waiting to
 acquire this lock.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/ReentrantLock.html#getQueueLength()">getQueueLength</a></strong>()</code>
<div class="block">Returns an estimate of the number of threads waiting to
 acquire this lock.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Collection</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/ReentrantLock.html#getWaitingThreads(edu.emory.mathcs.backport.java.util.concurrent.locks.Condition)">getWaitingThreads</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>&nbsp;condition)</code>
<div class="block">Returns a collection containing those threads that may be
 waiting on the given condition associated with this lock.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/ReentrantLock.html#getWaitQueueLength(edu.emory.mathcs.backport.java.util.concurrent.locks.Condition)">getWaitQueueLength</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>&nbsp;condition)</code>
<div class="block">Returns an estimate of the number of threads waiting on the
 given condition associated with this lock.</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/locks/ReentrantLock.html#hasQueuedThread(java.lang.Thread)">hasQueuedThread</a></strong>(java.lang.Thread&nbsp;thread)</code>
<div class="block">Queries whether the given thread is waiting to acquire this
 lock.</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/locks/ReentrantLock.html#hasQueuedThreads()">hasQueuedThreads</a></strong>()</code>
<div class="block">Queries whether any threads are waiting to acquire this lock.</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/locks/ReentrantLock.html#hasWaiters(edu.emory.mathcs.backport.java.util.concurrent.locks.Condition)">hasWaiters</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>&nbsp;condition)</code>
<div class="block">Queries whether any threads are waiting on the given condition
 associated with this lock.</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/locks/ReentrantLock.html#isFair()">isFair</a></strong>()</code>
<div class="block">Returns <code>true</code> if this lock has fairness set true.</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/locks/ReentrantLock.html#isHeldByCurrentThread()">isHeldByCurrentThread</a></strong>()</code>
<div class="block">Queries if this lock is held by the current thread.</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/locks/ReentrantLock.html#isLocked()">isLocked</a></strong>()</code>
<div class="block">Queries if this lock is held by any thread.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/ReentrantLock.html#lock()">lock</a></strong>()</code>
<div class="block">Acquires the lock.</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/locks/ReentrantLock.html#lockInterruptibly()">lockInterruptibly</a></strong>()</code>
<div class="block">Acquires the lock unless the current thread is
 interrupted.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/ReentrantLock.html#newCondition()">newCondition</a></strong>()</code>
<div class="block">Returns a <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> instance for use with this
 <a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Lock.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent.locks"><code>Lock</code></a> instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/ReentrantLock.html#toString()">toString</a></strong>()</code>
<div class="block">Returns a string identifying this lock, as well as its lock state.</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/locks/ReentrantLock.html#tryLock()">tryLock</a></strong>()</code>
<div class="block">Acquires the lock only if it is not held by another thread at the time
 of invocation.</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/locks/ReentrantLock.html#tryLock(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">tryLock</a></strong>(long&nbsp;timeout,
       <a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a>&nbsp;unit)</code>
<div class="block">Acquires the lock if it is not held by another thread within the given
 waiting time and the current thread has not been
 interrupted.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/ReentrantLock.html#unlock()">unlock</a></strong>()</code>
<div class="block">Attempts to release this lock.</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&nbsp;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="ReentrantLock()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ReentrantLock</h4>
<pre>public&nbsp;ReentrantLock()</pre>
<div class="block">Creates an instance of <code>ReentrantLock</code>.
 This is equivalent to using <code>ReentrantLock(false)</code>.</div>
</li>
</ul>
<a name="ReentrantLock(boolean)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ReentrantLock</h4>
<pre>public&nbsp;ReentrantLock(boolean&nbsp;fair)</pre>
<div class="block">Creates an instance of <code>ReentrantLock</code> with the
 given fairness policy.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fair</code> - <code>true</code> if this lock should use a fair ordering policy</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="lock()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lock</h4>
<pre>public&nbsp;void&nbsp;lock()</pre>
<div class="block">Acquires the lock.

 <p>Acquires the lock if it is not held by another thread and returns
 immediately, setting the lock hold count to one.

 <p>If the current thread already holds the lock then the hold
 count is incremented by one and the method returns immediately.

 <p>If the lock is held by another thread then the
 current thread becomes disabled for thread scheduling
 purposes and lies dormant until the lock has been acquired,
 at which time the lock hold count is set to one.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Lock.html#lock()">lock</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Lock.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent.locks">Lock</a></code></dd>
</dl>
</li>
</ul>
<a name="lockInterruptibly()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lockInterruptibly</h4>
<pre>public&nbsp;void&nbsp;lockInterruptibly()
                       throws java.lang.InterruptedException</pre>
<div class="block">Acquires the lock unless the current thread is
 interrupted.

 <p>Acquires the lock if it is not held by another thread and returns
 immediately, setting the lock hold count to one.

 <p>If the current thread already holds this lock then the hold count
 is incremented by one and the method returns immediately.

 <p>If the lock is held by another thread then the
 current thread becomes disabled for thread scheduling
 purposes and lies dormant until one of two things happens:

 <ul>

 <li>The lock is acquired by the current thread; or

 <li>Some other thread interrupts the
 current thread.

 </ul>

 <p>If the lock is acquired by the current thread then the lock hold
 count is set to one.

 <p>If the current thread:

 <ul>

 <li>has its interrupted status set on entry to this method; or

 <li>is interrupted while acquiring
 the lock,

 </ul>

 then <code>InterruptedException</code> is thrown and the current thread's
 interrupted status is cleared.

 <p>In this implementation, as this method is an explicit
 interruption point, preference is given to responding to the
 interrupt over normal or reentrant acquisition of the lock.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Lock.html#lockInterruptibly()">lockInterruptibly</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Lock.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent.locks">Lock</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code> - if the current thread is interrupted</dd></dl>
</li>
</ul>
<a name="tryLock()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tryLock</h4>
<pre>public&nbsp;boolean&nbsp;tryLock()</pre>
<div class="block">Acquires the lock only if it is not held by another thread at the time
 of invocation.

 <p>Acquires the lock if it is not held by another thread and
 returns immediately with the value <code>true</code>, setting the
 lock hold count to one. Even when this lock has been set to use a
 fair ordering policy, a call to <code>tryLock()</code> <em>will</em>
 immediately acquire the lock if it is available, whether or not
 other threads are currently waiting for the lock.
 This &quot;barging&quot; behavior can be useful in certain
 circumstances, even though it breaks fairness. If you want to honor
 the fairness setting for this lock, then use
 <a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/ReentrantLock.html#tryLock(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)"><code>tryLock(0, TimeUnit.SECONDS) </code></a>
 which is almost equivalent (it also detects interruption).

 <p> If the current thread already holds this lock then the hold
 count is incremented by one and the method returns <code>true</code>.

 <p>If the lock is held by another thread then this method will return
 immediately with the value <code>false</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Lock.html#tryLock()">tryLock</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Lock.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent.locks">Lock</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the lock was free and was acquired by the
         current thread, or the lock was already held by the current
         thread; and <code>false</code> otherwise</dd></dl>
</li>
</ul>
<a name="tryLock(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tryLock</h4>
<pre>public&nbsp;boolean&nbsp;tryLock(long&nbsp;timeout,
              <a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a>&nbsp;unit)
                throws java.lang.InterruptedException</pre>
<div class="block">Acquires the lock if it is not held by another thread within the given
 waiting time and the current thread has not been
 interrupted.

 <p>Acquires the lock if it is not held by another thread and returns
 immediately with the value <code>true</code>, setting the lock hold count
 to one. If this lock has been set to use a fair ordering policy then
 an available lock <em>will not</em> be acquired if any other threads
 are waiting for the lock. This is in contrast to the <a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/ReentrantLock.html#tryLock()"><code>tryLock()</code></a>
 method. If you want a timed <code>tryLock</code> that does permit barging on
 a fair lock then combine the timed and un-timed forms together:

 <pre>if (lock.tryLock() || lock.tryLock(timeout, unit) ) { ... }
 </pre>

 <p>If the current thread
 already holds this lock then the hold count is incremented by one and
 the method returns <code>true</code>.

 <p>If the lock is held by another thread then the
 current thread becomes disabled for thread scheduling
 purposes and lies dormant until one of three things happens:

 <ul>

 <li>The lock is acquired by the current thread; or

 <li>Some other thread interrupts
 the current thread; or

 <li>The specified waiting time elapses

 </ul>

 <p>If the lock is acquired then the value <code>true</code> is returned and
 the lock hold count is set to one.

 <p>If the current thread:

 <ul>

 <li>has its interrupted status set on entry to this method; or

 <li>is interrupted while
 acquiring the lock,

 </ul>
 then <code>InterruptedException</code> is thrown and the current thread's
 interrupted status is cleared.

 <p>If the specified waiting time elapses then the value <code>false</code>
 is returned.  If the time is less than or equal to zero, the method
 will not wait at all.

 <p>In this implementation, as this method is an explicit
 interruption point, preference is given to responding to the
 interrupt over normal or reentrant acquisition of the lock, and
 over reporting the elapse of the waiting time.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Lock.html#tryLock(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">tryLock</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Lock.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent.locks">Lock</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>timeout</code> - the time to wait for the lock</dd><dd><code>unit</code> - the time unit of the timeout argument</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the lock was free and was acquired by the
         current thread, or the lock was already held by the current
         thread; and <code>false</code> if the waiting time elapsed before
         the lock could be acquired</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code> - if the current thread is interrupted</dd>
<dd><code>java.lang.NullPointerException</code> - if the time unit is null</dd></dl>
</li>
</ul>
<a name="unlock()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unlock</h4>
<pre>public&nbsp;void&nbsp;unlock()</pre>
<div class="block">Attempts to release this lock.

 <p>If the current thread is the holder of this lock then the hold
 count is decremented.  If the hold count is now zero then the lock
 is released.  If the current thread is not the holder of this
 lock then <code>IllegalMonitorStateException</code> is thrown.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Lock.html#unlock()">unlock</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Lock.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent.locks">Lock</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalMonitorStateException</code> - if the current thread does not
         hold this lock</dd></dl>
</li>
</ul>
<a name="newCondition()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newCondition</h4>
<pre>public&nbsp;<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>&nbsp;newCondition()</pre>
<div class="block">Returns a <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> instance for use with this
 <a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Lock.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent.locks"><code>Lock</code></a> instance.

 <p>The returned <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> instance supports the same
 usages as do the <code>Object</code> monitor methods (<code>wait</code>, <code>notify</code>, and <code>notifyAll</code>) when used with the built-in
 monitor lock.

 <ul>

 <li>If this lock is not held when any of 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>
 <a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Condition.html#await()">waiting</a> or <a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Condition.html#signal()">signalling</a> methods are called, then an <code>IllegalMonitorStateException</code> is thrown.

 <li>When the condition <a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Condition.html#await()">waiting</a>
 methods are called the lock is released and, before they
 return, the lock is reacquired and the lock hold count restored
 to what it was when the method was called.

 <li>If a thread is interrupted
 while waiting then the wait will terminate, an <code>InterruptedException</code> will be thrown, and the thread's
 interrupted status will be cleared.

 <li> Waiting threads are signalled in FIFO order.

 <li>The ordering of lock reacquisition for threads returning
 from waiting methods is the same as for threads initially
 acquiring the lock, which is in the default case not specified,
 but for <em>fair</em> locks favors those threads that have been
 waiting the longest.

 </ul></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Lock.html#newCondition()">newCondition</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/Lock.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent.locks">Lock</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the Condition object</dd></dl>
</li>
</ul>
<a name="getHoldCount()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHoldCount</h4>
<pre>public&nbsp;int&nbsp;getHoldCount()</pre>
<div class="block">Queries the number of holds on this lock by the current thread.

 <p>A thread has a hold on a lock for each lock action that is not
 matched by an unlock action.

 <p>The hold count information is typically only used for testing and
 debugging purposes. For example, if a certain section of code should
 not be entered with the lock already held then we can assert that
 fact:

 <pre>
 class X {
   ReentrantLock lock = new ReentrantLock();
   // ...
   public void m() {
     assert lock.getHoldCount() == 0;
     lock.lock();
     try {
       // ... method body
     } finally {
       lock.unlock();
     }
   }
 }
 </pre></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the number of holds on this lock by the current thread,
         or zero if this lock is not held by the current thread</dd></dl>
</li>
</ul>
<a name="isHeldByCurrentThread()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isHeldByCurrentThread</h4>
<pre>public&nbsp;boolean&nbsp;isHeldByCurrentThread()</pre>
<div class="block">Queries if this lock is held by the current thread.

 <p>Analogous to the <code>Thread.holdsLock(java.lang.Object)</code> method for built-in
 monitor locks, this method is typically used for debugging and
 testing. For example, a method that should only be called while
 a lock is held can assert that this is the case:

 <pre>
 class X {
   ReentrantLock lock = new ReentrantLock();
   // ...

   public void m() {
       assert lock.isHeldByCurrentThread();
       // ... method body
   }
 }
 </pre>

 <p>It can also be used to ensure that a reentrant lock is used
 in a non-reentrant manner, for example:

 <pre>
 class X {
   ReentrantLock lock = new ReentrantLock();
   // ...

   public void m() {
       assert !lock.isHeldByCurrentThread();
       lock.lock();
       try {
           // ... method body
       } finally {
           lock.unlock();
       }
   }
 }
 </pre></div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if current thread holds this lock and
         <code>false</code> otherwise</dd></dl>
</li>
</ul>
<a name="isLocked()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLocked</h4>
<pre>public&nbsp;boolean&nbsp;isLocked()</pre>
<div class="block">Queries if this lock is held by any thread. This method is
 designed for use in monitoring of the system state,
 not for synchronization control.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if any thread holds this lock and
         <code>false</code> otherwise</dd></dl>
</li>
</ul>
<a name="isFair()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFair</h4>
<pre>public final&nbsp;boolean&nbsp;isFair()</pre>
<div class="block">Returns <code>true</code> if this lock has fairness set true.</div>
<dl><dt><span class="strong">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&nbsp;java.lang.Thread&nbsp;getOwner()</pre>
<div class="block">Returns the thread that currently owns this 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="strong">Returns:</span></dt><dd>the owner, or <code>null</code> if not owned</dd></dl>
</li>
</ul>
<a name="hasQueuedThreads()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasQueuedThreads</h4>
<pre>public final&nbsp;boolean&nbsp;hasQueuedThreads()</pre>
<div class="block">Queries whether any threads are waiting to acquire this 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 this lock.  This method is designed primarily for use in
 monitoring of the system state.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if there may be other threads waiting to
         acquire the lock</dd></dl>
</li>
</ul>
<a name="hasQueuedThread(java.lang.Thread)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasQueuedThread</h4>
<pre>public final&nbsp;boolean&nbsp;hasQueuedThread(java.lang.Thread&nbsp;thread)</pre>
<div class="block">Queries whether the given thread is waiting to acquire this
 lock. Note that because cancellations may occur at any time, a
 <code>true</code> return does not guarantee that this thread
 will ever acquire this lock.  This method is designed primarily for use
 in monitoring of the system state.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>thread</code> - the thread</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the given thread is queued waiting for this lock</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if the thread is null</dd></dl>
</li>
</ul>
<a name="getQueueLength()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueueLength</h4>
<pre>public final&nbsp;int&nbsp;getQueueLength()</pre>
<div class="block">Returns an estimate of the number of threads waiting to
 acquire this 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="strong">Returns:</span></dt><dd>the estimated number of threads waiting for this lock</dd></dl>
</li>
</ul>
<a name="getQueuedThreads()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueuedThreads</h4>
<pre>protected&nbsp;java.util.Collection&nbsp;getQueuedThreads()</pre>
<div class="block">Returns a collection containing threads that may be waiting to
 acquire this lock.  Because the actual set of threads may change
 dynamically while constructing this result, the returned
 collection is only a best-effort estimate.  The elements of the
 returned collection are in no particular order.  This method is
 designed to facilitate construction of subclasses that provide
 more extensive monitoring facilities.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the collection of threads</dd></dl>
</li>
</ul>
<a name="hasWaiters(edu.emory.mathcs.backport.java.util.concurrent.locks.Condition)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasWaiters</h4>
<pre>public&nbsp;boolean&nbsp;hasWaiters(<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>&nbsp;condition)</pre>
<div class="block">Queries whether any threads are waiting on the given condition
 associated with this lock. Note that because timeouts and
 interrupts may occur at any time, a <code>true</code> return does
 not guarantee that a future <code>signal</code> will awaken any
 threads.  This method is designed primarily for use in
 monitoring of the system state.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>condition</code> - the condition</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if there are any waiting threads</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalMonitorStateException</code> - if this lock is not held</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if the given condition is
         not associated with this lock</dd>
<dd><code>java.lang.NullPointerException</code> - if the condition is null</dd></dl>
</li>
</ul>
<a name="getWaitQueueLength(edu.emory.mathcs.backport.java.util.concurrent.locks.Condition)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWaitQueueLength</h4>
<pre>public&nbsp;int&nbsp;getWaitQueueLength(<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>&nbsp;condition)</pre>
<div class="block">Returns an estimate of the number of threads waiting on the
 given condition associated with this lock. Note that because
 timeouts and interrupts may occur at any time, the estimate
 serves only as an upper bound on the actual number of waiters.
 This method is designed for use in monitoring of the system
 state, not for synchronization control.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>condition</code> - the condition</dd>
<dt><span class="strong">Returns:</span></dt><dd>the estimated number of waiting threads</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalMonitorStateException</code> - if this lock is not held</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if the given condition is
         not associated with this lock</dd>
<dd><code>java.lang.NullPointerException</code> - if the condition is null</dd></dl>
</li>
</ul>
<a name="getWaitingThreads(edu.emory.mathcs.backport.java.util.concurrent.locks.Condition)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWaitingThreads</h4>
<pre>protected&nbsp;java.util.Collection&nbsp;getWaitingThreads(<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>&nbsp;condition)</pre>
<div class="block">Returns a collection containing those threads that may be
 waiting on the given condition associated with this lock.
 Because the actual set of threads may change dynamically while
 constructing this result, the returned collection is only a
 best-effort estimate. The elements of the returned collection
 are in no particular order.  This method is designed to
 facilitate construction of subclasses that provide more
 extensive condition monitoring facilities.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>condition</code> - the condition</dd>
<dt><span class="strong">Returns:</span></dt><dd>the collection of threads</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalMonitorStateException</code> - if this lock is not held</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if the given condition is
         not associated with this lock</dd>
<dd><code>java.lang.NullPointerException</code> - if the condition is null</dd></dl>
</li>
</ul>
<a name="toString()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<div class="block">Returns a string identifying this lock, as well as its lock state.
 The state, in brackets, includes either the String <code>"Unlocked"</code>
 or the String <code>"Locked by"</code> followed by the
 name of the owning thread.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="strong">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><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/locks/ReadWriteLock.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent.locks"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/locks/ReentrantReadWriteLock.html" title="class in edu.emory.mathcs.backport.java.util.concurrent.locks"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?edu/emory/mathcs/backport/java/util/concurrent/locks/ReentrantLock.html" target="_top">Frames</a></li>
<li><a href="ReentrantLock.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>