/usr/share/doc/libbackport-util-concurrent-java/api/edu/emory/mathcs/backport/java/util/concurrent/PriorityBlockingQueue.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 1005 | <!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>PriorityBlockingQueue</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="PriorityBlockingQueue";
}
//-->
</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/LinkedBlockingQueue.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/RejectedExecutionException.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?edu/emory/mathcs/backport/java/util/concurrent/PriorityBlockingQueue.html" target="_top">Frames</a></li>
<li><a href="PriorityBlockingQueue.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</div>
<h2 title="Class PriorityBlockingQueue" class="title">Class PriorityBlockingQueue</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.util.AbstractCollection</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../edu/emory/mathcs/backport/java/util/AbstractCollection.html" title="class in edu.emory.mathcs.backport.java.util">edu.emory.mathcs.backport.java.util.AbstractCollection</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../edu/emory/mathcs/backport/java/util/AbstractQueue.html" title="class in edu.emory.mathcs.backport.java.util">edu.emory.mathcs.backport.java.util.AbstractQueue</a></li>
<li>
<ul class="inheritance">
<li>edu.emory.mathcs.backport.java.util.concurrent.PriorityBlockingQueue</li>
</ul>
</li>
</ul>
</li>
</ul>
</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/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/Queue.html" title="interface in edu.emory.mathcs.backport.java.util">Queue</a>, java.io.Serializable, java.lang.Iterable, java.util.Collection</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">PriorityBlockingQueue</span>
extends <a href="../../../../../../../edu/emory/mathcs/backport/java/util/AbstractQueue.html" title="class in edu.emory.mathcs.backport.java.util">AbstractQueue</a>
implements <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a>, java.io.Serializable</pre>
<div class="block">An unbounded <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">blocking queue</a> that uses
the same ordering rules as class <a href="../../../../../../../edu/emory/mathcs/backport/java/util/PriorityQueue.html" title="class in edu.emory.mathcs.backport.java.util"><code>PriorityQueue</code></a> and supplies
blocking retrieval operations. While this queue is logically
unbounded, attempted additions may fail due to resource exhaustion
(causing <tt>OutOfMemoryError</tt>). This class does not permit
<tt>null</tt> elements. A priority queue relying on natural ordering also does not permit insertion of
non-comparable objects (doing so results in
<tt>ClassCastException</tt>).
<p>This class and its iterator implement all of the
<em>optional</em> methods of the <code>Collection</code> and <code>Iterator</code> interfaces. The Iterator provided in method <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/PriorityBlockingQueue.html#iterator()"><code>iterator()</code></a> is <em>not</em> guaranteed to traverse the elements of
the PriorityBlockingQueue in any particular order. If you need
ordered traversal, consider using
<tt>Arrays.sort(pq.toArray())</tt>. Also, method <tt>drainTo</tt>
can be used to <em>remove</em> some or all elements in priority
order and place them in another collection.
<p>Operations on this class make no guarantees about the ordering
of elements with equal priority. If you need to enforce an
ordering, you can define custom classes or comparators that use a
secondary key to break ties in primary priority values. For
example, here is a class that applies first-in-first-out
tie-breaking to comparable elements. To use it, you would insert a
<tt>new FIFOEntry(anEntry)</tt> instead of a plain entry object.
<pre>
class FIFOEntry implements Comparable {
final static AtomicLong seq = new AtomicLong();
final long seqNum;
final Object entry;
public FIFOEntry(Object entry) {
seqNum = seq.getAndIncrement();
this.entry = entry;
}
public Object getEntry() { return entry; }
public int compareTo(FIFOEntr other) {
int res = entry.compareTo(other.entry);
if (res == 0 && other.entry != this.entry)
res = (seqNum < other.seqNum ? -1 : 1);
return res;
}
}</pre>
<p>This class is a member of the
<a href="../../../../../../../../technotes/guides/collections/index.html">
Java Collections Framework</a>.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.5</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Doug Lea</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../serialized-form.html#edu.emory.mathcs.backport.java.util.concurrent.PriorityBlockingQueue">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"> </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/PriorityBlockingQueue.html#PriorityBlockingQueue()">PriorityBlockingQueue</a></strong>()</code>
<div class="block">Creates a <tt>PriorityBlockingQueue</tt> with the default
initial capacity (11) that orders its elements according to
their natural ordering.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/PriorityBlockingQueue.html#PriorityBlockingQueue(java.util.Collection)">PriorityBlockingQueue</a></strong>(java.util.Collection c)</code>
<div class="block">Creates a <tt>PriorityBlockingQueue</tt> containing the elements
in the specified collection.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/PriorityBlockingQueue.html#PriorityBlockingQueue(int)">PriorityBlockingQueue</a></strong>(int initialCapacity)</code>
<div class="block">Creates a <tt>PriorityBlockingQueue</tt> with the specified
initial capacity that orders its elements according to their
natural ordering.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/PriorityBlockingQueue.html#PriorityBlockingQueue(int, java.util.Comparator)">PriorityBlockingQueue</a></strong>(int initialCapacity,
java.util.Comparator comparator)</code>
<div class="block">Creates a <tt>PriorityBlockingQueue</tt> with the specified initial
capacity that orders its elements according to the specified
comparator.</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/PriorityBlockingQueue.html#add(java.lang.Object)">add</a></strong>(java.lang.Object e)</code>
<div class="block">Inserts the specified element into this priority queue.</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/PriorityBlockingQueue.html#clear()">clear</a></strong>()</code>
<div class="block">Atomically removes all of the elements from this queue.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Comparator</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/PriorityBlockingQueue.html#comparator()">comparator</a></strong>()</code>
<div class="block">Returns the comparator used to order the elements in this queue,
or <tt>null</tt> if this queue uses the natural ordering of its elements.</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/PriorityBlockingQueue.html#contains(java.lang.Object)">contains</a></strong>(java.lang.Object o)</code>
<div class="block">Returns <code>true</code> if this queue contains the specified element.</div>
</td>
</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/PriorityBlockingQueue.html#drainTo(java.util.Collection)">drainTo</a></strong>(java.util.Collection c)</code>
<div class="block">Removes all available elements from this queue and adds them
to the given collection.</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/PriorityBlockingQueue.html#drainTo(java.util.Collection, int)">drainTo</a></strong>(java.util.Collection c,
int maxElements)</code>
<div class="block">Removes at most the given number of available elements from
this queue and adds them to the given collection.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Iterator</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/PriorityBlockingQueue.html#iterator()">iterator</a></strong>()</code>
<div class="block">Returns an iterator over the elements in this queue.</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/PriorityBlockingQueue.html#offer(java.lang.Object)">offer</a></strong>(java.lang.Object e)</code>
<div class="block">Inserts the specified element into this priority queue.</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/PriorityBlockingQueue.html#offer(java.lang.Object, long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">offer</a></strong>(java.lang.Object e,
long timeout,
<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a> unit)</code>
<div class="block">Inserts the specified element into this priority queue.</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/PriorityBlockingQueue.html#peek()">peek</a></strong>()</code>
<div class="block">Retrieves, but does not remove, the head of this queue,
or returns <tt>null</tt> if this queue is empty.</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/PriorityBlockingQueue.html#poll()">poll</a></strong>()</code>
<div class="block">Retrieves and removes the head of this queue,
or returns <tt>null</tt> if this queue is empty.</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/PriorityBlockingQueue.html#poll(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">poll</a></strong>(long timeout,
<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a> unit)</code>
<div class="block">Retrieves and removes the head of this queue, waiting up to the
specified wait time if necessary for an element to become available.</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/PriorityBlockingQueue.html#put(java.lang.Object)">put</a></strong>(java.lang.Object e)</code>
<div class="block">Inserts the specified element into this priority queue.</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/PriorityBlockingQueue.html#remainingCapacity()">remainingCapacity</a></strong>()</code>
<div class="block">Always returns <tt>Integer.MAX_VALUE</tt> because
a <tt>PriorityBlockingQueue</tt> is not capacity constrained.</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/PriorityBlockingQueue.html#remove(java.lang.Object)">remove</a></strong>(java.lang.Object o)</code>
<div class="block">Removes a single instance of the specified element from this queue,
if it is present.</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/PriorityBlockingQueue.html#size()">size</a></strong>()</code> </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/PriorityBlockingQueue.html#take()">take</a></strong>()</code>
<div class="block">Retrieves and removes the head of this queue, waiting if necessary
until an element becomes available.</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/PriorityBlockingQueue.html#toArray()">toArray</a></strong>()</code>
<div class="block">Returns an array containing all of the elements in this queue.</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/PriorityBlockingQueue.html#toArray(java.lang.Object[])">toArray</a></strong>(java.lang.Object[] a)</code>
<div class="block">Returns an array containing all of the elements in this queue; the
runtime type of the returned array is that of the specified array.</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/PriorityBlockingQueue.html#toString()">toString</a></strong>()</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_edu.emory.mathcs.backport.java.util.AbstractQueue">
<!-- -->
</a>
<h3>Methods inherited from class edu.emory.mathcs.backport.java.util.<a href="../../../../../../../edu/emory/mathcs/backport/java/util/AbstractQueue.html" title="class in edu.emory.mathcs.backport.java.util">AbstractQueue</a></h3>
<code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/AbstractQueue.html#addAll(java.util.Collection)">addAll</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/AbstractQueue.html#element()">element</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/AbstractQueue.html#remove()">remove</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.util.AbstractCollection">
<!-- -->
</a>
<h3>Methods inherited from class java.util.AbstractCollection</h3>
<code>containsAll, isEmpty, removeAll, retainAll</code></li>
</ul>
<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>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_edu.emory.mathcs.backport.java.util.Queue">
<!-- -->
</a>
<h3>Methods inherited from interface edu.emory.mathcs.backport.java.util.<a href="../../../../../../../edu/emory/mathcs/backport/java/util/Queue.html" title="interface in edu.emory.mathcs.backport.java.util">Queue</a></h3>
<code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/Queue.html#element()">element</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/Queue.html#remove()">remove</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.util.Collection">
<!-- -->
</a>
<h3>Methods inherited from interface java.util.Collection</h3>
<code>addAll, containsAll, equals, hashCode, isEmpty, removeAll, retainAll</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="PriorityBlockingQueue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PriorityBlockingQueue</h4>
<pre>public PriorityBlockingQueue()</pre>
<div class="block">Creates a <tt>PriorityBlockingQueue</tt> with the default
initial capacity (11) that orders its elements according to
their natural ordering.</div>
</li>
</ul>
<a name="PriorityBlockingQueue(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PriorityBlockingQueue</h4>
<pre>public PriorityBlockingQueue(int initialCapacity)</pre>
<div class="block">Creates a <tt>PriorityBlockingQueue</tt> with the specified
initial capacity that orders its elements according to their
natural ordering.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>initialCapacity</code> - the initial capacity for this priority queue</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <tt>initialCapacity</tt> is less
than 1</dd></dl>
</li>
</ul>
<a name="PriorityBlockingQueue(int, java.util.Comparator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PriorityBlockingQueue</h4>
<pre>public PriorityBlockingQueue(int initialCapacity,
java.util.Comparator comparator)</pre>
<div class="block">Creates a <tt>PriorityBlockingQueue</tt> with the specified initial
capacity that orders its elements according to the specified
comparator.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>initialCapacity</code> - the initial capacity for this priority queue</dd><dd><code>comparator</code> - the comparator that will be used to order this
priority queue. If <code>null</code>, the natural ordering of the elements will be used.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <tt>initialCapacity</tt> is less
than 1</dd></dl>
</li>
</ul>
<a name="PriorityBlockingQueue(java.util.Collection)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PriorityBlockingQueue</h4>
<pre>public PriorityBlockingQueue(java.util.Collection c)</pre>
<div class="block">Creates a <tt>PriorityBlockingQueue</tt> containing the elements
in the specified collection. If the specified collection is a
<code>SortedSet</code> or a <a href="../../../../../../../edu/emory/mathcs/backport/java/util/PriorityQueue.html" title="class in edu.emory.mathcs.backport.java.util"><code>PriorityQueue</code></a>, this
priority queue will be ordered according to the same ordering.
Otherwise, this priority queue will be ordered according to the
natural ordering of its elements.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>c</code> - the collection whose elements are to be placed
into this priority queue</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ClassCastException</code> - if elements of the specified collection
cannot be compared to one another according to the priority
queue's ordering</dd>
<dd><code>java.lang.NullPointerException</code> - if the specified collection or any
of its elements are null</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="add(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public boolean add(java.lang.Object e)</pre>
<div class="block">Inserts the specified element into this priority queue.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html#add(java.lang.Object)">add</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/Queue.html#add(java.lang.Object)">add</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/Queue.html" title="interface in edu.emory.mathcs.backport.java.util">Queue</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>add</code> in interface <code>java.util.Collection</code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/AbstractQueue.html#add(java.lang.Object)">add</a></code> in class <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/AbstractQueue.html" title="class in edu.emory.mathcs.backport.java.util">AbstractQueue</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - the element to add</dd>
<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> (as specified by <code>Collection.add(java.lang.Object)</code>)</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ClassCastException</code> - if the specified element cannot be compared
with elements currently in the priority queue according to the
priority queue's ordering</dd>
<dd><code>java.lang.NullPointerException</code> - if the specified element is null</dd></dl>
</li>
</ul>
<a name="offer(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>offer</h4>
<pre>public boolean offer(java.lang.Object e)</pre>
<div class="block">Inserts the specified element into this priority queue.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html#offer(java.lang.Object)">offer</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/Queue.html#offer(java.lang.Object)">offer</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/Queue.html" title="interface in edu.emory.mathcs.backport.java.util">Queue</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - the element to add</dd>
<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> (as specified by <a href="../../../../../../../edu/emory/mathcs/backport/java/util/Queue.html#offer(java.lang.Object)"><code>Queue.offer(java.lang.Object)</code></a>)</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ClassCastException</code> - if the specified element cannot be compared
with elements currently in the priority queue according to the
priority queue's ordering</dd>
<dd><code>java.lang.NullPointerException</code> - if the specified element is null</dd></dl>
</li>
</ul>
<a name="put(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>public void put(java.lang.Object e)</pre>
<div class="block">Inserts the specified element into this priority queue. As the queue is
unbounded this method will never block.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html#put(java.lang.Object)">put</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - the element to add</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ClassCastException</code> - if the specified element cannot be compared
with elements currently in the priority queue according to the
priority queue's ordering</dd>
<dd><code>java.lang.NullPointerException</code> - if the specified element is null</dd></dl>
</li>
</ul>
<a name="offer(java.lang.Object, long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>offer</h4>
<pre>public boolean offer(java.lang.Object e,
long timeout,
<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a> unit)</pre>
<div class="block">Inserts the specified element into this priority queue. As the queue is
unbounded this method will never block.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html#offer(java.lang.Object, long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">offer</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - the element to add</dd><dd><code>timeout</code> - This parameter is ignored as the method never blocks</dd><dd><code>unit</code> - This parameter is ignored as the method never blocks</dd>
<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ClassCastException</code> - if the specified element cannot be compared
with elements currently in the priority queue according to the
priority queue's ordering</dd>
<dd><code>java.lang.NullPointerException</code> - if the specified element is null</dd></dl>
</li>
</ul>
<a name="poll()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>poll</h4>
<pre>public java.lang.Object poll()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/Queue.html#poll()">Queue</a></code></strong></div>
<div class="block">Retrieves and removes the head of this queue,
or returns <tt>null</tt> if this queue is empty.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/Queue.html#poll()">poll</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/Queue.html" title="interface in edu.emory.mathcs.backport.java.util">Queue</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the head of this queue, or <tt>null</tt> if this queue is empty</dd></dl>
</li>
</ul>
<a name="take()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>take</h4>
<pre>public java.lang.Object take()
throws java.lang.InterruptedException</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html#take()">BlockingQueue</a></code></strong></div>
<div class="block">Retrieves and removes the head of this queue, waiting if necessary
until an element becomes available.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html#take()">take</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the head of this queue</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code> - if interrupted while waiting</dd></dl>
</li>
</ul>
<a name="poll(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>poll</h4>
<pre>public java.lang.Object poll(long timeout,
<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a> unit)
throws java.lang.InterruptedException</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html#poll(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">BlockingQueue</a></code></strong></div>
<div class="block">Retrieves and removes the head of this queue, waiting up to the
specified wait time if necessary for an element to become available.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html#poll(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">poll</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>timeout</code> - how long to wait before giving up, in units of
<tt>unit</tt></dd><dd><code>unit</code> - a <tt>TimeUnit</tt> determining how to interpret the
<tt>timeout</tt> parameter</dd>
<dt><span class="strong">Returns:</span></dt><dd>the head of this queue, or <tt>null</tt> if the
specified waiting time elapses before an element is available</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code> - if interrupted while waiting</dd></dl>
</li>
</ul>
<a name="peek()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>peek</h4>
<pre>public java.lang.Object peek()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/Queue.html#peek()">Queue</a></code></strong></div>
<div class="block">Retrieves, but does not remove, the head of this queue,
or returns <tt>null</tt> if this queue is empty.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/Queue.html#peek()">peek</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/Queue.html" title="interface in edu.emory.mathcs.backport.java.util">Queue</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the head of this queue, or <tt>null</tt> if this queue is empty</dd></dl>
</li>
</ul>
<a name="comparator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>comparator</h4>
<pre>public java.util.Comparator comparator()</pre>
<div class="block">Returns the comparator used to order the elements in this queue,
or <tt>null</tt> if this queue uses the natural ordering of its elements.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the comparator used to order the elements in this queue,
or <tt>null</tt> if this queue uses the natural
ordering of its elements</dd></dl>
</li>
</ul>
<a name="size()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>public int size()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>size</code> in interface <code>java.util.Collection</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>size</code> in class <code>java.util.AbstractCollection</code></dd>
</dl>
</li>
</ul>
<a name="remainingCapacity()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remainingCapacity</h4>
<pre>public int remainingCapacity()</pre>
<div class="block">Always returns <tt>Integer.MAX_VALUE</tt> because
a <tt>PriorityBlockingQueue</tt> is not capacity constrained.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html#remainingCapacity()">remainingCapacity</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd><tt>Integer.MAX_VALUE</tt></dd></dl>
</li>
</ul>
<a name="remove(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>public boolean remove(java.lang.Object o)</pre>
<div class="block">Removes a single instance of the specified element from this queue,
if it is present. More formally, removes an element <code>e</code> such
that <code>o.equals(e)</code>, if this queue contains one or more such
elements. Returns <code>true</code> if and only if this queue contained
the specified element (or equivalently, if this queue changed as a
result of the call).</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html#remove(java.lang.Object)">remove</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>remove</code> in interface <code>java.util.Collection</code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code>remove</code> in class <code>java.util.AbstractCollection</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>o</code> - element to be removed from this queue, if present</dd>
<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if this queue changed as a result of the call</dd></dl>
</li>
</ul>
<a name="contains(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contains</h4>
<pre>public boolean contains(java.lang.Object o)</pre>
<div class="block">Returns <code>true</code> if this queue contains the specified element.
More formally, returns <code>true</code> if and only if this queue contains
at least one element <code>e</code> such that <code>o.equals(e)</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html#contains(java.lang.Object)">contains</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>contains</code> in interface <code>java.util.Collection</code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code>contains</code> in class <code>java.util.AbstractCollection</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>o</code> - object to be checked for containment in this queue</dd>
<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if this queue contains the specified element</dd></dl>
</li>
</ul>
<a name="toArray()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toArray</h4>
<pre>public java.lang.Object[] toArray()</pre>
<div class="block">Returns an array containing all of the elements in this queue.
The returned array elements are in no particular order.
<p>The returned array will be "safe" in that no references to it are
maintained by this queue. (In other words, this method must allocate
a new array). The caller is thus free to modify the returned array.
<p>This method acts as bridge between array-based and collection-based
APIs.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>toArray</code> in interface <code>java.util.Collection</code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/AbstractCollection.html#toArray()">toArray</a></code> in class <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/AbstractCollection.html" title="class in edu.emory.mathcs.backport.java.util">AbstractCollection</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>an array containing all of the elements in this queue</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.util.AbstractCollection</code></dd>
</dl>
</li>
</ul>
<a name="drainTo(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>drainTo</h4>
<pre>public int drainTo(java.util.Collection c)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html#drainTo(java.util.Collection)">BlockingQueue</a></code></strong></div>
<div class="block">Removes all available elements from this queue and adds them
to the given collection. This operation may be more
efficient than repeatedly polling this queue. A failure
encountered while attempting to add elements to
collection <tt>c</tt> may result in elements being in neither,
either or both collections when the associated exception is
thrown. Attempts to drain a queue to itself result in
<tt>IllegalArgumentException</tt>. Further, the behavior of
this operation is undefined if the specified collection is
modified while the operation is in progress.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html#drainTo(java.util.Collection)">drainTo</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>c</code> - the collection to transfer elements into</dd>
<dt><span class="strong">Returns:</span></dt><dd>the number of elements transferred</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.UnsupportedOperationException</code> - if addition of elements
is not supported by the specified collection</dd>
<dd><code>java.lang.ClassCastException</code> - if the class of an element of this queue
prevents it from being added to the specified collection</dd>
<dd><code>java.lang.NullPointerException</code> - if the specified collection is null</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if the specified collection is this
queue, or some property of an element of this queue prevents
it from being added to the specified collection</dd></dl>
</li>
</ul>
<a name="drainTo(java.util.Collection, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>drainTo</h4>
<pre>public int drainTo(java.util.Collection c,
int maxElements)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html#drainTo(java.util.Collection, int)">BlockingQueue</a></code></strong></div>
<div class="block">Removes at most the given number of available elements from
this queue and adds them to the given collection. A failure
encountered while attempting to add elements to
collection <tt>c</tt> may result in elements being in neither,
either or both collections when the associated exception is
thrown. Attempts to drain a queue to itself result in
<tt>IllegalArgumentException</tt>. Further, the behavior of
this operation is undefined if the specified collection is
modified while the operation is in progress.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html#drainTo(java.util.Collection, int)">drainTo</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>c</code> - the collection to transfer elements into</dd><dd><code>maxElements</code> - the maximum number of elements to transfer</dd>
<dt><span class="strong">Returns:</span></dt><dd>the number of elements transferred</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.UnsupportedOperationException</code> - if addition of elements
is not supported by the specified collection</dd>
<dd><code>java.lang.ClassCastException</code> - if the class of an element of this queue
prevents it from being added to the specified collection</dd>
<dd><code>java.lang.NullPointerException</code> - if the specified collection is null</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if the specified collection is this
queue, or some property of an element of this queue prevents
it from being added to the specified collection</dd></dl>
</li>
</ul>
<a name="clear()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>public void clear()</pre>
<div class="block">Atomically removes all of the elements from this queue.
The queue will be empty after this call returns.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>clear</code> in interface <code>java.util.Collection</code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/AbstractQueue.html#clear()">clear</a></code> in class <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/AbstractQueue.html" title="class in edu.emory.mathcs.backport.java.util">AbstractQueue</a></code></dd>
</dl>
</li>
</ul>
<a name="toArray(java.lang.Object[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toArray</h4>
<pre>public java.lang.Object[] toArray(java.lang.Object[] a)</pre>
<div class="block">Returns an array containing all of the elements in this queue; the
runtime type of the returned array is that of the specified array.
The returned array elements are in no particular order.
If the queue fits in the specified array, it is returned therein.
Otherwise, a new array is allocated with the runtime type of the
specified array and the size of this queue.
<p>If this queue fits in the specified array with room to spare
(i.e., the array has more elements than this queue), the element in
the array immediately following the end of the queue is set to
<tt>null</tt>.
<p>Like the <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/PriorityBlockingQueue.html#toArray()"><code>toArray()</code></a> method, this method acts as bridge between
array-based and collection-based APIs. Further, this method allows
precise control over the runtime type of the output array, and may,
under certain circumstances, be used to save allocation costs.
<p>Suppose <tt>x</tt> is a queue known to contain only strings.
The following code can be used to dump the queue into a newly
allocated array of <tt>String</tt>:
<pre>
String[] y = x.toArray(new String[0]);</pre>
Note that <tt>toArray(new Object[0])</tt> is identical in function to
<tt>toArray()</tt>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>toArray</code> in interface <code>java.util.Collection</code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/AbstractCollection.html#toArray(java.lang.Object[])">toArray</a></code> in class <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/AbstractCollection.html" title="class in edu.emory.mathcs.backport.java.util">AbstractCollection</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>a</code> - the array into which the elements of the queue are to
be stored, if it is big enough; otherwise, a new array of the
same runtime type is allocated for this purpose</dd>
<dt><span class="strong">Returns:</span></dt><dd>an array containing all of the elements in this queue</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ArrayStoreException</code> - if the runtime type of the specified array
is not a supertype of the runtime type of every element in
this queue</dd>
<dd><code>java.lang.NullPointerException</code> - if the specified array is null</dd></dl>
</li>
</ul>
<a name="iterator()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>iterator</h4>
<pre>public java.util.Iterator iterator()</pre>
<div class="block">Returns an iterator over the elements in this queue. The
iterator does not return the elements in any particular order.
The returned <tt>Iterator</tt> is a "weakly consistent"
iterator that will never throw <code>ConcurrentModificationException</code>, and guarantees to traverse
elements as they existed upon construction of the iterator, and
may (but is not guaranteed to) reflect any modifications
subsequent to construction.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>iterator</code> in interface <code>java.lang.Iterable</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>iterator</code> in interface <code>java.util.Collection</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>iterator</code> in class <code>java.util.AbstractCollection</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>an iterator over the elements in this queue</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/LinkedBlockingQueue.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/RejectedExecutionException.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?edu/emory/mathcs/backport/java/util/concurrent/PriorityBlockingQueue.html" target="_top">Frames</a></li>
<li><a href="PriorityBlockingQueue.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>
|