Home | History | Annotate | Download | only in collect
      1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
      2 <!--NewPage-->
      3 <HTML>
      4 <HEAD>
      5 <!-- Generated by javadoc (build 1.6.0-google-internal) on Mon Jan 04 20:47:57 PST 2010 -->
      6 <TITLE>
      7 EnumMultiset (Guava Libraries 2010.01.04)
      8 </TITLE>
      9 
     10 <META NAME="date" CONTENT="2010-01-04">
     11 
     12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
     13 
     14 <SCRIPT type="text/javascript">
     15 function windowTitle()
     16 {
     17     if (location.href.indexOf('is-external=true') == -1) {
     18         parent.document.title="EnumMultiset (Guava Libraries 2010.01.04)";
     19     }
     20 }
     21 </SCRIPT>
     22 <NOSCRIPT>
     23 </NOSCRIPT>
     24 
     25 </HEAD>
     26 
     27 <BODY BGCOLOR="white" onload="windowTitle();">
     28 <HR>
     29 
     30 
     31 <!-- ========= START OF TOP NAVBAR ======= -->
     32 <A NAME="navbar_top"><!-- --></A>
     33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
     34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
     35 <TR>
     36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
     37 <A NAME="navbar_top_firstrow"><!-- --></A>
     38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
     39   <TR ALIGN="center" VALIGN="top">
     40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
     41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
     42   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
     43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/EnumMultiset.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
     44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
     45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
     46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
     47   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
     48   </TR>
     49 </TABLE>
     50 </TD>
     51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
     52 </EM>
     53 </TD>
     54 </TR>
     55 
     56 <TR>
     57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
     58 &nbsp;<A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A>&nbsp;
     59 &nbsp;<A HREF="../../../../com/google/common/collect/ForwardingCollection.html" title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
     60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
     61   <A HREF="../../../../index.html?com/google/common/collect/EnumMultiset.html" target="_top"><B>FRAMES</B></A>  &nbsp;
     62 &nbsp;<A HREF="EnumMultiset.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
     63 &nbsp;<SCRIPT type="text/javascript">
     64   <!--
     65   if(window==top) {
     66     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
     67   }
     68   //-->
     69 </SCRIPT>
     70 <NOSCRIPT>
     71   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
     72 </NOSCRIPT>
     73 
     74 
     75 </FONT></TD>
     76 </TR>
     77 <TR>
     78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
     79   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
     80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
     81 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
     82 </TR>
     83 </TABLE>
     84 <A NAME="skip-navbar_top"></A>
     85 <!-- ========= END OF TOP NAVBAR ========= -->
     86 
     87 <HR>
     88 <!-- ======== START OF CLASS DATA ======== -->
     89 <H2>
     90 <FONT SIZE="-1">
     91 com.google.common.collect</FONT>
     92 <BR>
     93 Class EnumMultiset&lt;E extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</A>&lt;E&gt;&gt;</H2>
     94 <PRE>
     95 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
     96   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true" title="class or interface in java.util">java.util.AbstractCollection</A>&lt;E&gt;
     97       <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.google.common.collect.EnumMultiset&lt;E&gt;</B>
     98 </PRE>
     99 <DL>
    100 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;E&gt;, <A HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A>&lt;E&gt;, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;E&gt;</DD>
    101 </DL>
    102 <HR>
    103 <DL>
    104 <DT><PRE>public final class <B>EnumMultiset&lt;E extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</A>&lt;E&gt;&gt;</B><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true" title="class or interface in java.util">AbstractCollection</A>&lt;E&gt;</DL>
    105 </PRE>
    106 
    107 <P>
    108 Multiset implementation backed by an <A HREF="http://java.sun.com/javase/6/docs/api/java/util/EnumMap.html?is-external=true" title="class or interface in java.util"><CODE>EnumMap</CODE></A>.
    109 <P>
    110 
    111 <P>
    112 <DL>
    113 <DT><B>Since:</B></DT>
    114   <DD>2010.01.04 <b>stable</b> (imported from Google Collections Library)</DD>
    115 <DT><B>Author:</B></DT>
    116   <DD>Jared Levy</DD>
    117 <DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#com.google.common.collect.EnumMultiset">Serialized Form</A></DL>
    118 <HR>
    119 
    120 <P>
    121 <!-- ======== NESTED CLASS SUMMARY ======== -->
    122 
    123 <A NAME="nested_class_summary"><!-- --></A>
    124 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    125 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    126 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    127 <B>Nested Class Summary</B></FONT></TH>
    128 </TR>
    129 </TABLE>
    130 &nbsp;<A NAME="nested_classes_inherited_from_class_com.google.common.collect.Multiset"><!-- --></A>
    131 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    132 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
    133 <TH ALIGN="left"><B>Nested classes/interfaces inherited from interface com.google.common.collect.<A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A></B></TH>
    134 </TR>
    135 <TR BGCOLOR="white" CLASS="TableRowColor">
    136 <TD><CODE><A HREF="../../../../com/google/common/collect/Multiset.Entry.html" title="interface in com.google.common.collect">Multiset.Entry</A>&lt;<A HREF="../../../../com/google/common/collect/Multiset.Entry.html" title="type parameter in Multiset.Entry">E</A>&gt;</CODE></TD>
    137 </TR>
    138 </TABLE>
    139 &nbsp;
    140 
    141 <!-- ========== METHOD SUMMARY =========== -->
    142 
    143 <A NAME="method_summary"><!-- --></A>
    144 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    145 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    146 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    147 <B>Method Summary</B></FONT></TH>
    148 </TR>
    149 <TR BGCOLOR="white" CLASS="TableRowColor">
    150 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    151 <CODE>&nbsp;boolean</CODE></FONT></TD>
    152 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumMultiset.html#add(E)">add</A></B>(E&nbsp;element)</CODE>
    153 
    154 <BR>
    155 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a single occurrence of the specified element to this multiset.</TD>
    156 </TR>
    157 <TR BGCOLOR="white" CLASS="TableRowColor">
    158 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    159 <CODE>&nbsp;int</CODE></FONT></TD>
    160 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumMultiset.html#add(E, int)">add</A></B>(E&nbsp;element,
    161     int&nbsp;occurrences)</CODE>
    162 
    163 <BR>
    164 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a number of occurrences of an element to this multiset.</TD>
    165 </TR>
    166 <TR BGCOLOR="white" CLASS="TableRowColor">
    167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    168 <CODE>&nbsp;boolean</CODE></FONT></TD>
    169 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumMultiset.html#addAll(java.util.Collection)">addAll</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;? extends E&gt;&nbsp;elementsToAdd)</CODE>
    170 
    171 <BR>
    172 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    173 </TR>
    174 <TR BGCOLOR="white" CLASS="TableRowColor">
    175 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    176 <CODE>&nbsp;void</CODE></FONT></TD>
    177 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumMultiset.html#clear()">clear</A></B>()</CODE>
    178 
    179 <BR>
    180 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    181 </TR>
    182 <TR BGCOLOR="white" CLASS="TableRowColor">
    183 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    184 <CODE>&nbsp;boolean</CODE></FONT></TD>
    185 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumMultiset.html#contains(java.lang.Object)">contains</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;element)</CODE>
    186 
    187 <BR>
    188 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines whether this multiset contains the specified element.</TD>
    189 </TR>
    190 <TR BGCOLOR="white" CLASS="TableRowColor">
    191 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    192 <CODE>&nbsp;boolean</CODE></FONT></TD>
    193 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumMultiset.html#containsAll(java.util.Collection)">containsAll</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;?&gt;&nbsp;elements)</CODE>
    194 
    195 <BR>
    196 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if this multiset contains at least one occurrence of
    197  each element in the specified collection.</TD>
    198 </TR>
    199 <TR BGCOLOR="white" CLASS="TableRowColor">
    200 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    201 <CODE>&nbsp;int</CODE></FONT></TD>
    202 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumMultiset.html#count(java.lang.Object)">count</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;element)</CODE>
    203 
    204 <BR>
    205 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of occurrences of an element in this multiset (the
    206  <i>count</i> of the element).</TD>
    207 </TR>
    208 <TR BGCOLOR="white" CLASS="TableRowColor">
    209 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    210 <CODE>static
    211 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
    212 <TR ALIGN="right" VALIGN="">
    213 <TD NOWRAP><FONT SIZE="-1">
    214 <CODE>&lt;E extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</A>&lt;E&gt;&gt; 
    215 <BR>
    216 <A HREF="../../../../com/google/common/collect/EnumMultiset.html" title="class in com.google.common.collect">EnumMultiset</A>&lt;E&gt;</CODE></FONT></TD>
    217 </TR>
    218 </TABLE>
    219 </CODE></FONT></TD>
    220 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumMultiset.html#create(java.lang.Class)">create</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A>&lt;E&gt;&nbsp;type)</CODE>
    221 
    222 <BR>
    223 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an empty <code>EnumMultiset</code>.</TD>
    224 </TR>
    225 <TR BGCOLOR="white" CLASS="TableRowColor">
    226 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    227 <CODE>static
    228 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
    229 <TR ALIGN="right" VALIGN="">
    230 <TD NOWRAP><FONT SIZE="-1">
    231 <CODE>&lt;E extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</A>&lt;E&gt;&gt; 
    232 <BR>
    233 <A HREF="../../../../com/google/common/collect/EnumMultiset.html" title="class in com.google.common.collect">EnumMultiset</A>&lt;E&gt;</CODE></FONT></TD>
    234 </TR>
    235 </TABLE>
    236 </CODE></FONT></TD>
    237 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumMultiset.html#create(java.lang.Iterable)">create</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A>&lt;E&gt;&nbsp;elements)</CODE>
    238 
    239 <BR>
    240 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new <code>EnumMultiset</code> containing the specified elements.</TD>
    241 </TR>
    242 <TR BGCOLOR="white" CLASS="TableRowColor">
    243 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    244 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A>&lt;E&gt;</CODE></FONT></TD>
    245 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumMultiset.html#elementSet()">elementSet</A></B>()</CODE>
    246 
    247 <BR>
    248 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the set of distinct elements contained in this multiset.</TD>
    249 </TR>
    250 <TR BGCOLOR="white" CLASS="TableRowColor">
    251 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    252 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A>&lt;<A HREF="../../../../com/google/common/collect/Multiset.Entry.html" title="interface in com.google.common.collect">Multiset.Entry</A>&lt;E&gt;&gt;</CODE></FONT></TD>
    253 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumMultiset.html#entrySet()">entrySet</A></B>()</CODE>
    254 
    255 <BR>
    256 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a view of the contents of this multiset, grouped into <code>Multiset.Entry</code> instances, each providing an element of the multiset and
    257  the count of that element.</TD>
    258 </TR>
    259 <TR BGCOLOR="white" CLASS="TableRowColor">
    260 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    261 <CODE>&nbsp;boolean</CODE></FONT></TD>
    262 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumMultiset.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;object)</CODE>
    263 
    264 <BR>
    265 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compares the specified object with this multiset for equality.</TD>
    266 </TR>
    267 <TR BGCOLOR="white" CLASS="TableRowColor">
    268 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    269 <CODE>&nbsp;int</CODE></FONT></TD>
    270 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumMultiset.html#hashCode()">hashCode</A></B>()</CODE>
    271 
    272 <BR>
    273 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the hash code for this multiset.</TD>
    274 </TR>
    275 <TR BGCOLOR="white" CLASS="TableRowColor">
    276 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    277 <CODE>&nbsp;boolean</CODE></FONT></TD>
    278 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumMultiset.html#isEmpty()">isEmpty</A></B>()</CODE>
    279 
    280 <BR>
    281 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    282 </TR>
    283 <TR BGCOLOR="white" CLASS="TableRowColor">
    284 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    285 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A>&lt;E&gt;</CODE></FONT></TD>
    286 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumMultiset.html#iterator()">iterator</A></B>()</CODE>
    287 
    288 <BR>
    289 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    290 </TR>
    291 <TR BGCOLOR="white" CLASS="TableRowColor">
    292 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    293 <CODE>&nbsp;boolean</CODE></FONT></TD>
    294 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumMultiset.html#remove(java.lang.Object)">remove</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;element)</CODE>
    295 
    296 <BR>
    297 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes a <i>single</i> occurrence of the specified element from this
    298  multiset, if present.</TD>
    299 </TR>
    300 <TR BGCOLOR="white" CLASS="TableRowColor">
    301 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    302 <CODE>&nbsp;int</CODE></FONT></TD>
    303 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumMultiset.html#remove(java.lang.Object, int)">remove</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;element,
    304        int&nbsp;occurrences)</CODE>
    305 
    306 <BR>
    307 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes a number of occurrences of the specified element from this
    308  multiset.</TD>
    309 </TR>
    310 <TR BGCOLOR="white" CLASS="TableRowColor">
    311 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    312 <CODE>&nbsp;boolean</CODE></FONT></TD>
    313 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumMultiset.html#removeAll(java.util.Collection)">removeAll</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;?&gt;&nbsp;elementsToRemove)</CODE>
    314 
    315 <BR>
    316 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    317 </TR>
    318 <TR BGCOLOR="white" CLASS="TableRowColor">
    319 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    320 <CODE>&nbsp;boolean</CODE></FONT></TD>
    321 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumMultiset.html#retainAll(java.util.Collection)">retainAll</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;?&gt;&nbsp;elementsToRetain)</CODE>
    322 
    323 <BR>
    324 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    325 </TR>
    326 <TR BGCOLOR="white" CLASS="TableRowColor">
    327 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    328 <CODE>&nbsp;int</CODE></FONT></TD>
    329 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumMultiset.html#setCount(E, int)">setCount</A></B>(E&nbsp;element,
    330          int&nbsp;count)</CODE>
    331 
    332 <BR>
    333 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds or removes the necessary occurrences of an element such that the
    334  element attains the desired count.</TD>
    335 </TR>
    336 <TR BGCOLOR="white" CLASS="TableRowColor">
    337 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    338 <CODE>&nbsp;boolean</CODE></FONT></TD>
    339 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumMultiset.html#setCount(E, int, int)">setCount</A></B>(E&nbsp;element,
    340          int&nbsp;oldCount,
    341          int&nbsp;newCount)</CODE>
    342 
    343 <BR>
    344 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Conditionally sets the count of an element to a new value, as described in
    345  <A HREF="../../../../com/google/common/collect/Multiset.html#setCount(E, int)"><CODE>Multiset.setCount(Object, int)</CODE></A>, provided that the element has the expected
    346  current count.</TD>
    347 </TR>
    348 <TR BGCOLOR="white" CLASS="TableRowColor">
    349 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    350 <CODE>&nbsp;int</CODE></FONT></TD>
    351 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumMultiset.html#size()">size</A></B>()</CODE>
    352 
    353 <BR>
    354 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    355 </TR>
    356 <TR BGCOLOR="white" CLASS="TableRowColor">
    357 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    358 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
    359 <TD><CODE><B><A HREF="../../../../com/google/common/collect/EnumMultiset.html#toString()">toString</A></B>()</CODE>
    360 
    361 <BR>
    362 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
    363 </TR>
    364 </TABLE>
    365 &nbsp;<A NAME="methods_inherited_from_class_java.util.AbstractCollection"><!-- --></A>
    366 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    367 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
    368 <TH ALIGN="left"><B>Methods inherited from class java.util.<A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true" title="class or interface in java.util">AbstractCollection</A></B></TH>
    369 </TR>
    370 <TR BGCOLOR="white" CLASS="TableRowColor">
    371 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true#toArray()" title="class or interface in java.util">toArray</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true#toArray(T[])" title="class or interface in java.util">toArray</A></CODE></TD>
    372 </TR>
    373 </TABLE>
    374 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
    375 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    376 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
    377 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
    378 </TR>
    379 <TR BGCOLOR="white" CLASS="TableRowColor">
    380 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
    381 </TR>
    382 </TABLE>
    383 &nbsp;<A NAME="methods_inherited_from_class_java.util.Collection"><!-- --></A>
    384 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    385 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
    386 <TH ALIGN="left"><B>Methods inherited from interface java.util.<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A></B></TH>
    387 </TR>
    388 <TR BGCOLOR="white" CLASS="TableRowColor">
    389 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true#toArray()" title="class or interface in java.util">toArray</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true#toArray(T[])" title="class or interface in java.util">toArray</A></CODE></TD>
    390 </TR>
    391 </TABLE>
    392 &nbsp;
    393 <P>
    394 
    395 <!-- ============ METHOD DETAIL ========== -->
    396 
    397 <A NAME="method_detail"><!-- --></A>
    398 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    399 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    400 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    401 <B>Method Detail</B></FONT></TH>
    402 </TR>
    403 </TABLE>
    404 
    405 <A NAME="create(java.lang.Class)"><!-- --></A><H3>
    406 create</H3>
    407 <PRE>
    408 public static &lt;E extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</A>&lt;E&gt;&gt; <A HREF="../../../../com/google/common/collect/EnumMultiset.html" title="class in com.google.common.collect">EnumMultiset</A>&lt;E&gt; <B>create</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A>&lt;E&gt;&nbsp;type)</PRE>
    409 <DL>
    410 <DD>Creates an empty <code>EnumMultiset</code>.
    411 <P>
    412 <DD><DL>
    413 </DL>
    414 </DD>
    415 </DL>
    416 <HR>
    417 
    418 <A NAME="create(java.lang.Iterable)"><!-- --></A><H3>
    419 create</H3>
    420 <PRE>
    421 public static &lt;E extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</A>&lt;E&gt;&gt; <A HREF="../../../../com/google/common/collect/EnumMultiset.html" title="class in com.google.common.collect">EnumMultiset</A>&lt;E&gt; <B>create</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A>&lt;E&gt;&nbsp;elements)</PRE>
    422 <DL>
    423 <DD>Creates a new <code>EnumMultiset</code> containing the specified elements.
    424 <P>
    425 <DD><DL>
    426 <DT><B>Parameters:</B><DD><CODE>elements</CODE> - the elements that the multiset should contain
    427 <DT><B>Throws:</B>
    428 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if <code>elements</code> is empty</DL>
    429 </DD>
    430 </DL>
    431 <HR>
    432 
    433 <A NAME="entrySet()"><!-- --></A><H3>
    434 entrySet</H3>
    435 <PRE>
    436 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A>&lt;<A HREF="../../../../com/google/common/collect/Multiset.Entry.html" title="interface in com.google.common.collect">Multiset.Entry</A>&lt;E&gt;&gt; <B>entrySet</B>()</PRE>
    437 <DL>
    438 <DD>Returns a view of the contents of this multiset, grouped into <code>Multiset.Entry</code> instances, each providing an element of the multiset and
    439  the count of that element. This set contains exactly one entry for each
    440  distinct element in the multiset (thus it always has the same size as the
    441  <A HREF="../../../../com/google/common/collect/Multiset.html#elementSet()"><CODE>Multiset.elementSet()</CODE></A>). The order of the elements in the element set is
    442  unspecified.
    443 
    444  <p>The entry set is backed by the same data as the multiset, so any change
    445  to either is immediately reflected in the other. However, multiset changes
    446  may or may not be reflected in any <code>Entry</code> instances already
    447  retrieved from the entry set (this is implementation-dependent).
    448  Furthermore, implementations are not required to support modifications to
    449  the entry set at all, and the <code>Entry</code> instances themselves don't
    450  even have methods for modification. See the specific implementation class
    451  for more details on how its entry set handles modifications.
    452 
    453  <p>Invoking <A HREF="../../../../com/google/common/collect/Multiset.Entry.html#getCount()"><CODE>Multiset.Entry.getCount()</CODE></A> on an entry in the returned
    454  set always returns the current count of that element in the multiset, as
    455  opposed to the count at the time the entry was retrieved.
    456 <P>
    457 <DD><DL>
    458 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multiset.html#entrySet()">entrySet</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;E&gt;</CODE></DL>
    459 </DD>
    460 <DD><DL>
    461 
    462 <DT><B>Returns:</B><DD>a set of entries representing the data of this multiset</DL>
    463 </DD>
    464 </DL>
    465 <HR>
    466 
    467 <A NAME="size()"><!-- --></A><H3>
    468 size</H3>
    469 <PRE>
    470 public int <B>size</B>()</PRE>
    471 <DL>
    472 <DD><DL>
    473 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true#size()" title="class or interface in java.util">size</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;E&gt;</CODE></DL>
    474 </DD>
    475 <DD><DL>
    476 </DL>
    477 </DD>
    478 </DL>
    479 <HR>
    480 
    481 <A NAME="iterator()"><!-- --></A><H3>
    482 iterator</H3>
    483 <PRE>
    484 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A>&lt;E&gt; <B>iterator</B>()</PRE>
    485 <DL>
    486 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multiset.html#iterator()">Multiset</A></CODE></B></DD>
    487 <DD>
    488 
    489  <p>Elements that occur multiple times in the multiset will appear
    490  multiple times in this iterator, though not necessarily sequentially.
    491 <P>
    492 <DD><DL>
    493 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multiset.html#iterator()">iterator</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;E&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true#iterator()" title="class or interface in java.lang">iterator</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A>&lt;E&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true#iterator()" title="class or interface in java.util">iterator</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;E&gt;</CODE></DL>
    494 </DD>
    495 <DD><DL>
    496 </DL>
    497 </DD>
    498 </DL>
    499 <HR>
    500 
    501 <A NAME="count(java.lang.Object)"><!-- --></A><H3>
    502 count</H3>
    503 <PRE>
    504 public int <B>count</B>(<FONT SIZE="-1"><A HREF="http://jsr-305.googlecode.com/svn/trunk/javadoc/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</A></FONT>
    505                  <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;element)</PRE>
    506 <DL>
    507 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multiset.html#count(java.lang.Object)">Multiset</A></CODE></B></DD>
    508 <DD>Returns the number of occurrences of an element in this multiset (the
    509  <i>count</i> of the element). Note that for an <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang"><CODE>Object.equals(java.lang.Object)</CODE></A>-based
    510  multiset, this gives the same result as <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collections.html?is-external=true#frequency(java.util.Collection, java.lang.Object)" title="class or interface in java.util"><CODE>Collections.frequency(java.util.Collection<?>, java.lang.Object)</CODE></A>
    511  (which would presumably perform more poorly).
    512 
    513  <p><b>Note:</b> the utility method <A HREF="../../../../com/google/common/collect/Iterables.html#frequency(java.lang.Iterable, java.lang.Object)"><CODE>Iterables.frequency(java.lang.Iterable<?>, java.lang.Object)</CODE></A> generalizes
    514  this operation; it correctly delegates to this method when dealing with a
    515  multiset, but it can also accept any other iterable type.
    516 <P>
    517 <DD><DL>
    518 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multiset.html#count(java.lang.Object)">count</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;E&gt;</CODE></DL>
    519 </DD>
    520 <DD><DL>
    521 <DT><B>Parameters:</B><DD><CODE>element</CODE> - the element to count occurrences of
    522 <DT><B>Returns:</B><DD>the number of occurrences of the element in this multiset; possibly
    523      zero but never negative</DL>
    524 </DD>
    525 </DL>
    526 <HR>
    527 
    528 <A NAME="add(java.lang.Object,int)"><!-- --></A><A NAME="add(E, int)"><!-- --></A><H3>
    529 add</H3>
    530 <PRE>
    531 public int <B>add</B>(<FONT SIZE="-1"><A HREF="http://jsr-305.googlecode.com/svn/trunk/javadoc/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</A></FONT>
    532                E&nbsp;element,
    533                int&nbsp;occurrences)</PRE>
    534 <DL>
    535 <DD>Adds a number of occurrences of an element to this multiset. Note that if
    536  <code>occurrences == 1</code>, this method has the identical effect to <A HREF="../../../../com/google/common/collect/Multiset.html#add(E)"><CODE>Multiset.add(Object)</CODE></A>. This method is functionally equivalent (except in the case
    537  of overflow) to the call <code>addAll(Collections.nCopies(element,
    538  occurrences))</code>, which would presumably perform much more poorly.
    539 <P>
    540 <DD><DL>
    541 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multiset.html#add(E, int)">add</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;E&gt;</CODE></DL>
    542 </DD>
    543 <DD><DL>
    544 <DT><B>Parameters:</B><DD><CODE>element</CODE> - the element to add occurrences of; may be <code>null</code> only
    545      if explicitly allowed by the implementation<DD><CODE>occurrences</CODE> - the number of occurrences of the element to add. May be
    546      zero, in which case no change will be made.
    547 <DT><B>Returns:</B><DD>the count of the element before the operation; possibly zero
    548 <DT><B>Throws:</B>
    549 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the call would result in more than
    550      <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Integer.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><CODE>Integer.MAX_VALUE</CODE></A> occurrences of <code>element</code> in this
    551      multiset.</DL>
    552 </DD>
    553 </DL>
    554 <HR>
    555 
    556 <A NAME="remove(java.lang.Object, int)"><!-- --></A><H3>
    557 remove</H3>
    558 <PRE>
    559 public int <B>remove</B>(<FONT SIZE="-1"><A HREF="http://jsr-305.googlecode.com/svn/trunk/javadoc/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</A></FONT>
    560                   <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;element,
    561                   int&nbsp;occurrences)</PRE>
    562 <DL>
    563 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multiset.html#remove(java.lang.Object, int)">Multiset</A></CODE></B></DD>
    564 <DD>Removes a number of occurrences of the specified element from this
    565  multiset. If the multiset contains fewer than this number of occurrences to
    566  begin with, all occurrences will be removed.  Note that if
    567  <code>occurrences == 1</code>, this is functionally equivalent to the call
    568  <code>remove(element)</code>.
    569 <P>
    570 <DD><DL>
    571 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multiset.html#remove(java.lang.Object, int)">remove</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;E&gt;</CODE></DL>
    572 </DD>
    573 <DD><DL>
    574 <DT><B>Parameters:</B><DD><CODE>element</CODE> - the element to conditionally remove occurrences of<DD><CODE>occurrences</CODE> - the number of occurrences of the element to remove. May
    575      be zero, in which case no change will be made.
    576 <DT><B>Returns:</B><DD>the count of the element before the operation; possibly zero</DL>
    577 </DD>
    578 </DL>
    579 <HR>
    580 
    581 <A NAME="setCount(java.lang.Object,int)"><!-- --></A><A NAME="setCount(E, int)"><!-- --></A><H3>
    582 setCount</H3>
    583 <PRE>
    584 public int <B>setCount</B>(E&nbsp;element,
    585                     int&nbsp;count)</PRE>
    586 <DL>
    587 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multiset.html#setCount(E, int)">Multiset</A></CODE></B></DD>
    588 <DD>Adds or removes the necessary occurrences of an element such that the
    589  element attains the desired count.
    590 <P>
    591 <DD><DL>
    592 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multiset.html#setCount(E, int)">setCount</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;E&gt;</CODE></DL>
    593 </DD>
    594 <DD><DL>
    595 <DT><B>Parameters:</B><DD><CODE>element</CODE> - the element to add or remove occurrences of; may be null
    596      only if explicitly allowed by the implementation<DD><CODE>count</CODE> - the desired count of the element in this multiset
    597 <DT><B>Returns:</B><DD>the count of the element before the operation; possibly zero</DL>
    598 </DD>
    599 </DL>
    600 <HR>
    601 
    602 <A NAME="isEmpty()"><!-- --></A><H3>
    603 isEmpty</H3>
    604 <PRE>
    605 public boolean <B>isEmpty</B>()</PRE>
    606 <DL>
    607 <DD><DL>
    608 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true#isEmpty()" title="class or interface in java.util">isEmpty</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;E&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true#isEmpty()" title="class or interface in java.util">isEmpty</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true" title="class or interface in java.util">AbstractCollection</A>&lt;E&gt;</CODE></DL>
    609 </DD>
    610 <DD><DL>
    611 </DL>
    612 </DD>
    613 </DL>
    614 <HR>
    615 
    616 <A NAME="contains(java.lang.Object)"><!-- --></A><H3>
    617 contains</H3>
    618 <PRE>
    619 public boolean <B>contains</B>(<FONT SIZE="-1"><A HREF="http://jsr-305.googlecode.com/svn/trunk/javadoc/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</A></FONT>
    620                         <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;element)</PRE>
    621 <DL>
    622 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multiset.html#contains(java.lang.Object)">Multiset</A></CODE></B></DD>
    623 <DD>Determines whether this multiset contains the specified element.
    624 
    625  <p>This method refines <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true#contains(java.lang.Object)" title="class or interface in java.util"><CODE>Collection.contains(java.lang.Object)</CODE></A> to further specify that
    626  it <b>may not</b> throw an exception in response to <code>element</code> being
    627  null or of the wrong type.
    628 <P>
    629 <DD><DL>
    630 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multiset.html#contains(java.lang.Object)">contains</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;E&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true#contains(java.lang.Object)" title="class or interface in java.util">contains</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;E&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true#contains(java.lang.Object)" title="class or interface in java.util">contains</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true" title="class or interface in java.util">AbstractCollection</A>&lt;E&gt;</CODE></DL>
    631 </DD>
    632 <DD><DL>
    633 <DT><B>Parameters:</B><DD><CODE>element</CODE> - the element to check for
    634 <DT><B>Returns:</B><DD><code>true</code> if this multiset contains at least one occurrence of
    635      the element</DL>
    636 </DD>
    637 </DL>
    638 <HR>
    639 
    640 <A NAME="add(java.lang.Object)"><!-- --></A><A NAME="add(E)"><!-- --></A><H3>
    641 add</H3>
    642 <PRE>
    643 public boolean <B>add</B>(<FONT SIZE="-1"><A HREF="http://jsr-305.googlecode.com/svn/trunk/javadoc/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</A></FONT>
    644                    E&nbsp;element)</PRE>
    645 <DL>
    646 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multiset.html#add(E)">Multiset</A></CODE></B></DD>
    647 <DD>Adds a single occurrence of the specified element to this multiset.
    648 
    649  <p>This method refines <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true#add(E)" title="class or interface in java.util"><CODE>Collection.add(E)</CODE></A>, which only <i>ensures</i>
    650  the presence of the element, to further specify that a successful call must
    651  always increment the count of the element, and the overall size of the
    652  collection, by one.
    653 <P>
    654 <DD><DL>
    655 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multiset.html#add(E)">add</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;E&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true#add(E)" title="class or interface in java.util">add</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;E&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true#add(E)" title="class or interface in java.util">add</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true" title="class or interface in java.util">AbstractCollection</A>&lt;E&gt;</CODE></DL>
    656 </DD>
    657 <DD><DL>
    658 <DT><B>Parameters:</B><DD><CODE>element</CODE> - the element to add one occurrence of; may be null only if
    659      explicitly allowed by the implementation
    660 <DT><B>Returns:</B><DD><code>true</code> always, since this call is required to modify the
    661      multiset, unlike other <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><CODE>Collection</CODE></A> types</DL>
    662 </DD>
    663 </DL>
    664 <HR>
    665 
    666 <A NAME="remove(java.lang.Object)"><!-- --></A><H3>
    667 remove</H3>
    668 <PRE>
    669 public boolean <B>remove</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;element)</PRE>
    670 <DL>
    671 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multiset.html#remove(java.lang.Object)">Multiset</A></CODE></B></DD>
    672 <DD>Removes a <i>single</i> occurrence of the specified element from this
    673  multiset, if present.
    674 
    675  <p>This method refines <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true#remove(java.lang.Object)" title="class or interface in java.util"><CODE>Collection.remove(java.lang.Object)</CODE></A> to further specify that it
    676  <b>may not</b> throw an exception in response to <code>element</code> being null
    677  or of the wrong type.
    678 <P>
    679 <DD><DL>
    680 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multiset.html#remove(java.lang.Object)">remove</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;E&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true#remove(java.lang.Object)" title="class or interface in java.util">remove</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;E&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true#remove(java.lang.Object)" title="class or interface in java.util">remove</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true" title="class or interface in java.util">AbstractCollection</A>&lt;E&gt;</CODE></DL>
    681 </DD>
    682 <DD><DL>
    683 <DT><B>Parameters:</B><DD><CODE>element</CODE> - the element to remove one occurrence of
    684 <DT><B>Returns:</B><DD><code>true</code> if an occurrence was found and removed</DL>
    685 </DD>
    686 </DL>
    687 <HR>
    688 
    689 <A NAME="setCount(java.lang.Object,int,int)"><!-- --></A><A NAME="setCount(E, int, int)"><!-- --></A><H3>
    690 setCount</H3>
    691 <PRE>
    692 public boolean <B>setCount</B>(E&nbsp;element,
    693                         int&nbsp;oldCount,
    694                         int&nbsp;newCount)</PRE>
    695 <DL>
    696 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multiset.html#setCount(E, int, int)">Multiset</A></CODE></B></DD>
    697 <DD>Conditionally sets the count of an element to a new value, as described in
    698  <A HREF="../../../../com/google/common/collect/Multiset.html#setCount(E, int)"><CODE>Multiset.setCount(Object, int)</CODE></A>, provided that the element has the expected
    699  current count. If the current count is not <code>oldCount</code>, no change is
    700  made.
    701 <P>
    702 <DD><DL>
    703 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multiset.html#setCount(E, int, int)">setCount</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;E&gt;</CODE></DL>
    704 </DD>
    705 <DD><DL>
    706 <DT><B>Parameters:</B><DD><CODE>element</CODE> - the element to conditionally set the count of; may be null
    707      only if explicitly allowed by the implementation<DD><CODE>oldCount</CODE> - the expected present count of the element in this multiset<DD><CODE>newCount</CODE> - the desired count of the element in this multiset
    708 <DT><B>Returns:</B><DD><code>true</code> if the condition for modification was met. This
    709      implies that the multiset was indeed modified, unless
    710      <code>oldCount == newCount</code>.</DL>
    711 </DD>
    712 </DL>
    713 <HR>
    714 
    715 <A NAME="containsAll(java.util.Collection)"><!-- --></A><H3>
    716 containsAll</H3>
    717 <PRE>
    718 public boolean <B>containsAll</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;?&gt;&nbsp;elements)</PRE>
    719 <DL>
    720 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multiset.html#containsAll(java.util.Collection)">Multiset</A></CODE></B></DD>
    721 <DD>Returns <code>true</code> if this multiset contains at least one occurrence of
    722  each element in the specified collection.
    723 
    724  <p>This method refines <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true#containsAll(java.util.Collection)" title="class or interface in java.util"><CODE>Collection.containsAll(java.util.Collection<?>)</CODE></A> to further specify
    725  that it <b>may not</b> throw an exception in response to any of <code>elements</code> being null or of the wrong type.
    726 
    727  <p><b>Note:</b> this method does not take into account the occurrence
    728  count of an element in the two collections; it may still return <code>true</code> even if <code>elements</code> contains several occurrences of an element
    729  and this multiset contains only one. This is no different than any other
    730  collection type like <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><CODE>List</CODE></A>, but it may be unexpected to the user of
    731  a multiset.
    732 <P>
    733 <DD><DL>
    734 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multiset.html#containsAll(java.util.Collection)">containsAll</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;E&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true#containsAll(java.util.Collection)" title="class or interface in java.util">containsAll</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;E&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true#containsAll(java.util.Collection)" title="class or interface in java.util">containsAll</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true" title="class or interface in java.util">AbstractCollection</A>&lt;E&gt;</CODE></DL>
    735 </DD>
    736 <DD><DL>
    737 <DT><B>Parameters:</B><DD><CODE>elements</CODE> - the collection of elements to be checked for containment in
    738      this multiset
    739 <DT><B>Returns:</B><DD><code>true</code> if this multiset contains at least one occurrence of
    740      each element contained in <code>elements</code></DL>
    741 </DD>
    742 </DL>
    743 <HR>
    744 
    745 <A NAME="addAll(java.util.Collection)"><!-- --></A><H3>
    746 addAll</H3>
    747 <PRE>
    748 public boolean <B>addAll</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;? extends E&gt;&nbsp;elementsToAdd)</PRE>
    749 <DL>
    750 <DD><DL>
    751 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true#addAll(java.util.Collection)" title="class or interface in java.util">addAll</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;E&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true#addAll(java.util.Collection)" title="class or interface in java.util">addAll</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true" title="class or interface in java.util">AbstractCollection</A>&lt;E&gt;</CODE></DL>
    752 </DD>
    753 <DD><DL>
    754 </DL>
    755 </DD>
    756 </DL>
    757 <HR>
    758 
    759 <A NAME="removeAll(java.util.Collection)"><!-- --></A><H3>
    760 removeAll</H3>
    761 <PRE>
    762 public boolean <B>removeAll</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;?&gt;&nbsp;elementsToRemove)</PRE>
    763 <DL>
    764 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multiset.html#removeAll(java.util.Collection)">Multiset</A></CODE></B></DD>
    765 <DD>
    766 
    767  <p>This method refines <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true#removeAll(java.util.Collection)" title="class or interface in java.util"><CODE>Collection.removeAll(java.util.Collection<?>)</CODE></A> to further specify that
    768  it <b>may not</b> throw an exception in response to any of <code>elements</code>
    769  being null or of the wrong type.
    770 <P>
    771 <DD><DL>
    772 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multiset.html#removeAll(java.util.Collection)">removeAll</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;E&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true#removeAll(java.util.Collection)" title="class or interface in java.util">removeAll</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;E&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true#removeAll(java.util.Collection)" title="class or interface in java.util">removeAll</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true" title="class or interface in java.util">AbstractCollection</A>&lt;E&gt;</CODE></DL>
    773 </DD>
    774 <DD><DL>
    775 </DL>
    776 </DD>
    777 </DL>
    778 <HR>
    779 
    780 <A NAME="retainAll(java.util.Collection)"><!-- --></A><H3>
    781 retainAll</H3>
    782 <PRE>
    783 public boolean <B>retainAll</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;?&gt;&nbsp;elementsToRetain)</PRE>
    784 <DL>
    785 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multiset.html#retainAll(java.util.Collection)">Multiset</A></CODE></B></DD>
    786 <DD>
    787 
    788  <p>This method refines <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true#retainAll(java.util.Collection)" title="class or interface in java.util"><CODE>Collection.retainAll(java.util.Collection<?>)</CODE></A> to further specify that
    789  it <b>may not</b> throw an exception in response to any of <code>elements</code>
    790  being null or of the wrong type.
    791 <P>
    792 <DD><DL>
    793 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multiset.html#retainAll(java.util.Collection)">retainAll</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;E&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true#retainAll(java.util.Collection)" title="class or interface in java.util">retainAll</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;E&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true#retainAll(java.util.Collection)" title="class or interface in java.util">retainAll</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true" title="class or interface in java.util">AbstractCollection</A>&lt;E&gt;</CODE></DL>
    794 </DD>
    795 <DD><DL>
    796 </DL>
    797 </DD>
    798 </DL>
    799 <HR>
    800 
    801 <A NAME="clear()"><!-- --></A><H3>
    802 clear</H3>
    803 <PRE>
    804 public void <B>clear</B>()</PRE>
    805 <DL>
    806 <DD><DL>
    807 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true#clear()" title="class or interface in java.util">clear</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;E&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true#clear()" title="class or interface in java.util">clear</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true" title="class or interface in java.util">AbstractCollection</A>&lt;E&gt;</CODE></DL>
    808 </DD>
    809 <DD><DL>
    810 </DL>
    811 </DD>
    812 </DL>
    813 <HR>
    814 
    815 <A NAME="elementSet()"><!-- --></A><H3>
    816 elementSet</H3>
    817 <PRE>
    818 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A>&lt;E&gt; <B>elementSet</B>()</PRE>
    819 <DL>
    820 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multiset.html#elementSet()">Multiset</A></CODE></B></DD>
    821 <DD>Returns the set of distinct elements contained in this multiset. The
    822  element set is backed by the same data as the multiset, so any change to
    823  either is immediately reflected in the other. The order of the elements in
    824  the element set is unspecified.
    825 
    826  <p>If the element set supports any removal operations, these necessarily
    827  cause <b>all</b> occurrences of the removed element(s) to be removed from
    828  the multiset. Implementations are not expected to support the add
    829  operations, although this is possible.
    830 
    831  <p>A common use for the element set is to find the number of distinct
    832  elements in the multiset: <code>elementSet().size()</code>.
    833 <P>
    834 <DD><DL>
    835 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multiset.html#elementSet()">elementSet</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;E&gt;</CODE></DL>
    836 </DD>
    837 <DD><DL>
    838 
    839 <DT><B>Returns:</B><DD>a view of the set of distinct elements in this multiset</DL>
    840 </DD>
    841 </DL>
    842 <HR>
    843 
    844 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>
    845 equals</H3>
    846 <PRE>
    847 public boolean <B>equals</B>(<FONT SIZE="-1"><A HREF="http://jsr-305.googlecode.com/svn/trunk/javadoc/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</A></FONT>
    848                       <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;object)</PRE>
    849 <DL>
    850 <DD>Compares the specified object with this multiset for equality. Returns
    851  <code>true</code> if the given object is also a multiset and contains equal
    852  elements with equal counts, regardless of order.
    853 
    854  <p>This implementation returns <code>true</code> if <code>other</code> is a multiset
    855  of the same size and if, for each element, the two multisets have the same
    856  count.
    857 <P>
    858 <DD><DL>
    859 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multiset.html#equals(java.lang.Object)">equals</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;E&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.util">equals</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;E&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
    860 </DD>
    861 <DD><DL>
    862 </DL>
    863 </DD>
    864 </DL>
    865 <HR>
    866 
    867 <A NAME="hashCode()"><!-- --></A><H3>
    868 hashCode</H3>
    869 <PRE>
    870 public int <B>hashCode</B>()</PRE>
    871 <DL>
    872 <DD>Returns the hash code for this multiset. This is defined as the sum of
    873 
    874  <pre>  (element == null ? 0 : element.hashCode()) ^ count(element)</pre>
    875 
    876  over all distinct elements in the multiset. It follows that a multiset and
    877  its entry set always have the same hash code.
    878 
    879  <p>This implementation returns the hash code of <A HREF="../../../../com/google/common/collect/Multiset.html#entrySet()"><CODE>Multiset.entrySet()</CODE></A>.
    880 <P>
    881 <DD><DL>
    882 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multiset.html#hashCode()">hashCode</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;E&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true#hashCode()" title="class or interface in java.util">hashCode</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;E&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
    883 </DD>
    884 <DD><DL>
    885 </DL>
    886 </DD>
    887 </DL>
    888 <HR>
    889 
    890 <A NAME="toString()"><!-- --></A><H3>
    891 toString</H3>
    892 <PRE>
    893 public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE>
    894 <DL>
    895 <DD>
    896 
    897  <p>It is recommended, though not mandatory, that this method return the
    898  result of invoking <A HREF="../../../../com/google/common/collect/Multiset.html#toString()"><CODE>Multiset.toString()</CODE></A> on the <A HREF="../../../../com/google/common/collect/Multiset.html#entrySet()"><CODE>Multiset.entrySet()</CODE></A>, yielding a
    899  result such as
    900  <pre>
    901      [a x 3, c, d x 2, e]
    902  </pre>
    903 
    904  <p>This implementation returns the result of invoking <code>toString</code> on
    905  <A HREF="../../../../com/google/common/collect/Multiset.html#entrySet()"><CODE>Multiset.entrySet()</CODE></A>.
    906 <P>
    907 <DD><DL>
    908 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multiset.html#toString()">toString</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;E&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true#toString()" title="class or interface in java.util">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/AbstractCollection.html?is-external=true" title="class or interface in java.util">AbstractCollection</A>&lt;E&gt;</CODE></DL>
    909 </DD>
    910 <DD><DL>
    911 </DL>
    912 </DD>
    913 </DL>
    914 <!-- ========= END OF CLASS DATA ========= -->
    915 <HR>
    916 
    917 
    918 <!-- ======= START OF BOTTOM NAVBAR ====== -->
    919 <A NAME="navbar_bottom"><!-- --></A>
    920 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
    921 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    922 <TR>
    923 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    924 <A NAME="navbar_bottom_firstrow"><!-- --></A>
    925 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    926   <TR ALIGN="center" VALIGN="top">
    927   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    928   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    929   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    930   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/EnumMultiset.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    931   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    932   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    933   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    934   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    935   </TR>
    936 </TABLE>
    937 </TD>
    938 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    939 </EM>
    940 </TD>
    941 </TR>
    942 
    943 <TR>
    944 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    945 &nbsp;<A HREF="../../../../com/google/common/collect/EnumHashBiMap.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A>&nbsp;
    946 &nbsp;<A HREF="../../../../com/google/common/collect/ForwardingCollection.html" title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
    947 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    948   <A HREF="../../../../index.html?com/google/common/collect/EnumMultiset.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    949 &nbsp;<A HREF="EnumMultiset.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    950 &nbsp;<SCRIPT type="text/javascript">
    951   <!--
    952   if(window==top) {
    953     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
    954   }
    955   //-->
    956 </SCRIPT>
    957 <NOSCRIPT>
    958   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
    959 </NOSCRIPT>
    960 
    961 
    962 </FONT></TD>
    963 </TR>
    964 <TR>
    965 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    966   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    967 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    968 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    969 </TR>
    970 </TABLE>
    971 <A NAME="skip-navbar_bottom"></A>
    972 <!-- ======== END OF BOTTOM NAVBAR ======= -->
    973 
    974 <HR>
    975 
    976 </BODY>
    977 </HTML>
    978