/usr/share/doc/libcommons-collections-java/api/org/apache/commons/collections/SequencedHashMap.html is in libcommons-collections-java-doc 2.1.1-11.
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 | <!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_21) on Mon Apr 29 13:52:00 UTC 2013 -->
<title>SequencedHashMap (Jakarta Commons Collections Package)</title>
<meta name="date" content="2013-04-29">
<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="SequencedHashMap (Jakarta Commons Collections Package)";
}
//-->
</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="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/commons/collections/ReferenceMap.html" title="class in org.apache.commons.collections"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/commons/collections/SetUtils.html" title="class in org.apache.commons.collections"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/commons/collections/SequencedHashMap.html" target="_top">Frames</a></li>
<li><a href="SequencedHashMap.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">org.apache.commons.collections</div>
<h2 title="Class SequencedHashMap" class="title">Class SequencedHashMap</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.commons.collections.SequencedHashMap</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, java.util.Map</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/commons/collections/LRUMap.html" title="class in org.apache.commons.collections">LRUMap</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">SequencedHashMap</span>
extends java.lang.Object
implements java.util.Map, java.lang.Cloneable, java.io.Externalizable</pre>
<div class="block">A map of objects whose mapping entries are sequenced based on the order in
which they were added. This data structure has fast <I>O(1)</I> search
time, deletion time, and insertion time.
<P>Although this map is sequenced, it cannot implement <code>List</code> because of incompatible interface definitions. The remove
methods in List and Map have different return values (see: <code>List.remove(Object)</code> and <code>Map.remove(Object)</code>).
<P>This class is not thread safe. When a thread safe implementation is
required, use <code>Collections.synchronizedMap(Map)</code> as it is documented,
or use explicit synchronization controls.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="strong">Author:</span></dt>
<dd><a href="mailto:mas@apache.org">Michael A. Smith</A>, <a href="mailto:dlr@collab.net">Daniel Rall</a>, <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a></dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.commons.collections.SequencedHashMap">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="../../../../org/apache/commons/collections/SequencedHashMap.html#SequencedHashMap()">SequencedHashMap</a></strong>()</code>
<div class="block">Construct a new sequenced hash map with default initial size and load
factor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#SequencedHashMap(int)">SequencedHashMap</a></strong>(int initialSize)</code>
<div class="block">Construct a new sequenced hash map with the specified initial size and
default load factor.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#SequencedHashMap(int, float)">SequencedHashMap</a></strong>(int initialSize,
float loadFactor)</code>
<div class="block">Construct a new sequenced hash map with the specified initial size and
load factor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#SequencedHashMap(java.util.Map)">SequencedHashMap</a></strong>(java.util.Map m)</code>
<div class="block">Construct a new sequenced hash map and add all the elements in the
specified map.</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#clear()">clear</a></strong>()</code>
<div class="block">Implements <code>Map.clear()</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#clone()">clone</a></strong>()</code>
<div class="block">Creates a shallow copy of this object, preserving the internal structure
by copying only references.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#containsKey(java.lang.Object)">containsKey</a></strong>(java.lang.Object key)</code>
<div class="block">Implements <code>Map.containsKey(Object)</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#containsValue(java.lang.Object)">containsValue</a></strong>(java.lang.Object value)</code>
<div class="block">Implements <code>Map.containsValue(Object)</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Set</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#entrySet()">entrySet</a></strong>()</code>
<div class="block">Implements <code>Map.entrySet()</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code>
<div class="block">Implements <code>Map.equals(Object)</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#get(int)">get</a></strong>(int index)</code>
<div class="block">Returns the key at the specified index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#get(java.lang.Object)">get</a></strong>(java.lang.Object o)</code>
<div class="block">Implements <code>Map.get(Object)</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Map.Entry</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#getFirst()">getFirst</a></strong>()</code>
<div class="block">Return the entry for the "oldest" mapping.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#getFirstKey()">getFirstKey</a></strong>()</code>
<div class="block">Return the key for the "oldest" mapping.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#getFirstValue()">getFirstValue</a></strong>()</code>
<div class="block">Return the value for the "oldest" mapping.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Map.Entry</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#getLast()">getLast</a></strong>()</code>
<div class="block">Return the entry for the "newest" mapping.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#getLastKey()">getLastKey</a></strong>()</code>
<div class="block">Return the key for the "newest" mapping.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#getLastValue()">getLastValue</a></strong>()</code>
<div class="block">Return the value for the "newest" mapping.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#getValue(int)">getValue</a></strong>(int index)</code>
<div class="block">Returns the value at the specified index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#hashCode()">hashCode</a></strong>()</code>
<div class="block">Implements <code>Map.hashCode()</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#indexOf(java.lang.Object)">indexOf</a></strong>(java.lang.Object key)</code>
<div class="block">Returns the index of the specified key.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#isEmpty()">isEmpty</a></strong>()</code>
<div class="block">Implements <code>Map.isEmpty()</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Iterator</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#iterator()">iterator</a></strong>()</code>
<div class="block">Returns a key iterator.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Set</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#keySet()">keySet</a></strong>()</code>
<div class="block">Implements <code>Map.keySet()</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#lastIndexOf(java.lang.Object)">lastIndexOf</a></strong>(java.lang.Object key)</code>
<div class="block">Returns the last index of the specified key.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#put(java.lang.Object, java.lang.Object)">put</a></strong>(java.lang.Object key,
java.lang.Object value)</code>
<div class="block">Implements <code>Map.put(Object, Object)</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#putAll(java.util.Map)">putAll</a></strong>(java.util.Map t)</code>
<div class="block">Adds all the mappings in the specified map to this map, replacing any
mappings that already exist (as per <code>Map.putAll(Map)</code>).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#readExternal(java.io.ObjectInput)">readExternal</a></strong>(java.io.ObjectInput in)</code>
<div class="block">Deserializes this map from the given stream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#remove(int)">remove</a></strong>(int index)</code>
<div class="block">Removes the element at the specified index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#remove(java.lang.Object)">remove</a></strong>(java.lang.Object key)</code>
<div class="block">Implements <code>Map.remove(Object)</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#sequence()">sequence</a></strong>()</code>
<div class="block">Returns a List view of the keys rather than a set view.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#size()">size</a></strong>()</code>
<div class="block">Implements <code>Map.size()</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#toString()">toString</a></strong>()</code>
<div class="block">Provides a string representation of the entries within the map.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Collection</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#values()">values</a></strong>()</code>
<div class="block">Implements <code>Map.values()</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#writeExternal(java.io.ObjectOutput)">writeExternal</a></strong>(java.io.ObjectOutput out)</code>
<div class="block">Serializes this map to the given stream.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SequencedHashMap()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SequencedHashMap</h4>
<pre>public SequencedHashMap()</pre>
<div class="block">Construct a new sequenced hash map with default initial size and load
factor.</div>
</li>
</ul>
<a name="SequencedHashMap(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SequencedHashMap</h4>
<pre>public SequencedHashMap(int initialSize)</pre>
<div class="block">Construct a new sequenced hash map with the specified initial size and
default load factor.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>initialSize</code> - the initial size for the hash table</dd><dt><span class="strong">See Also:</span></dt><dd><code>HashMap.HashMap(int)</code></dd></dl>
</li>
</ul>
<a name="SequencedHashMap(int, float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SequencedHashMap</h4>
<pre>public SequencedHashMap(int initialSize,
float loadFactor)</pre>
<div class="block">Construct a new sequenced hash map with the specified initial size and
load factor.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>initialSize</code> - the initial size for the hash table</dd><dd><code>loadFactor</code> - the load factor for the hash table.</dd><dt><span class="strong">See Also:</span></dt><dd><code>HashMap.HashMap(int,float)</code></dd></dl>
</li>
</ul>
<a name="SequencedHashMap(java.util.Map)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SequencedHashMap</h4>
<pre>public SequencedHashMap(java.util.Map m)</pre>
<div class="block">Construct a new sequenced hash map and add all the elements in the
specified map. The order in which the mappings in the specified map are
added is defined by <a href="../../../../org/apache/commons/collections/SequencedHashMap.html#putAll(java.util.Map)"><code>putAll(Map)</code></a>.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="clear()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>public void clear()</pre>
<div class="block">Implements <code>Map.clear()</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>clear</code> in interface <code>java.util.Map</code></dd>
</dl>
</li>
</ul>
<a name="clone()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre>public java.lang.Object clone()
throws java.lang.CloneNotSupportedException</pre>
<div class="block">Creates a shallow copy of this object, preserving the internal structure
by copying only references. The keys and values themselves are not
<code>clone()</code>'d. The cloned object maintains the same sequence.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>clone</code> in class <code>java.lang.Object</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>A clone of this instance.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.CloneNotSupportedException</code> - if clone is not supported by a
subclass.</dd></dl>
</li>
</ul>
<a name="containsKey(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containsKey</h4>
<pre>public boolean containsKey(java.lang.Object key)</pre>
<div class="block">Implements <code>Map.containsKey(Object)</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>containsKey</code> in interface <code>java.util.Map</code></dd>
</dl>
</li>
</ul>
<a name="containsValue(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containsValue</h4>
<pre>public boolean containsValue(java.lang.Object value)</pre>
<div class="block">Implements <code>Map.containsValue(Object)</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>containsValue</code> in interface <code>java.util.Map</code></dd>
</dl>
</li>
</ul>
<a name="entrySet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>entrySet</h4>
<pre>public java.util.Set entrySet()</pre>
<div class="block">Implements <code>Map.entrySet()</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>entrySet</code> in interface <code>java.util.Map</code></dd>
</dl>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public boolean equals(java.lang.Object obj)</pre>
<div class="block">Implements <code>Map.equals(Object)</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>equals</code> in interface <code>java.util.Map</code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="get(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public java.lang.Object get(int index)</pre>
<div class="block">Returns the key at the specified index.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ArrayIndexOutOfBoundsException</code> - if the <code>index</code> is
<code>< 0</code> or <code>></code> the size of the map.</dd></dl>
</li>
</ul>
<a name="get(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public java.lang.Object get(java.lang.Object o)</pre>
<div class="block">Implements <code>Map.get(Object)</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>get</code> in interface <code>java.util.Map</code></dd>
</dl>
</li>
</ul>
<a name="getFirst()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFirst</h4>
<pre>public java.util.Map.Entry getFirst()</pre>
<div class="block">Return the entry for the "oldest" mapping. That is, return the Map.Entry
for the key-value pair that was first put into the map when compared to
all the other pairings in the map. This behavior is equivalent to using
<code>entrySet().iterator().next()</code>, but this method provides an
optimized implementation.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The first entry in the sequence, or <code>null</code> if the
map is empty.</dd></dl>
</li>
</ul>
<a name="getFirstKey()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFirstKey</h4>
<pre>public java.lang.Object getFirstKey()</pre>
<div class="block">Return the key for the "oldest" mapping. That is, return the key for the
mapping that was first put into the map when compared to all the other
objects in the map. This behavior is equivalent to using
<code>getFirst().getKey()</code>, but this method provides a slightly
optimized implementation.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The first key in the sequence, or <code>null</code> if the
map is empty.</dd></dl>
</li>
</ul>
<a name="getFirstValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFirstValue</h4>
<pre>public java.lang.Object getFirstValue()</pre>
<div class="block">Return the value for the "oldest" mapping. That is, return the value for
the mapping that was first put into the map when compared to all the
other objects in the map. This behavior is equivalent to using
<code>getFirst().getValue()</code>, but this method provides a slightly
optimized implementation.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The first value in the sequence, or <code>null</code> if the
map is empty.</dd></dl>
</li>
</ul>
<a name="getLast()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLast</h4>
<pre>public java.util.Map.Entry getLast()</pre>
<div class="block">Return the entry for the "newest" mapping. That is, return the Map.Entry
for the key-value pair that was first put into the map when compared to
all the other pairings in the map. The behavior is equivalent to:
<pre>
Object obj = null;
Iterator iter = entrySet().iterator();
while(iter.hasNext()) {
obj = iter.next();
}
return (Map.Entry)obj;
</pre>
However, the implementation of this method ensures an O(1) lookup of the
last key rather than O(n).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The last entry in the sequence, or <code>null</code> if the map
is empty.</dd></dl>
</li>
</ul>
<a name="getLastKey()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLastKey</h4>
<pre>public java.lang.Object getLastKey()</pre>
<div class="block">Return the key for the "newest" mapping. That is, return the key for the
mapping that was last put into the map when compared to all the other
objects in the map. This behavior is equivalent to using
<code>getLast().getKey()</code>, but this method provides a slightly
optimized implementation.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The last key in the sequence, or <code>null</code> if the map is
empty.</dd></dl>
</li>
</ul>
<a name="getLastValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLastValue</h4>
<pre>public java.lang.Object getLastValue()</pre>
<div class="block">Return the value for the "newest" mapping. That is, return the value for
the mapping that was last put into the map when compared to all the other
objects in the map. This behavior is equivalent to using
<code>getLast().getValue()</code>, but this method provides a slightly
optimized implementation.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The last value in the sequence, or <code>null</code> if the map
is empty.</dd></dl>
</li>
</ul>
<a name="getValue(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>public java.lang.Object getValue(int index)</pre>
<div class="block">Returns the value at the specified index.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ArrayIndexOutOfBoundsException</code> - if the <code>index</code> is
<code>< 0</code> or <code>></code> the size of the map.</dd></dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public int hashCode()</pre>
<div class="block">Implements <code>Map.hashCode()</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>hashCode</code> in interface <code>java.util.Map</code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="indexOf(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indexOf</h4>
<pre>public int indexOf(java.lang.Object key)</pre>
<div class="block">Returns the index of the specified key.</div>
</li>
</ul>
<a name="isEmpty()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmpty</h4>
<pre>public boolean isEmpty()</pre>
<div class="block">Implements <code>Map.isEmpty()</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>isEmpty</code> in interface <code>java.util.Map</code></dd>
</dl>
</li>
</ul>
<a name="iterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterator</h4>
<pre>public java.util.Iterator iterator()</pre>
<div class="block">Returns a key iterator.</div>
</li>
</ul>
<a name="keySet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keySet</h4>
<pre>public java.util.Set keySet()</pre>
<div class="block">Implements <code>Map.keySet()</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>keySet</code> in interface <code>java.util.Map</code></dd>
</dl>
</li>
</ul>
<a name="lastIndexOf(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lastIndexOf</h4>
<pre>public int lastIndexOf(java.lang.Object key)</pre>
<div class="block">Returns the last index of the specified key.</div>
</li>
</ul>
<a name="put(java.lang.Object, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>public java.lang.Object put(java.lang.Object key,
java.lang.Object value)</pre>
<div class="block">Implements <code>Map.put(Object, Object)</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>put</code> in interface <code>java.util.Map</code></dd>
</dl>
</li>
</ul>
<a name="putAll(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putAll</h4>
<pre>public void putAll(java.util.Map t)</pre>
<div class="block">Adds all the mappings in the specified map to this map, replacing any
mappings that already exist (as per <code>Map.putAll(Map)</code>). The order
in which the entries are added is determined by the iterator returned
from <code>Map.entrySet()</code> for the specified map.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>putAll</code> in interface <code>java.util.Map</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>t</code> - the mappings that should be added to this map.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if <code>t</code> is <code>null</code></dd></dl>
</li>
</ul>
<a name="readExternal(java.io.ObjectInput)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readExternal</h4>
<pre>public void readExternal(java.io.ObjectInput in)
throws java.io.IOException,
java.lang.ClassNotFoundException</pre>
<div class="block">Deserializes this map from the given stream.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>readExternal</code> in interface <code>java.io.Externalizable</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - the stream to deserialize from</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if the stream raises it</dd>
<dd><code>java.lang.ClassNotFoundException</code> - if the stream raises it</dd></dl>
</li>
</ul>
<a name="remove(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>public java.lang.Object remove(int index)</pre>
<div class="block">Removes the element at the specified index.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - The index of the object to remove.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The previous value coressponding the <code>key</code>, or
<code>null</code> if none existed.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ArrayIndexOutOfBoundsException</code> - if the <code>index</code> is
<code>< 0</code> or <code>></code> the size of the map.</dd></dl>
</li>
</ul>
<a name="remove(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>public java.lang.Object remove(java.lang.Object key)</pre>
<div class="block">Implements <code>Map.remove(Object)</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>remove</code> in interface <code>java.util.Map</code></dd>
</dl>
</li>
</ul>
<a name="sequence()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sequence</h4>
<pre>public java.util.List sequence()</pre>
<div class="block">Returns a List view of the keys rather than a set view. The returned
list is unmodifiable. This is required because changes to the values of
the list (using <code>ListIterator.set(Object)</code>) will
effectively remove the value from the list and reinsert that value at
the end of the list, which is an unexpected side effect of changing the
value of a list. This occurs because changing the key, changes when the
mapping is added to the map and thus where it appears in the list.
<P>An alternative to this method is to use <a href="../../../../org/apache/commons/collections/SequencedHashMap.html#keySet()"><code>keySet()</code></a></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The ordered list of keys.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/collections/SequencedHashMap.html#keySet()"><code>keySet()</code></a></dd></dl>
</li>
</ul>
<a name="size()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>public int size()</pre>
<div class="block">Implements <code>Map.size()</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>size</code> in interface <code>java.util.Map</code></dd>
</dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<div class="block">Provides a string representation of the entries within the map. The
format of the returned string may change with different releases, so this
method is suitable for debugging purposes only. If a specific format is
required, use <a href="../../../../org/apache/commons/collections/SequencedHashMap.html#entrySet()"><code>entrySet()</code></a>.<code>iterator()</code> and
iterate over the entries in the map formatting them as appropriate.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="values()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</h4>
<pre>public java.util.Collection values()</pre>
<div class="block">Implements <code>Map.values()</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>values</code> in interface <code>java.util.Map</code></dd>
</dl>
</li>
</ul>
<a name="writeExternal(java.io.ObjectOutput)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>writeExternal</h4>
<pre>public void writeExternal(java.io.ObjectOutput out)
throws java.io.IOException</pre>
<div class="block">Serializes this map to the given stream.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>writeExternal</code> in interface <code>java.io.Externalizable</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - the stream to serialize to</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if the stream raises it</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="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/commons/collections/ReferenceMap.html" title="class in org.apache.commons.collections"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/commons/collections/SetUtils.html" title="class in org.apache.commons.collections"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/commons/collections/SequencedHashMap.html" target="_top">Frames</a></li>
<li><a href="SequencedHashMap.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 ======= -->
<p class="legalCopy"><small><small>Copyright © 2001-2004 Apache Software Foundation. Documenation generated April 29 2013</small>.</small></p>
</body>
</html>
|