/usr/share/doc/libbackport-util-concurrent-java/api/edu/emory/mathcs/backport/java/util/Deque.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 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 | <!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:07 UTC 2012 -->
<title>Deque</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="Deque";
}
//-->
</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/Collections.html" title="class in edu.emory.mathcs.backport.java.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../edu/emory/mathcs/backport/java/util/LinkedList.html" title="class in edu.emory.mathcs.backport.java.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?edu/emory/mathcs/backport/java/util/Deque.html" target="_top">Frames</a></li>
<li><a href="Deque.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">edu.emory.mathcs.backport.java.util</div>
<h2 title="Interface Deque" class="title">Interface Deque</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>java.util.Collection, java.lang.Iterable, <a href="../../../../../../edu/emory/mathcs/backport/java/util/Queue.html" title="interface in edu.emory.mathcs.backport.java.util">Queue</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingDeque.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingDeque</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../edu/emory/mathcs/backport/java/util/ArrayDeque.html" title="class in edu.emory.mathcs.backport.java.util">ArrayDeque</a>, <a href="../../../../../../edu/emory/mathcs/backport/java/util/concurrent/LinkedBlockingDeque.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">LinkedBlockingDeque</a>, <a href="../../../../../../edu/emory/mathcs/backport/java/util/LinkedList.html" title="class in edu.emory.mathcs.backport.java.util">LinkedList</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Deque</span>
extends <a href="../../../../../../edu/emory/mathcs/backport/java/util/Queue.html" title="interface in edu.emory.mathcs.backport.java.util">Queue</a></pre>
<div class="block">A linear collection that supports element insertion and removal at
both ends. The name <i>deque</i> is short for "double ended queue"
and is usually pronounced "deck". Most <tt>Deque</tt>
implementations place no fixed limits on the number of elements
they may contain, but this interface supports capacity-restricted
deques as well as those with no fixed size limit.
<p>This interface defines methods to access the elements at both
ends of the deque. Methods are provided to insert, remove, and
examine the element. Each of these methods exists in two forms:
one throws an exception if the operation fails, the other returns a
special value (either <tt>null</tt> or <tt>false</tt>, depending on
the operation). The latter form of the insert operation is
designed specifically for use with capacity-restricted
<tt>Deque</tt> implementations; in most implementations, insert
operations cannot fail.
<p>The twelve methods described above are summarized in the
following table:
<p>
<table BORDER CELLPADDING=3 CELLSPACING=1>
<tr>
<td></td>
<td ALIGN=CENTER COLSPAN = 2> <b>First Element (Head)</b></td>
<td ALIGN=CENTER COLSPAN = 2> <b>Last Element (Tail)</b></td>
</tr>
<tr>
<td></td>
<td ALIGN=CENTER><em>Throws exception</em></td>
<td ALIGN=CENTER><em>Special value</em></td>
<td ALIGN=CENTER><em>Throws exception</em></td>
<td ALIGN=CENTER><em>Special value</em></td>
</tr>
<tr>
<td><b>Insert</b></td>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#addFirst(java.lang.Object)"><code>addFirst(e)</code></a></td>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#offerFirst(java.lang.Object)"><code>offerFirst(e)</code></a></td>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#addLast(java.lang.Object)"><code>addLast(e)</code></a></td>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#offerLast(java.lang.Object)"><code>offerLast(e)</code></a></td>
</tr>
<tr>
<td><b>Remove</b></td>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#removeFirst()"><code>removeFirst()</code></a></td>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#pollFirst()"><code>pollFirst()</code></a></td>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#removeLast()"><code>removeLast()</code></a></td>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#pollLast()"><code>pollLast()</code></a></td>
</tr>
<tr>
<td><b>Examine</b></td>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#getFirst()"><code>getFirst()</code></a></td>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#peekFirst()"><code>peekFirst()</code></a></td>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#getLast()"><code>getLast()</code></a></td>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#peekLast()"><code>peekLast()</code></a></td>
</tr>
</table>
<p>This interface extends the <a href="../../../../../../edu/emory/mathcs/backport/java/util/Queue.html" title="interface in edu.emory.mathcs.backport.java.util"><code>Queue</code></a> interface. When a deque is
used as a queue, FIFO (First-In-First-Out) behavior results. Elements are
added at the end of the deque and removed from the beginning. The methods
inherited from the <tt>Queue</tt> interface are precisely equivalent to
<tt>Deque</tt> methods as indicated in the following table:
<p>
<table BORDER CELLPADDING=3 CELLSPACING=1>
<tr>
<td ALIGN=CENTER> <b><tt>Queue</tt> Method</b></td>
<td ALIGN=CENTER> <b>Equivalent <tt>Deque</tt> Method</b></td>
</tr>
<tr>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Queue.html#add(java.lang.Object)"><code>add(e)</code></a></td>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#addLast(java.lang.Object)"><code>addLast(e)</code></a></td>
</tr>
<tr>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Queue.html#offer(java.lang.Object)"><code>offer(e)</code></a></td>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#offerLast(java.lang.Object)"><code>offerLast(e)</code></a></td>
</tr>
<tr>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Queue.html#remove()"><code>remove()</code></a></td>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#removeFirst()"><code>removeFirst()</code></a></td>
</tr>
<tr>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Queue.html#poll()"><code>poll()</code></a></td>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#pollFirst()"><code>pollFirst()</code></a></td>
</tr>
<tr>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Queue.html#element()"><code>element()</code></a></td>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#getFirst()"><code>getFirst()</code></a></td>
</tr>
<tr>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Queue.html#peek()"><code>peek()</code></a></td>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#peek()"><code>peekFirst()</code></a></td>
</tr>
</table>
<p>Deques can also be used as LIFO (Last-In-First-Out) stacks. This
interface should be used in preference to the legacy <code>Stack</code> class.
When a deque is used as a stack, elements are pushed and popped from the
beginning of the deque. Stack methods are precisely equivalent to
<tt>Deque</tt> methods as indicated in the table below:
<p>
<table BORDER CELLPADDING=3 CELLSPACING=1>
<tr>
<td ALIGN=CENTER> <b>Stack Method</b></td>
<td ALIGN=CENTER> <b>Equivalent <tt>Deque</tt> Method</b></td>
</tr>
<tr>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#push(java.lang.Object)"><code>push(e)</code></a></td>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#addFirst(java.lang.Object)"><code>addFirst(e)</code></a></td>
</tr>
<tr>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#pop()"><code>pop()</code></a></td>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#removeFirst()"><code>removeFirst()</code></a></td>
</tr>
<tr>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#peek()"><code>peek()</code></a></td>
<td><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#peekFirst()"><code>peekFirst()</code></a></td>
</tr>
</table>
<p>Note that the <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#peek()"><code>peek</code></a> method works equally well when
a deque is used as a queue or a stack; in either case, elements are
drawn from the beginning of the deque.
<p>This interface provides two methods to remove interior
elements, <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#removeFirstOccurrence(java.lang.Object)"><code>removeFirstOccurrence</code></a> and
<a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#removeLastOccurrence(java.lang.Object)"><code>removeLastOccurrence</code></a>.
<p>Unlike the <code>List</code> interface, this interface does not
provide support for indexed access to elements.
<p>While <tt>Deque</tt> implementations are not strictly required
to prohibit the insertion of null elements, they are strongly
encouraged to do so. Users of any <tt>Deque</tt> implementations
that do allow null elements are strongly encouraged <i>not</i> to
take advantage of the ability to insert nulls. This is so because
<tt>null</tt> is used as a special return value by various methods
to indicated that the deque is empty.
<p><tt>Deque</tt> implementations generally do not define
element-based versions of the <tt>equals</tt> and <tt>hashCode</tt>
methods, but instead inherit the identity-based versions from class
<tt>Object</tt>.
<p>This interface 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.6</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Doug Lea, Josh Bloch</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#add(java.lang.Object)">add</a></strong>(java.lang.Object e)</code>
<div class="block">Inserts the specified element into the queue represented by this deque
(in other words, at the tail of this deque) if it is possible to do so
immediately without violating capacity restrictions, returning
<tt>true</tt> upon success and throwing an
<tt>IllegalStateException</tt> if no space is currently available.</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/Deque.html#addFirst(java.lang.Object)">addFirst</a></strong>(java.lang.Object e)</code>
<div class="block">Inserts the specified element at the front of this deque if it is
possible to do so immediately without violating capacity restrictions.</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/Deque.html#addLast(java.lang.Object)">addLast</a></strong>(java.lang.Object e)</code>
<div class="block">Inserts the specified element at the end of this deque if it is
possible to do so immediately without violating capacity restrictions.</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/Deque.html#contains(java.lang.Object)">contains</a></strong>(java.lang.Object o)</code>
<div class="block">Returns <tt>true</tt> if this deque contains the specified element.</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/Deque.html#descendingIterator()">descendingIterator</a></strong>()</code>
<div class="block">Returns an iterator over the elements in this deque in reverse
sequential order.</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/Deque.html#element()">element</a></strong>()</code>
<div class="block">Retrieves, but does not remove, the head of the queue represented by
this deque (in other words, the first element of this deque).</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/Deque.html#getFirst()">getFirst</a></strong>()</code>
<div class="block">Retrieves, but does not remove, the first element of this deque.</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/Deque.html#getLast()">getLast</a></strong>()</code>
<div class="block">Retrieves, but does not remove, the last element of this deque.</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/Deque.html#iterator()">iterator</a></strong>()</code>
<div class="block">Returns an iterator over the elements in this deque in proper sequence.</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/Deque.html#offer(java.lang.Object)">offer</a></strong>(java.lang.Object e)</code>
<div class="block">Inserts the specified element into the queue represented by this deque
(in other words, at the tail of this deque) if it is possible to do so
immediately without violating capacity restrictions, returning
<tt>true</tt> upon success and <tt>false</tt> if no space is currently
available.</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/Deque.html#offerFirst(java.lang.Object)">offerFirst</a></strong>(java.lang.Object e)</code>
<div class="block">Inserts the specified element at the front of this deque unless it would
violate capacity restrictions.</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/Deque.html#offerLast(java.lang.Object)">offerLast</a></strong>(java.lang.Object e)</code>
<div class="block">Inserts the specified element at the end of this deque unless it would
violate capacity restrictions.</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/Deque.html#peek()">peek</a></strong>()</code>
<div class="block">Retrieves, but does not remove, the head of the queue represented by
this deque (in other words, the first element of this deque), or
returns <tt>null</tt> if this deque 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/Deque.html#peekFirst()">peekFirst</a></strong>()</code>
<div class="block">Retrieves, but does not remove, the first element of this deque,
or returns <tt>null</tt> if this deque 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/Deque.html#peekLast()">peekLast</a></strong>()</code>
<div class="block">Retrieves, but does not remove, the last element of this deque,
or returns <tt>null</tt> if this deque 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/Deque.html#poll()">poll</a></strong>()</code>
<div class="block">Retrieves and removes the head of the queue represented by this deque
(in other words, the first element of this deque), or returns
<tt>null</tt> if this deque 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/Deque.html#pollFirst()">pollFirst</a></strong>()</code>
<div class="block">Retrieves and removes the first element of this deque,
or returns <tt>null</tt> if this deque 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/Deque.html#pollLast()">pollLast</a></strong>()</code>
<div class="block">Retrieves and removes the last element of this deque,
or returns <tt>null</tt> if this deque 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/Deque.html#pop()">pop</a></strong>()</code>
<div class="block">Pops an element from the stack represented by this deque.</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/Deque.html#push(java.lang.Object)">push</a></strong>(java.lang.Object e)</code>
<div class="block">Pushes an element onto the stack represented by this deque (in other
words, at the head of this deque) if it is possible to do so
immediately without violating capacity restrictions, returning
<tt>true</tt> upon success and throwing an
<tt>IllegalStateException</tt> if no space is currently available.</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/Deque.html#remove()">remove</a></strong>()</code>
<div class="block">Retrieves and removes the head of the queue represented by this deque
(in other words, the first element of this deque).</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/Deque.html#remove(java.lang.Object)">remove</a></strong>(java.lang.Object o)</code>
<div class="block">Removes the first occurrence of the specified element from this deque.</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/Deque.html#removeFirst()">removeFirst</a></strong>()</code>
<div class="block">Retrieves and removes the first element of this deque.</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/Deque.html#removeFirstOccurrence(java.lang.Object)">removeFirstOccurrence</a></strong>(java.lang.Object o)</code>
<div class="block">Removes the first occurrence of the specified element from this deque.</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/Deque.html#removeLast()">removeLast</a></strong>()</code>
<div class="block">Retrieves and removes the last element of this deque.</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/Deque.html#removeLastOccurrence(java.lang.Object)">removeLastOccurrence</a></strong>(java.lang.Object o)</code>
<div class="block">Removes the last occurrence of the specified element from this deque.</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/Deque.html#size()">size</a></strong>()</code>
<div class="block">Returns the number of elements in this deque.</div>
</td>
</tr>
</table>
<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, clear, containsAll, equals, hashCode, isEmpty, removeAll, retainAll, toArray, toArray</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addFirst(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFirst</h4>
<pre>void addFirst(java.lang.Object e)</pre>
<div class="block">Inserts the specified element at the front of this deque if it is
possible to do so immediately without violating capacity restrictions.
When using a capacity-restricted deque, it is generally preferable to
use method <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#offerFirst(java.lang.Object)"><code>offerFirst(java.lang.Object)</code></a>.</div>
<dl><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.IllegalStateException</code> - if the element cannot be added at this
time due to capacity restrictions</dd>
<dd><code>java.lang.ClassCastException</code> - if the class of the specified element
prevents it from being added to this deque</dd>
<dd><code>java.lang.NullPointerException</code> - if the specified element is null and this
deque does not permit null elements</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if some property of the specified
element prevents it from being added to this deque</dd></dl>
</li>
</ul>
<a name="addLast(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addLast</h4>
<pre>void addLast(java.lang.Object e)</pre>
<div class="block">Inserts the specified element at the end of this deque if it is
possible to do so immediately without violating capacity restrictions.
When using a capacity-restricted deque, it is generally preferable to
use method <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#offerLast(java.lang.Object)"><code>offerLast(java.lang.Object)</code></a>.
<p>This method is equivalent to <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#add(java.lang.Object)"><code>add(java.lang.Object)</code></a>.</div>
<dl><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.IllegalStateException</code> - if the element cannot be added at this
time due to capacity restrictions</dd>
<dd><code>java.lang.ClassCastException</code> - if the class of the specified element
prevents it from being added to this deque</dd>
<dd><code>java.lang.NullPointerException</code> - if the specified element is null and this
deque does not permit null elements</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if some property of the specified
element prevents it from being added to this deque</dd></dl>
</li>
</ul>
<a name="offerFirst(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>offerFirst</h4>
<pre>boolean offerFirst(java.lang.Object e)</pre>
<div class="block">Inserts the specified element at the front of this deque unless it would
violate capacity restrictions. When using a capacity-restricted deque,
this method is generally preferable to the <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#addFirst(java.lang.Object)"><code>addFirst(java.lang.Object)</code></a> method,
which can fail to insert an element only by throwing an exception.</div>
<dl><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> if the element was added to this deque, else
<tt>false</tt></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ClassCastException</code> - if the class of the specified element
prevents it from being added to this deque</dd>
<dd><code>java.lang.NullPointerException</code> - if the specified element is null and this
deque does not permit null elements</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if some property of the specified
element prevents it from being added to this deque</dd></dl>
</li>
</ul>
<a name="offerLast(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>offerLast</h4>
<pre>boolean offerLast(java.lang.Object e)</pre>
<div class="block">Inserts the specified element at the end of this deque unless it would
violate capacity restrictions. When using a capacity-restricted deque,
this method is generally preferable to the <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#addLast(java.lang.Object)"><code>addLast(java.lang.Object)</code></a> method,
which can fail to insert an element only by throwing an exception.</div>
<dl><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> if the element was added to this deque, else
<tt>false</tt></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ClassCastException</code> - if the class of the specified element
prevents it from being added to this deque</dd>
<dd><code>java.lang.NullPointerException</code> - if the specified element is null and this
deque does not permit null elements</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if some property of the specified
element prevents it from being added to this deque</dd></dl>
</li>
</ul>
<a name="removeFirst()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFirst</h4>
<pre>java.lang.Object removeFirst()</pre>
<div class="block">Retrieves and removes the first element of this deque. This method
differs from <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#pollFirst()"><code>pollFirst</code></a> only in that it throws an
exception if this deque is empty.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the head of this deque</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>NoSuchElementException</code> - if this deque is empty</dd></dl>
</li>
</ul>
<a name="removeLast()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeLast</h4>
<pre>java.lang.Object removeLast()</pre>
<div class="block">Retrieves and removes the last element of this deque. This method
differs from <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#pollLast()"><code>pollLast</code></a> only in that it throws an
exception if this deque is empty.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the tail of this deque</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>NoSuchElementException</code> - if this deque is empty</dd></dl>
</li>
</ul>
<a name="pollFirst()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pollFirst</h4>
<pre>java.lang.Object pollFirst()</pre>
<div class="block">Retrieves and removes the first element of this deque,
or returns <tt>null</tt> if this deque is empty.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the head of this deque, or <tt>null</tt> if this deque is empty</dd></dl>
</li>
</ul>
<a name="pollLast()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pollLast</h4>
<pre>java.lang.Object pollLast()</pre>
<div class="block">Retrieves and removes the last element of this deque,
or returns <tt>null</tt> if this deque is empty.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the tail of this deque, or <tt>null</tt> if this deque is empty</dd></dl>
</li>
</ul>
<a name="getFirst()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFirst</h4>
<pre>java.lang.Object getFirst()</pre>
<div class="block">Retrieves, but does not remove, the first element of this deque.
This method differs from <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#peekFirst()"><code>peekFirst</code></a> only in that it
throws an exception if this deque is empty.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the head of this deque</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>NoSuchElementException</code> - if this deque is empty</dd></dl>
</li>
</ul>
<a name="getLast()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLast</h4>
<pre>java.lang.Object getLast()</pre>
<div class="block">Retrieves, but does not remove, the last element of this deque.
This method differs from <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#peekLast()"><code>peekLast</code></a> only in that it
throws an exception if this deque is empty.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the tail of this deque</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>NoSuchElementException</code> - if this deque is empty</dd></dl>
</li>
</ul>
<a name="peekFirst()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>peekFirst</h4>
<pre>java.lang.Object peekFirst()</pre>
<div class="block">Retrieves, but does not remove, the first element of this deque,
or returns <tt>null</tt> if this deque is empty.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the head of this deque, or <tt>null</tt> if this deque is empty</dd></dl>
</li>
</ul>
<a name="peekLast()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>peekLast</h4>
<pre>java.lang.Object peekLast()</pre>
<div class="block">Retrieves, but does not remove, the last element of this deque,
or returns <tt>null</tt> if this deque is empty.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the tail of this deque, or <tt>null</tt> if this deque is empty</dd></dl>
</li>
</ul>
<a name="removeFirstOccurrence(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFirstOccurrence</h4>
<pre>boolean removeFirstOccurrence(java.lang.Object o)</pre>
<div class="block">Removes the first occurrence of the specified element from this deque.
If the deque does not contain the element, it is unchanged.
More formally, removes the first element <tt>e</tt> such that
<tt>(o==null ? e==null : o.equals(e))</tt>
(if such an element exists).
Returns <tt>true</tt> if this deque contained the specified element
(or equivalently, if this deque changed as a result of the call).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>o</code> - element to be removed from this deque, if present</dd>
<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if an element was removed as a result of this call</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ClassCastException</code> - if the class of the specified element
is incompatible with this deque (optional)</dd>
<dd><code>java.lang.NullPointerException</code> - if the specified element is null and this
deque does not permit null elements (optional)</dd></dl>
</li>
</ul>
<a name="removeLastOccurrence(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeLastOccurrence</h4>
<pre>boolean removeLastOccurrence(java.lang.Object o)</pre>
<div class="block">Removes the last occurrence of the specified element from this deque.
If the deque does not contain the element, it is unchanged.
More formally, removes the last element <tt>e</tt> such that
<tt>(o==null ? e==null : o.equals(e))</tt>
(if such an element exists).
Returns <tt>true</tt> if this deque contained the specified element
(or equivalently, if this deque changed as a result of the call).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>o</code> - element to be removed from this deque, if present</dd>
<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if an element was removed as a result of this call</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ClassCastException</code> - if the class of the specified element
is incompatible with this deque (optional)</dd>
<dd><code>java.lang.NullPointerException</code> - if the specified element is null and this
deque does not permit null elements (optional)</dd></dl>
</li>
</ul>
<a name="add(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>boolean add(java.lang.Object e)</pre>
<div class="block">Inserts the specified element into the queue represented by this deque
(in other words, at the tail of this deque) if it is possible to do so
immediately without violating capacity restrictions, returning
<tt>true</tt> upon success and throwing an
<tt>IllegalStateException</tt> if no space is currently available.
When using a capacity-restricted deque, it is generally preferable to
use <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#offer(java.lang.Object)"><code>offer</code></a>.
<p>This method is equivalent to <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#addLast(java.lang.Object)"><code>addLast(java.lang.Object)</code></a>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>add</code> in interface <code>java.util.Collection</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><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.IllegalStateException</code> - if the element cannot be added at this
time due to capacity restrictions</dd>
<dd><code>java.lang.ClassCastException</code> - if the class of the specified element
prevents it from being added to this deque</dd>
<dd><code>java.lang.NullPointerException</code> - if the specified element is null and this
deque does not permit null elements</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if some property of the specified
element prevents it from being added to this deque</dd></dl>
</li>
</ul>
<a name="offer(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>offer</h4>
<pre>boolean offer(java.lang.Object e)</pre>
<div class="block">Inserts the specified element into the queue represented by this deque
(in other words, at the tail of this deque) if it is possible to do so
immediately without violating capacity restrictions, returning
<tt>true</tt> upon success and <tt>false</tt> if no space is currently
available. When using a capacity-restricted deque, this method is
generally preferable to the <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#add(java.lang.Object)"><code>add(java.lang.Object)</code></a> method, which can fail to
insert an element only by throwing an exception.
<p>This method is equivalent to <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#offerLast(java.lang.Object)"><code>offerLast(java.lang.Object)</code></a>.</div>
<dl>
<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> if the element was added to this deque, else
<tt>false</tt></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ClassCastException</code> - if the class of the specified element
prevents it from being added to this deque</dd>
<dd><code>java.lang.NullPointerException</code> - if the specified element is null and this
deque does not permit null elements</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if some property of the specified
element prevents it from being added to this deque</dd></dl>
</li>
</ul>
<a name="remove()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>java.lang.Object remove()</pre>
<div class="block">Retrieves and removes the head of the queue represented by this deque
(in other words, the first element of this deque).
This method differs from <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#poll()"><code>poll</code></a> only in that it throws an
exception if this deque is empty.
<p>This method is equivalent to <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#removeFirst()"><code>removeFirst()</code></a>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../edu/emory/mathcs/backport/java/util/Queue.html#remove()">remove</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 the queue represented by this deque</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>NoSuchElementException</code> - if this deque is empty</dd></dl>
</li>
</ul>
<a name="poll()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>poll</h4>
<pre>java.lang.Object poll()</pre>
<div class="block">Retrieves and removes the head of the queue represented by this deque
(in other words, the first element of this deque), or returns
<tt>null</tt> if this deque is empty.
<p>This method is equivalent to <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#pollFirst()"><code>pollFirst()</code></a>.</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 first element of this deque, or <tt>null</tt> if
this deque is empty</dd></dl>
</li>
</ul>
<a name="element()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>element</h4>
<pre>java.lang.Object element()</pre>
<div class="block">Retrieves, but does not remove, the head of the queue represented by
this deque (in other words, the first element of this deque).
This method differs from <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#peek()"><code>peek</code></a> only in that it throws an
exception if this deque is empty.
<p>This method is equivalent to <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#getFirst()"><code>getFirst()</code></a>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../edu/emory/mathcs/backport/java/util/Queue.html#element()">element</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 the queue represented by this deque</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>NoSuchElementException</code> - if this deque is empty</dd></dl>
</li>
</ul>
<a name="peek()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>peek</h4>
<pre>java.lang.Object peek()</pre>
<div class="block">Retrieves, but does not remove, the head of the queue represented by
this deque (in other words, the first element of this deque), or
returns <tt>null</tt> if this deque is empty.
<p>This method is equivalent to <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#peekFirst()"><code>peekFirst()</code></a>.</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 the queue represented by this deque, or
<tt>null</tt> if this deque is empty</dd></dl>
</li>
</ul>
<a name="push(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>push</h4>
<pre>void push(java.lang.Object e)</pre>
<div class="block">Pushes an element onto the stack represented by this deque (in other
words, at the head of this deque) if it is possible to do so
immediately without violating capacity restrictions, returning
<tt>true</tt> upon success and throwing an
<tt>IllegalStateException</tt> if no space is currently available.
<p>This method is equivalent to <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#addFirst(java.lang.Object)"><code>addFirst(java.lang.Object)</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - the element to push</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the element cannot be added at this
time due to capacity restrictions</dd>
<dd><code>java.lang.ClassCastException</code> - if the class of the specified element
prevents it from being added to this deque</dd>
<dd><code>java.lang.NullPointerException</code> - if the specified element is null and this
deque does not permit null elements</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if some property of the specified
element prevents it from being added to this deque</dd></dl>
</li>
</ul>
<a name="pop()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pop</h4>
<pre>java.lang.Object pop()</pre>
<div class="block">Pops an element from the stack represented by this deque. In other
words, removes and returns the first element of this deque.
<p>This method is equivalent to <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#removeFirst()"><code>removeFirst()</code></a>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the element at the front of this deque (which is the top
of the stack represented by this deque)</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>NoSuchElementException</code> - if this deque is empty</dd></dl>
</li>
</ul>
<a name="remove(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>boolean remove(java.lang.Object o)</pre>
<div class="block">Removes the first occurrence of the specified element from this deque.
If the deque does not contain the element, it is unchanged.
More formally, removes the first element <tt>e</tt> such that
<tt>(o==null ? e==null : o.equals(e))</tt>
(if such an element exists).
Returns <tt>true</tt> if this deque contained the specified element
(or equivalently, if this deque changed as a result of the call).
<p>This method is equivalent to <a href="../../../../../../edu/emory/mathcs/backport/java/util/Deque.html#removeFirstOccurrence(java.lang.Object)"><code>removeFirstOccurrence(java.lang.Object)</code></a>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>remove</code> in interface <code>java.util.Collection</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>o</code> - element to be removed from this deque, if present</dd>
<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if an element was removed as a result of this call</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ClassCastException</code> - if the class of the specified element
is incompatible with this deque (optional)</dd>
<dd><code>java.lang.NullPointerException</code> - if the specified element is null and this
deque does not permit null elements (optional)</dd></dl>
</li>
</ul>
<a name="contains(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contains</h4>
<pre>boolean contains(java.lang.Object o)</pre>
<div class="block">Returns <tt>true</tt> if this deque contains the specified element.
More formally, returns <tt>true</tt> if and only if this deque contains
at least one element <tt>e</tt> such that
<tt>(o==null ? e==null : o.equals(e))</tt>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>contains</code> in interface <code>java.util.Collection</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>o</code> - element whose presence in this deque is to be tested</dd>
<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if this deque contains the specified element</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ClassCastException</code> - if the type of the specified element
is incompatible with this deque (optional)</dd>
<dd><code>java.lang.NullPointerException</code> - if the specified element is null and this
deque does not permit null elements (optional)</dd></dl>
</li>
</ul>
<a name="size()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>int size()</pre>
<div class="block">Returns the number of elements in this deque.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>size</code> in interface <code>java.util.Collection</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the number of elements in this deque</dd></dl>
</li>
</ul>
<a name="iterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterator</h4>
<pre>java.util.Iterator iterator()</pre>
<div class="block">Returns an iterator over the elements in this deque in proper sequence.
The elements will be returned in order from first (head) to last (tail).</div>
<dl>
<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 interface <code>java.lang.Iterable</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>an iterator over the elements in this deque in proper sequence</dd></dl>
</li>
</ul>
<a name="descendingIterator()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>descendingIterator</h4>
<pre>java.util.Iterator descendingIterator()</pre>
<div class="block">Returns an iterator over the elements in this deque in reverse
sequential order. The elements will be returned in order from
last (tail) to first (head).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an iterator over the elements in this deque in reverse
sequence</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/Collections.html" title="class in edu.emory.mathcs.backport.java.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../edu/emory/mathcs/backport/java/util/LinkedList.html" title="class in edu.emory.mathcs.backport.java.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?edu/emory/mathcs/backport/java/util/Deque.html" target="_top">Frames</a></li>
<li><a href="Deque.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|