/usr/share/doc/libcommons-collections-java/api/org/apache/commons/collections/DefaultMapBag.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 | <!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:51:59 UTC 2013 -->
<title>DefaultMapBag (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="DefaultMapBag (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/CursorableLinkedList.Cursor.html" title="class in org.apache.commons.collections"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/commons/collections/DefaultMapEntry.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/DefaultMapBag.html" target="_top">Frames</a></li>
<li><a href="DefaultMapBag.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 DefaultMapBag" class="title">Class DefaultMapBag</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.commons.collections.DefaultMapBag</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Iterable, java.util.Collection, <a href="../../../../org/apache/commons/collections/Bag.html" title="interface in org.apache.commons.collections">Bag</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/commons/collections/HashBag.html" title="class in org.apache.commons.collections">HashBag</a>, <a href="../../../../org/apache/commons/collections/TreeBag.html" title="class in org.apache.commons.collections">TreeBag</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">DefaultMapBag</span>
extends java.lang.Object
implements <a href="../../../../org/apache/commons/collections/Bag.html" title="interface in org.apache.commons.collections">Bag</a></pre>
<div class="block">This class provides a skeletal implementation of the <a href="../../../../org/apache/commons/collections/Bag.html" title="interface in org.apache.commons.collections"><code>Bag</code></a>
interface to minimize the effort required for target implementations.
Subclasses need only to call <a href="../../../../org/apache/commons/collections/DefaultMapBag.html#setMap(java.util.Map)"><code>setMap(Map)</code></a> in their constructor
specifying a map instance that will be used to store the contents of
the bag.<P>
The map will be used to map bag elements to a number; the number represents
the number of occurrences of that element in the bag.<P></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Chuck Burdick, <a href="mailto:mas@apache.org">Michael A. Smith</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/DefaultMapBag.html#DefaultMapBag()">DefaultMapBag</a></strong>()</code>
<div class="block">Constructor.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#add(java.lang.Object)">add</a></strong>(java.lang.Object o)</code>
<div class="block">Adds a new element to the bag by incrementing its count in the
underlying map.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#add(java.lang.Object, int)">add</a></strong>(java.lang.Object o,
int i)</code>
<div class="block">Adds a new element to the bag by incrementing its count in the map.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#addAll(java.util.Collection)">addAll</a></strong>(java.util.Collection c)</code>
<div class="block">Invokes <a href="../../../../org/apache/commons/collections/DefaultMapBag.html#add(java.lang.Object)"><code>add(Object)</code></a> for each element in the given collection.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#calcTotalSize()">calcTotalSize</a></strong>()</code>
<div class="block">Actually walks the bag to make sure the count is correct and
resets the running total</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#clear()">clear</a></strong>()</code>
<div class="block">Clears the bag by clearing the underlying map.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#contains(java.lang.Object)">contains</a></strong>(java.lang.Object o)</code>
<div class="block">Determines if the bag contains the given element by checking if the
underlying map contains the element as a key.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#containsAll(org.apache.commons.collections.Bag)">containsAll</a></strong>(<a href="../../../../org/apache/commons/collections/Bag.html" title="interface in org.apache.commons.collections">Bag</a> other)</code>
<div class="block">Returns <code>true</code> if the bag contains all elements in
the given collection, respecting cardinality.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#containsAll(java.util.Collection)">containsAll</a></strong>(java.util.Collection c)</code>
<div class="block"><I>(Violation)</I>
Returns <code>true</code> if the bag contains all elements in
the given collection, respecting cardinality.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object o)</code>
<div class="block">Returns true if the given object is not null, has the precise type
of this bag, and contains the same number of occurrences of all the
same elements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#getCount(java.lang.Object)">getCount</a></strong>(java.lang.Object o)</code>
<div class="block">Returns the number of occurrence of the given element in this bag
by looking up its count in the underlying map.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Map</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#getMap()">getMap</a></strong>()</code>
<div class="block">Utility method for implementations to access the map that backs
this bag.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#hashCode()">hashCode</a></strong>()</code>
<div class="block">Returns the hash code of the underlying map.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#isEmpty()">isEmpty</a></strong>()</code>
<div class="block">Returns true if the underlying map is empty.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Iterator</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#iterator()">iterator</a></strong>()</code>
<div class="block">Returns an <code>Iterator</code> over the entire set of members,
including copies due to cardinality.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#remove(java.lang.Object)">remove</a></strong>(java.lang.Object o)</code>
<div class="block"><I>(Violation)</I>
Remove all occurrences of the given object from the bag, and do
not represent the object in the <a href="../../../../org/apache/commons/collections/Bag.html#uniqueSet()"><code>Bag.uniqueSet()</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#remove(java.lang.Object, int)">remove</a></strong>(java.lang.Object o,
int i)</code>
<div class="block">Remove the given number of occurrences from the bag.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#removeAll(java.util.Collection)">removeAll</a></strong>(java.util.Collection c)</code>
<div class="block"><I>(Violation)</I>
Remove all elements represented in the given collection,
respecting cardinality.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#retainAll(org.apache.commons.collections.Bag)">retainAll</a></strong>(<a href="../../../../org/apache/commons/collections/Bag.html" title="interface in org.apache.commons.collections">Bag</a> other)</code>
<div class="block">Remove any members of the bag that are not in the given
bag, respecting cardinality.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#retainAll(java.util.Collection)">retainAll</a></strong>(java.util.Collection c)</code>
<div class="block">Remove any members of the bag that are not in the given
bag, respecting cardinality.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#setMap(java.util.Map)">setMap</a></strong>(java.util.Map m)</code>
<div class="block">Utility method for implementations to set the map that backs
this bag.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#size()">size</a></strong>()</code>
<div class="block">Returns the number of elements in this bag.</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/DefaultMapBag.html#toArray()">toArray</a></strong>()</code>
<div class="block">Returns an array of all of this bag's elements.</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/DefaultMapBag.html#toArray(java.lang.Object[])">toArray</a></strong>(java.lang.Object[] a)</code>
<div class="block">Returns an array of all of this bag's elements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#toString()">toString</a></strong>()</code>
<div class="block">Implement a toString() method suitable for debugging</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/DefaultMapBag.html#uniqueSet()">uniqueSet</a></strong>()</code>
<div class="block">Returns an unmodifiable view of the underlying map's key set.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, 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="DefaultMapBag()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DefaultMapBag</h4>
<pre>public DefaultMapBag()</pre>
<div class="block">Constructor. Subclasses should invoke <a href="../../../../org/apache/commons/collections/DefaultMapBag.html#setMap(java.util.Map)"><code>setMap(Map)</code></a> in
their constructors.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="add(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public boolean add(java.lang.Object o)</pre>
<div class="block">Adds a new element to the bag by incrementing its count in the
underlying map.</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="../../../../org/apache/commons/collections/Bag.html#add(java.lang.Object)">add</a></code> in interface <code><a href="../../../../org/apache/commons/collections/Bag.html" title="interface in org.apache.commons.collections">Bag</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the object was not already in the
<code>uniqueSet</code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/collections/Bag.html#add(java.lang.Object)"><code>Bag.add(Object)</code></a></dd></dl>
</li>
</ul>
<a name="add(java.lang.Object, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public boolean add(java.lang.Object o,
int i)</pre>
<div class="block">Adds a new element to the bag by incrementing its count in the map.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/commons/collections/Bag.html#add(java.lang.Object, int)">add</a></code> in interface <code><a href="../../../../org/apache/commons/collections/Bag.html" title="interface in org.apache.commons.collections">Bag</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the object was not already in the
<code>uniqueSet</code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/collections/Bag.html#add(java.lang.Object, int)"><code>Bag.add(Object, int)</code></a></dd></dl>
</li>
</ul>
<a name="addAll(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addAll</h4>
<pre>public boolean addAll(java.util.Collection c)</pre>
<div class="block">Invokes <a href="../../../../org/apache/commons/collections/DefaultMapBag.html#add(java.lang.Object)"><code>add(Object)</code></a> for each element in the given collection.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>addAll</code> in interface <code>java.util.Collection</code></dd>
<dt><span class="strong">See Also:</span></dt><dd><code>Collection.addAll(Collection)</code></dd></dl>
</li>
</ul>
<a name="calcTotalSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>calcTotalSize</h4>
<pre>protected int calcTotalSize()</pre>
<div class="block">Actually walks the bag to make sure the count is correct and
resets the running total</div>
</li>
</ul>
<a name="clear()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>public void clear()</pre>
<div class="block">Clears the bag by clearing the underlying map.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>clear</code> in interface <code>java.util.Collection</code></dd>
</dl>
</li>
</ul>
<a name="contains(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contains</h4>
<pre>public boolean contains(java.lang.Object o)</pre>
<div class="block">Determines if the bag contains the given element by checking if the
underlying map contains the element as a key.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>contains</code> in interface <code>java.util.Collection</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the bag contains the given element</dd></dl>
</li>
</ul>
<a name="containsAll(org.apache.commons.collections.Bag)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containsAll</h4>
<pre>public boolean containsAll(<a href="../../../../org/apache/commons/collections/Bag.html" title="interface in org.apache.commons.collections">Bag</a> other)</pre>
<div class="block">Returns <code>true</code> if the bag contains all elements in
the given collection, respecting cardinality.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#containsAll(java.util.Collection)"><code>containsAll(Collection)</code></a></dd></dl>
</li>
</ul>
<a name="containsAll(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containsAll</h4>
<pre>public boolean containsAll(java.util.Collection c)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/commons/collections/Bag.html#containsAll(java.util.Collection)">Bag</a></code></strong></div>
<div class="block"><I>(Violation)</I>
Returns <code>true</code> if the bag contains all elements in
the given collection, respecting cardinality. That is, if the
given collection <code>C</code> contains <code>n</code> copies
of a given object, calling <a href="../../../../org/apache/commons/collections/Bag.html#getCount(java.lang.Object)"><code>Bag.getCount(Object)</code></a> on that object must
be <code>>= n</code> for all <code>n</code> in <code>C</code>.
<P>The <code>Collection.containsAll(Collection)</code> method specifies
that cardinality should <I>not</I> be respected; this method should
return true if the bag contains at least one of every object contained
in the given collection. A future version of this method will comply
with that contract.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>containsAll</code> in interface <code>java.util.Collection</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/commons/collections/Bag.html#containsAll(java.util.Collection)">containsAll</a></code> in interface <code><a href="../../../../org/apache/commons/collections/Bag.html" title="interface in org.apache.commons.collections">Bag</a></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 o)</pre>
<div class="block">Returns true if the given object is not null, has the precise type
of this bag, and contains the same number of occurrences of all the
same elements.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>equals</code> in interface <code>java.util.Collection</code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>o</code> - the object to test for equality</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if that object equals this bag</dd></dl>
</li>
</ul>
<a name="getCount(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCount</h4>
<pre>public int getCount(java.lang.Object o)</pre>
<div class="block">Returns the number of occurrence of the given element in this bag
by looking up its count in the underlying map.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/commons/collections/Bag.html#getCount(java.lang.Object)">getCount</a></code> in interface <code><a href="../../../../org/apache/commons/collections/Bag.html" title="interface in org.apache.commons.collections">Bag</a></code></dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/collections/Bag.html#getCount(java.lang.Object)"><code>Bag.getCount(Object)</code></a></dd></dl>
</li>
</ul>
<a name="getMap()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMap</h4>
<pre>protected java.util.Map getMap()</pre>
<div class="block">Utility method for implementations to access the map that backs
this bag. Not intended for interactive use outside of
subclasses.</div>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public int hashCode()</pre>
<div class="block">Returns the hash code of the underlying map.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>hashCode</code> in interface <code>java.util.Collection</code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the hash code of the underlying map</dd></dl>
</li>
</ul>
<a name="isEmpty()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmpty</h4>
<pre>public boolean isEmpty()</pre>
<div class="block">Returns true if the underlying map is empty.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>isEmpty</code> in interface <code>java.util.Collection</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>true if there are no elements in this bag</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"><strong>Description copied from interface: <code><a href="../../../../org/apache/commons/collections/Bag.html#iterator()">Bag</a></code></strong></div>
<div class="block">Returns an <code>Iterator</code> over the entire set of members,
including copies due to cardinality. This iterator is fail-fast
and will not tolerate concurrent modifications.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>iterator</code> in interface <code>java.lang.Iterable</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>iterator</code> in interface <code>java.util.Collection</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/commons/collections/Bag.html#iterator()">iterator</a></code> in interface <code><a href="../../../../org/apache/commons/collections/Bag.html" title="interface in org.apache.commons.collections">Bag</a></code></dd>
</dl>
</li>
</ul>
<a name="remove(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>public boolean remove(java.lang.Object o)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/commons/collections/Bag.html#remove(java.lang.Object)">Bag</a></code></strong></div>
<div class="block"><I>(Violation)</I>
Remove all occurrences of the given object from the bag, and do
not represent the object in the <a href="../../../../org/apache/commons/collections/Bag.html#uniqueSet()"><code>Bag.uniqueSet()</code></a>.
<P>According to the <code>Collection.remove(Object)</code> method,
this method should only remove the <I>first</I> occurrence of the
given object, not <I>all</I> occurrences. A future version of this
method will comply with the contract by only removing one occurrence
of the given object.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>remove</code> in interface <code>java.util.Collection</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/commons/collections/Bag.html#remove(java.lang.Object)">remove</a></code> in interface <code><a href="../../../../org/apache/commons/collections/Bag.html" title="interface in org.apache.commons.collections">Bag</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if this call changed the collection</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/collections/Bag.html#remove(java.lang.Object, int)"><code>Bag.remove(Object, int)</code></a></dd></dl>
</li>
</ul>
<a name="remove(java.lang.Object, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>public boolean remove(java.lang.Object o,
int i)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/commons/collections/Bag.html#remove(java.lang.Object, int)">Bag</a></code></strong></div>
<div class="block">Remove the given number of occurrences from the bag. If the bag
contains <code>i</code> occurrences or less, the item will be
removed from the <a href="../../../../org/apache/commons/collections/Bag.html#uniqueSet()"><code>Bag.uniqueSet()</code></a>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/commons/collections/Bag.html#remove(java.lang.Object, int)">remove</a></code> in interface <code><a href="../../../../org/apache/commons/collections/Bag.html" title="interface in org.apache.commons.collections">Bag</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if this call changed the collection</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/collections/Bag.html#getCount(java.lang.Object)"><code>Bag.getCount(Object)</code></a>,
<a href="../../../../org/apache/commons/collections/Bag.html#remove(java.lang.Object)"><code>Bag.remove(Object)</code></a></dd></dl>
</li>
</ul>
<a name="removeAll(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAll</h4>
<pre>public boolean removeAll(java.util.Collection c)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/commons/collections/Bag.html#removeAll(java.util.Collection)">Bag</a></code></strong></div>
<div class="block"><I>(Violation)</I>
Remove all elements represented in the given collection,
respecting cardinality. That is, if the given collection
<code>C</code> contains <code>n</code> copies of a given object,
the bag will have <code>n</code> fewer copies, assuming the bag
had at least <code>n</code> copies to begin with.
<P>The <code>Collection.removeAll(Collection)</code> method specifies
that cardinality should <I>not</I> be respected; this method should
remove <I>all</I> occurrences of every object contained in the
given collection. A future version of this method will comply
with that contract.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>removeAll</code> in interface <code>java.util.Collection</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/commons/collections/Bag.html#removeAll(java.util.Collection)">removeAll</a></code> in interface <code><a href="../../../../org/apache/commons/collections/Bag.html" title="interface in org.apache.commons.collections">Bag</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if this call changed the collection</dd></dl>
</li>
</ul>
<a name="retainAll(org.apache.commons.collections.Bag)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retainAll</h4>
<pre>public boolean retainAll(<a href="../../../../org/apache/commons/collections/Bag.html" title="interface in org.apache.commons.collections">Bag</a> other)</pre>
<div class="block">Remove any members of the bag that are not in the given
bag, respecting cardinality.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if this call changed the collection</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/collections/DefaultMapBag.html#retainAll(java.util.Collection)"><code>retainAll(Collection)</code></a></dd></dl>
</li>
</ul>
<a name="retainAll(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retainAll</h4>
<pre>public boolean retainAll(java.util.Collection c)</pre>
<div class="block">Remove any members of the bag that are not in the given
bag, respecting cardinality.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>retainAll</code> in interface <code>java.util.Collection</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/commons/collections/Bag.html#retainAll(java.util.Collection)">retainAll</a></code> in interface <code><a href="../../../../org/apache/commons/collections/Bag.html" title="interface in org.apache.commons.collections">Bag</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>true if this call changed the collection</dd></dl>
</li>
</ul>
<a name="setMap(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMap</h4>
<pre>protected void setMap(java.util.Map m)</pre>
<div class="block">Utility method for implementations to set the map that backs
this bag. Not intended for interactive use outside of
subclasses.</div>
</li>
</ul>
<a name="size()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>public int size()</pre>
<div class="block">Returns the number of elements in this bag.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>size</code> in interface <code>java.util.Collection</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/commons/collections/Bag.html#size()">size</a></code> in interface <code><a href="../../../../org/apache/commons/collections/Bag.html" title="interface in org.apache.commons.collections">Bag</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the number of elements in this bag</dd></dl>
</li>
</ul>
<a name="toArray()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toArray</h4>
<pre>public java.lang.Object[] toArray()</pre>
<div class="block">Returns an array of all of this bag's elements.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>toArray</code> in interface <code>java.util.Collection</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>an array of all of this bag's elements</dd></dl>
</li>
</ul>
<a name="toArray(java.lang.Object[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toArray</h4>
<pre>public java.lang.Object[] toArray(java.lang.Object[] a)</pre>
<div class="block">Returns an array of all of this bag's elements.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>toArray</code> in interface <code>java.util.Collection</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>a</code> - the array to populate</dd>
<dt><span class="strong">Returns:</span></dt><dd>an array of all of this bag's elements</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">Implement a toString() method suitable for debugging</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="uniqueSet()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>uniqueSet</h4>
<pre>public java.util.Set uniqueSet()</pre>
<div class="block">Returns an unmodifiable view of the underlying map's key set.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/commons/collections/Bag.html#uniqueSet()">uniqueSet</a></code> in interface <code><a href="../../../../org/apache/commons/collections/Bag.html" title="interface in org.apache.commons.collections">Bag</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the set of unique elements in this bag</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/CursorableLinkedList.Cursor.html" title="class in org.apache.commons.collections"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/commons/collections/DefaultMapEntry.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/DefaultMapBag.html" target="_top">Frames</a></li>
<li><a href="DefaultMapBag.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>
|