morgand 02/04/10 09:36:24 Added: docs/collections/api/org/apache/commons/collections AbstractBag.html Log: no message Revision Changes Path 1.1 jakarta-commons/docs/collections/api/org/apache/commons/collections/AbstractBag.html Index: AbstractBag.html =================================================================== <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc on Wed Apr 10 11:34:12 CDT 2002 --> <TITLE> Jakarta Commons Collections Package: Class AbstractBag </TITLE> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> </HEAD> <BODY BGCOLOR="white"> <!-- ========== START OF NAVBAR ========== --> <A NAME="navbar_top"><!-- --></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> PREV CLASS NEXT CLASS</FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="AbstractBag.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <!-- =========== END OF NAVBAR =========== --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> org.apache.commons.collections</FONT> <BR> Class AbstractBag</H2> <PRE> <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">java.lang.Object</A> | +--<B>org.apache.commons.collections.AbstractBag</B> </PRE> <DL> <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/commons/collections/Bag.html">Bag</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html">Collection</A></DD> </DL> <HR> <DL> <DT>public abstract class <B>AbstractBag</B><DT>extends <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A><DT>implements <A HREF="../../../../org/apache/commons/collections/Bag.html">Bag</A></DL> <P> This class provides a skeletal implementation of the <A HREF="../../../../org/apache/commons/collections/Bag.html"><CODE>Bag</CODE></A> interface to minimize the effort required for target implementations. Subclasses need only to call <A HREF="../../../../org/apache/commons/collections/AbstractBag.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> <DL> <DT><B>Author: </B><DD>Chuck Burdick, <a href="[EMAIL PROTECTED]">Michael A. Smith</a></DD> </DL> <HR> <P> <!-- ======== INNER CLASS SUMMARY ======== --> <!-- =========== FIELD SUMMARY =========== --> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE="+2"> <B>Constructor Summary</B></FONT></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#AbstractBag()">AbstractBag</A></B>()</CODE> <BR> </TD> </TR> </TABLE> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE="+2"> <B>Method Summary</B></FONT></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#add(java.lang.Object)">add</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A> o)</CODE> <BR> Add the given object to the bag and keep a count.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#add(java.lang.Object, int)">add</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A> o, int i)</CODE> <BR> Add <code>i</code> copies of the given object to the bag and keep a count.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#addAll(java.util.Collection)">addAll</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html">Collection</A> c)</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#calcTotalSize()">calcTotalSize</A></B>()</CODE> <BR> Actually walks the bag to make sure the count is correct and resets the running total</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#clear()">clear</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#contains(java.lang.Object)">contains</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A> o)</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#containsAll(org.apache.commons.collections.Bag)">containsAll</A></B>(<A HREF="../../../../org/apache/commons/collections/Bag.html">Bag</A> other)</CODE> <BR> Returns <code>true</code> if the bag contains all elements in the given collection, respecting cardinality.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#containsAll(java.util.Collection)">containsAll</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html">Collection</A> c)</CODE> <BR> Returns <code>true</code> if the bag contains all elements in the given collection, respecting cardinality.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A> o)</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#getCount(java.lang.Object)">getCount</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A> o)</CODE> <BR> Return the number of occurrences (cardinality) of the given object currently in the bag.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Map.html">Map</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#getMap()">getMap</A></B>()</CODE> <BR> Utility method for implementations to access the map that backs this bag.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#hashCode()">hashCode</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#isEmpty()">isEmpty</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Iterator.html">Iterator</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#iterator()">iterator</A></B>()</CODE> <BR> Returns an <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Iterator.html"><CODE>Iterator</CODE></A> over the entire set of members, including copies due to cardinality.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#remove(java.lang.Object)">remove</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A> o)</CODE> <BR> Remove all occurrences of the given object from the bag, and do not represent the object in the <A HREF="../../../../org/apache/commons/collections/AbstractBag.html#uniqueSet()"><CODE>uniqueSet()</CODE></A>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#remove(java.lang.Object, int)">remove</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A> o, int i)</CODE> <BR> Remove the given number of occurrences from the bag.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#removeAll(java.util.Collection)">removeAll</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html">Collection</A> c)</CODE> <BR> Remove all elements represented in the given collection, respecting cardinality.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#retainAll(org.apache.commons.collections.Bag)">retainAll</A></B>(<A HREF="../../../../org/apache/commons/collections/Bag.html">Bag</A> other)</CODE> <BR> Remove any members of the bag that are not in the given bag, respecting cardinality.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#retainAll(java.util.Collection)">retainAll</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html">Collection</A> c)</CODE> <BR> Remove any members of the bag that are not in the given collection, respecting cardinality.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#setMap(java.util.Map)">setMap</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Map.html">Map</A> m)</CODE> <BR> Utility method for implementations to set the map that backs this bag.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#size()">size</A></B>()</CODE> <BR> Returns the total number of items in the bag across all types.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A>[]</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#toArray()">toArray</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A>[]</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#toArray(java.lang.Object[])">toArray</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A>[] a)</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Set.html">Set</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#uniqueSet()">uniqueSet</A></B>()</CODE> <BR> The <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Set.html"><CODE>Set</CODE></A> of unique members that represent all members in the bag.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A></B></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#clone()">clone</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#finalize()">finalize</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#getClass()">getClass</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#notify()">notify</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#toString()">toString</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#wait()">wait</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#wait(long)">wait</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#wait(long, int)">wait</A></CODE></TD> </TR> </TABLE> <P> <!-- ============ FIELD DETAIL =========== --> <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_detail"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1><FONT SIZE="+2"> <B>Constructor Detail</B></FONT></TD> </TR> </TABLE> <A NAME="AbstractBag()"><!-- --></A><H3> AbstractBag</H3> <PRE> public <B>AbstractBag</B>()</PRE> <DL> </DL> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1><FONT SIZE="+2"> <B>Method Detail</B></FONT></TD> </TR> </TABLE> <A NAME="add(java.lang.Object)"><!-- --></A><H3> add</H3> <PRE> public boolean <B>add</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A> o)</PRE> <DL> <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/commons/collections/Bag.html">Bag</A></CODE></B></DD> <DD>Add the given object to the bag and keep a count. If the object is already in the <A HREF="../../../../org/apache/commons/collections/Bag.html#uniqueSet()"><CODE>Bag.uniqueSet()</CODE></A> then increment its count as reported by <A HREF="../../../../org/apache/commons/collections/Bag.html#getCount(java.lang.Object)"><CODE>Bag.getCount(Object)</CODE></A>. Otherwise add it to the <A HREF="../../../../org/apache/commons/collections/Bag.html#uniqueSet()"><CODE>Bag.uniqueSet()</CODE></A> and report its count as 1.<DD><DL> <DT><B>Specified by: </B><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">Bag</A></CODE></DL> </DD> <DD>Following copied from interface: <CODE>org.apache.commons.collections.Bag</CODE></DD> <DD><DL> <DT><B>Returns:</B><DD><code>true</code> if the object was not already in the <code>uniqueSet</code><DT><B>See Also: </B><DD><A HREF="../../../../org/apache/commons/collections/Bag.html#getCount(java.lang.Object)"><CODE>Bag.getCount(Object)</CODE></A></DL> </DD> </DL> <HR> <A NAME="add(java.lang.Object, int)"><!-- --></A><H3> add</H3> <PRE> public boolean <B>add</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A> o, int i)</PRE> <DL> <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/commons/collections/Bag.html">Bag</A></CODE></B></DD> <DD>Add <code>i</code> copies of the given object to the bag and keep a count.<DD><DL> <DT><B>Specified by: </B><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">Bag</A></CODE></DL> </DD> <DD>Following copied from interface: <CODE>org.apache.commons.collections.Bag</CODE></DD> <DD><DL> <DT><B>Returns:</B><DD><code>true</code> if the object was not already in the <code>uniqueSet</code><DT><B>See Also: </B><DD><A HREF="../../../../org/apache/commons/collections/Bag.html#add(java.lang.Object)"><CODE>Bag.add(Object)</CODE></A>, <A HREF="../../../../org/apache/commons/collections/Bag.html#getCount(java.lang.Object)"><CODE>Bag.getCount(Object)</CODE></A></DL> </DD> </DL> <HR> <A NAME="addAll(java.util.Collection)"><!-- --></A><H3> addAll</H3> <PRE> public boolean <B>addAll</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html">Collection</A> c)</PRE> <DL> <DD><DL> <DT><B>Specified by: </B><DD><CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html#addAll(java.util.Collection)">addAll</A></CODE> in interface <CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html">Collection</A></CODE></DL> </DD> </DL> <HR> <A NAME="calcTotalSize()"><!-- --></A><H3> calcTotalSize</H3> <PRE> protected int <B>calcTotalSize</B>()</PRE> <DL> <DD>Actually walks the bag to make sure the count is correct and resets the running total<DD><DL> </DL> </DD> </DL> <HR> <A NAME="clear()"><!-- --></A><H3> clear</H3> <PRE> public void <B>clear</B>()</PRE> <DL> <DD><DL> <DT><B>Specified by: </B><DD><CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html#clear()">clear</A></CODE> in interface <CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html">Collection</A></CODE></DL> </DD> </DL> <HR> <A NAME="contains(java.lang.Object)"><!-- --></A><H3> contains</H3> <PRE> public boolean <B>contains</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A> o)</PRE> <DL> <DD><DL> <DT><B>Specified by: </B><DD><CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html#contains(java.lang.Object)">contains</A></CODE> in interface <CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html">Collection</A></CODE></DL> </DD> </DL> <HR> <A NAME="containsAll(org.apache.commons.collections.Bag)"><!-- --></A><H3> containsAll</H3> <PRE> public boolean <B>containsAll</B>(<A HREF="../../../../org/apache/commons/collections/Bag.html">Bag</A> other)</PRE> <DL> <DD>Returns <code>true</code> if the bag contains all elements in the given collection, respecting cardinality.<DD><DL> </DL> </DD> <DD><DL> <DT><B>See Also: </B><DD><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#containsAll(java.util.Collection)"><CODE>containsAll(Collection)</CODE></A></DL> </DD> </DL> <HR> <A NAME="containsAll(java.util.Collection)"><!-- --></A><H3> containsAll</H3> <PRE> public boolean <B>containsAll</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html">Collection</A> c)</PRE> <DL> <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/commons/collections/Bag.html">Bag</A></CODE></B></DD> <DD>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>.<DD><DL> <DT><B>Specified by: </B><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">Bag</A></CODE></DL> </DD> </DL> <HR> <A NAME="equals(java.lang.Object)"><!-- --></A><H3> equals</H3> <PRE> public boolean <B>equals</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A> o)</PRE> <DL> <DD><DL> <DT><B>Specified by: </B><DD><CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html#equals(java.lang.Object)">equals</A></CODE> in interface <CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html">Collection</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#equals(java.lang.Object)">equals</A></CODE> in class <CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A></CODE></DL> </DD> </DL> <HR> <A NAME="getCount(java.lang.Object)"><!-- --></A><H3> getCount</H3> <PRE> public int <B>getCount</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A> o)</PRE> <DL> <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/commons/collections/Bag.html">Bag</A></CODE></B></DD> <DD>Return the number of occurrences (cardinality) of the given object currently in the bag. If the object does not exist in the bag, return 0.<DD><DL> <DT><B>Specified by: </B><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">Bag</A></CODE></DL> </DD> </DL> <HR> <A NAME="getMap()"><!-- --></A><H3> getMap</H3> <PRE> protected <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Map.html">Map</A> <B>getMap</B>()</PRE> <DL> <DD>Utility method for implementations to access the map that backs this bag. Not intended for interactive use outside of subclasses.<DD><DL> </DL> </DD> </DL> <HR> <A NAME="hashCode()"><!-- --></A><H3> hashCode</H3> <PRE> public int <B>hashCode</B>()</PRE> <DL> <DD><DL> <DT><B>Specified by: </B><DD><CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html#hashCode()">hashCode</A></CODE> in interface <CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html">Collection</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#hashCode()">hashCode</A></CODE> in class <CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A></CODE></DL> </DD> </DL> <HR> <A NAME="isEmpty()"><!-- --></A><H3> isEmpty</H3> <PRE> public boolean <B>isEmpty</B>()</PRE> <DL> <DD><DL> <DT><B>Specified by: </B><DD><CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html#isEmpty()">isEmpty</A></CODE> in interface <CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html">Collection</A></CODE></DL> </DD> </DL> <HR> <A NAME="iterator()"><!-- --></A><H3> iterator</H3> <PRE> public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Iterator.html">Iterator</A> <B>iterator</B>()</PRE> <DL> <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/commons/collections/Bag.html">Bag</A></CODE></B></DD> <DD>Returns an <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Iterator.html"><CODE>Iterator</CODE></A> over the entire set of members, including copies due to cardinality. This iterator is fail-fast and will not tolerate concurrent modifications.<DD><DL> <DT><B>Specified by: </B><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">Bag</A></CODE></DL> </DD> </DL> <HR> <A NAME="remove(java.lang.Object)"><!-- --></A><H3> remove</H3> <PRE> public boolean <B>remove</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A> o)</PRE> <DL> <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/commons/collections/Bag.html">Bag</A></CODE></B></DD> <DD>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>.<DD><DL> <DT><B>Specified by: </B><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">Bag</A></CODE></DL> </DD> <DD>Following copied from interface: <CODE>org.apache.commons.collections.Bag</CODE></DD> <DD><DL> <DT><B>Returns:</B><DD><code>true</code> if this call changed the collection<DT><B>See Also: </B><DD><A HREF="../../../../org/apache/commons/collections/Bag.html#remove(java.lang.Object, int)"><CODE>Bag.remove(Object, int)</CODE></A></DL> </DD> </DL> <HR> <A NAME="remove(java.lang.Object, int)"><!-- --></A><H3> remove</H3> <PRE> public boolean <B>remove</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A> o, int i)</PRE> <DL> <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/commons/collections/Bag.html">Bag</A></CODE></B></DD> <DD>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>.<DD><DL> <DT><B>Specified by: </B><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">Bag</A></CODE></DL> </DD> <DD>Following copied from interface: <CODE>org.apache.commons.collections.Bag</CODE></DD> <DD><DL> <DT><B>Returns:</B><DD><code>true</code> if this call changed the collection<DT><B>See Also: </B><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></DL> </DD> </DL> <HR> <A NAME="removeAll(java.util.Collection)"><!-- --></A><H3> removeAll</H3> <PRE> public boolean <B>removeAll</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html">Collection</A> c)</PRE> <DL> <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/commons/collections/Bag.html">Bag</A></CODE></B></DD> <DD>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.<DD><DL> <DT><B>Specified by: </B><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">Bag</A></CODE></DL> </DD> <DD>Following copied from interface: <CODE>org.apache.commons.collections.Bag</CODE></DD> <DD><DL> <DT><B>Returns:</B><DD><code>true</code> if this call changed the collection</DL> </DD> </DL> <HR> <A NAME="retainAll(org.apache.commons.collections.Bag)"><!-- --></A><H3> retainAll</H3> <PRE> public boolean <B>retainAll</B>(<A HREF="../../../../org/apache/commons/collections/Bag.html">Bag</A> other)</PRE> <DL> <DD>Remove any members of the bag that are not in the given bag, respecting cardinality.<DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD><code>true</code> if this call changed the collection<DT><B>See Also: </B><DD><A HREF="../../../../org/apache/commons/collections/AbstractBag.html#retainAll(java.util.Collection)"><CODE>retainAll(Collection)</CODE></A></DL> </DD> </DL> <HR> <A NAME="retainAll(java.util.Collection)"><!-- --></A><H3> retainAll</H3> <PRE> public boolean <B>retainAll</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html">Collection</A> c)</PRE> <DL> <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/commons/collections/Bag.html">Bag</A></CODE></B></DD> <DD>Remove any members of the bag that are not in the given collection, respecting cardinality. That is, if the given collection <code>C</code> contains <code>n</code> copies of a given object and the bag has <code>m > n</code> copies, then delete <code>m - n</code> copies from the bag. In addition, if <code>e</code> is an object in the bag but <code>!C.contains(e)</code>, then remove <code>e</code> and any of its copies.<DD><DL> <DT><B>Specified by: </B><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">Bag</A></CODE></DL> </DD> <DD>Following copied from interface: <CODE>org.apache.commons.collections.Bag</CODE></DD> <DD><DL> <DT><B>Returns:</B><DD><code>true</code> if this call changed the collection</DL> </DD> </DL> <HR> <A NAME="setMap(java.util.Map)"><!-- --></A><H3> setMap</H3> <PRE> protected void <B>setMap</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Map.html">Map</A> m)</PRE> <DL> <DD>Utility method for implementations to set the map that backs this bag. Not intended for interactive use outside of subclasses.<DD><DL> </DL> </DD> </DL> <HR> <A NAME="size()"><!-- --></A><H3> size</H3> <PRE> public int <B>size</B>()</PRE> <DL> <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/commons/collections/Bag.html">Bag</A></CODE></B></DD> <DD>Returns the total number of items in the bag across all types.<DD><DL> <DT><B>Specified by: </B><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">Bag</A></CODE></DL> </DD> </DL> <HR> <A NAME="toArray()"><!-- --></A><H3> toArray</H3> <PRE> public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A>[] <B>toArray</B>()</PRE> <DL> <DD><DL> <DT><B>Specified by: </B><DD><CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html#toArray()">toArray</A></CODE> in interface <CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html">Collection</A></CODE></DL> </DD> </DL> <HR> <A NAME="toArray(java.lang.Object[])"><!-- --></A><H3> toArray</H3> <PRE> public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A>[] <B>toArray</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A>[] a)</PRE> <DL> <DD><DL> <DT><B>Specified by: </B><DD><CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html#toArray(java.lang.Object[])">toArray</A></CODE> in interface <CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Collection.html">Collection</A></CODE></DL> </DD> </DL> <HR> <A NAME="uniqueSet()"><!-- --></A><H3> uniqueSet</H3> <PRE> public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Set.html">Set</A> <B>uniqueSet</B>()</PRE> <DL> <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/commons/collections/Bag.html">Bag</A></CODE></B></DD> <DD>The <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Set.html"><CODE>Set</CODE></A> of unique members that represent all members in the bag. Uniqueness constraints are the same as those in <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/util/Set.html"><CODE>Set</CODE></A>.<DD><DL> <DT><B>Specified by: </B><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">Bag</A></CODE></DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ========== START OF NAVBAR ========== --> <A NAME="navbar_bottom"><!-- --></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> PREV CLASS NEXT CLASS</FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="AbstractBag.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <!-- =========== END OF NAVBAR =========== --> <HR> <small>Copyright © 2001 Apache Software Foundation. Documenation generated April 10 2002</small>. </BODY> </HTML>
-- To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]> For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>