KezvhLib/lib/com.google.com.collect/javadoc/com/google/common/collect/ForwardingMultiset.html

   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.5.0_06) on Wed Aug 20 17:16:45 PDT 2008 -->
   6 <TITLE>
   7 ForwardingMultiset (Google Collections Library - snapshot-20080820 (ALPHA))
   8 </TITLE>
   9
  10 <META NAME="keywords" CONTENT="com.google.common.collect.ForwardingMultiset class">
  11
  12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
  13
  14 <SCRIPT type="text/javascript">
  15 function windowTitle()
  16 {
  17     parent.document.title="ForwardingMultiset (Google Collections Library - snapshot-20080820 (ALPHA))";
  18 }
  19 </SCRIPT>
  20 <NOSCRIPT>
  21 </NOSCRIPT>
  22
  23 </HEAD>
  24
  25 <BODY BGCOLOR="white" onload="windowTitle();">
  26
  27
  28 <!-- ========= START OF TOP NAVBAR ======= -->
  29 <A NAME="navbar_top"><!-- --></A>
  30 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  31 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  32 <TR>
  33 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  34 <A NAME="navbar_top_firstrow"><!-- --></A>
  35 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  36   <TR ALIGN="center" VALIGN="top">
  37   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  39   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  44   </TR>
  45 </TABLE>
  46 </TD>
  47 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  48 </EM>
  49 </TD>
  50 </TR>
  51
  52 <TR>
  53 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  54 &nbsp;<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A>&nbsp;
  55 &nbsp;<A HREF="../../../../com/google/common/collect/ForwardingObject.html" title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
  56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  57   <A HREF="../../../../index.html?com/google/common/collect/ForwardingMultiset.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  58 &nbsp;<A HREF="ForwardingMultiset.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  59 &nbsp;<SCRIPT type="text/javascript">
  60   <!--
  61   if(window==top) {
  62     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  63   }
  64   //-->
  65 </SCRIPT>
  66 <NOSCRIPT>
  67   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
  68 </NOSCRIPT>
  69
  70
  71 </FONT></TD>
  72 </TR>
  73 <TR>
  74 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  75   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  76 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  77 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  78 </TR>
  79 </TABLE>
  80 <A NAME="skip-navbar_top"></A>
  81 <!-- ========= END OF TOP NAVBAR ========= -->
  82
  83 <HR>
  84 <!-- ======== START OF CLASS DATA ======== -->
  85 <H2>
  86 <FONT SIZE="-1">
  87 com.google.common.collect</FONT>
  88 <BR>
  89 Class ForwardingMultiset&lt;E&gt;</H2>
  90 <PRE>
  91 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
  92   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../com/google/common/collect/ForwardingObject.html" title="class in com.google.common.collect">com.google.common.collect.ForwardingObject</A>
  93       <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../com/google/common/collect/ForwardingCollection.html" title="class in com.google.common.collect">com.google.common.collect.ForwardingCollection</A>&lt;E&gt;
  94           <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.google.common.collect.ForwardingMultiset&lt;E&gt;</B>
  95 </PRE>
  96 <DL>
  97 <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/lang/Iterable.html" 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" title="class or interface in java.util">Collection</A>&lt;E&gt;</DD>
  98 </DL>
  99 <HR>
 100 <DL>
 101 <DT><PRE>public abstract class <B>ForwardingMultiset&lt;E&gt;</B><DT>extends <A HREF="../../../../com/google/common/collect/ForwardingCollection.html" title="class in com.google.common.collect">ForwardingCollection</A>&lt;E&gt;<DT>implements <A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;E&gt;</DL>
 102 </PRE>
 103
 104 <P>
 105 A multiset which forwards all its method calls to another multiset.
 106  Subclasses should override one or more methods to modify the behavior of the
 107  backing multiset as desired per the <a
 108  href="http://en.wikipedia.org/wiki/Decorator_pattern">decorator pattern</a>.
 109 <P>
 110
 111 <P>
 112 <DL>
 113 <DT><B>Author:</B></DT>
 114   <DD>Kevin Bourrillion</DD>
 115 <DT><B>See Also:</B><DD><A HREF="../../../../com/google/common/collect/ForwardingObject.html" title="class in com.google.common.collect"><CODE>ForwardingObject</CODE></A></DL>
 116 <HR>
 117
 118 <P>
 119 <!-- ======== NESTED CLASS SUMMARY ======== -->
 120
 121 <A NAME="nested_class_summary"><!-- --></A>
 122 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 123 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 124 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 125 <B>Nested Class Summary</B></FONT></TH>
 126 </TR>
 127 </TABLE>
 128 &nbsp;<A NAME="nested_classes_inherited_from_class_com.google.common.collect.Multiset"><!-- --></A>
 129 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 130 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 131 <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>
 132 </TR>
 133 <TR BGCOLOR="white" CLASS="TableRowColor">
 134 <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>
 135 </TR>
 136 </TABLE>
 137 &nbsp;
 138
 139 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 140
 141 <A NAME="constructor_summary"><!-- --></A>
 142 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 143 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 144 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 145 <B>Constructor Summary</B></FONT></TH>
 146 </TR>
 147 <TR BGCOLOR="white" CLASS="TableRowColor">
 148 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultiset.html#ForwardingMultiset()">ForwardingMultiset</A></B>()</CODE>
 149
 150 <BR>
 151 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 152 </TR>
 153 </TABLE>
 154 &nbsp;
 155 <!-- ========== METHOD SUMMARY =========== -->
 156
 157 <A NAME="method_summary"><!-- --></A>
 158 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 159 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 160 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 161 <B>Method Summary</B></FONT></TH>
 162 </TR>
 163 <TR BGCOLOR="white" CLASS="TableRowColor">
 164 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 165 <CODE>&nbsp;boolean</CODE></FONT></TD>
 166 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultiset.html#add(E, int)">add</A></B>(<A HREF="../../../../com/google/common/collect/ForwardingMultiset.html" title="type parameter in ForwardingMultiset">E</A>&nbsp;element,
 167     int&nbsp;occurrences)</CODE>
 168
 169 <BR>
 170 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a number of occurrences of an element to this multiset.</TD>
 171 </TR>
 172 <TR BGCOLOR="white" CLASS="TableRowColor">
 173 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 174 <CODE>&nbsp;int</CODE></FONT></TD>
 175 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultiset.html#count(java.lang.Object)">count</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;element)</CODE>
 176
 177 <BR>
 178 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of occurrences of an element in this multiset (the
 179  <i>count</i> of the element).</TD>
 180 </TR>
 181 <TR BGCOLOR="white" CLASS="TableRowColor">
 182 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 183 <CODE>protected abstract &nbsp;<A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMultiset.html" title="type parameter in ForwardingMultiset">E</A>&gt;</CODE></FONT></TD>
 184 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultiset.html#delegate()">delegate</A></B>()</CODE>
 185
 186 <BR>
 187 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the backing delegate instance that methods are forwarded to.</TD>
 188 </TR>
 189 <TR BGCOLOR="white" CLASS="TableRowColor">
 190 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 191 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMultiset.html" title="type parameter in ForwardingMultiset">E</A>&gt;</CODE></FONT></TD>
 192 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultiset.html#elementSet()">elementSet</A></B>()</CODE>
 193
 194 <BR>
 195 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the set of distinct elements contained in this multiset.</TD>
 196 </TR>
 197 <TR BGCOLOR="white" CLASS="TableRowColor">
 198 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 199 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html" 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;<A HREF="../../../../com/google/common/collect/ForwardingMultiset.html" title="type parameter in ForwardingMultiset">E</A>&gt;&gt;</CODE></FONT></TD>
 200 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultiset.html#entrySet()">entrySet</A></B>()</CODE>
 201
 202 <BR>
 203 &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
 204  the count of that element.</TD>
 205 </TR>
 206 <TR BGCOLOR="white" CLASS="TableRowColor">
 207 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 208 <CODE>&nbsp;boolean</CODE></FONT></TD>
 209 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultiset.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;obj)</CODE>
 210
 211 <BR>
 212 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates whether some other object is "equal to" this one.</TD>
 213 </TR>
 214 <TR BGCOLOR="white" CLASS="TableRowColor">
 215 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 216 <CODE>&nbsp;int</CODE></FONT></TD>
 217 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultiset.html#hashCode()">hashCode</A></B>()</CODE>
 218
 219 <BR>
 220 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a hash code value for the object.</TD>
 221 </TR>
 222 <TR BGCOLOR="white" CLASS="TableRowColor">
 223 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 224 <CODE>&nbsp;int</CODE></FONT></TD>
 225 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultiset.html#remove(java.lang.Object, int)">remove</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;element,
 226        int&nbsp;occurrences)</CODE>
 227
 228 <BR>
 229 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Conditionally removes a number of occurrences of an element from this
 230  multiset, provided that at least this many occurrences are present.</TD>
 231 </TR>
 232 <TR BGCOLOR="white" CLASS="TableRowColor">
 233 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 234 <CODE>&nbsp;int</CODE></FONT></TD>
 235 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultiset.html#removeAllOccurrences(java.lang.Object)">removeAllOccurrences</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;element)</CODE>
 236
 237 <BR>
 238 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes <b>all</b> occurrences of the specified element from this multiset.</TD>
 239 </TR>
 240 </TABLE>
 241 &nbsp;<A NAME="methods_inherited_from_class_com.google.common.collect.ForwardingCollection"><!-- --></A>
 242 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 243 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 244 <TH ALIGN="left"><B>Methods inherited from class com.google.common.collect.<A HREF="../../../../com/google/common/collect/ForwardingCollection.html" title="class in com.google.common.collect">ForwardingCollection</A></B></TH>
 245 </TR>
 246 <TR BGCOLOR="white" CLASS="TableRowColor">
 247 <TD><CODE><A HREF="../../../../com/google/common/collect/ForwardingCollection.html#add(E)">add</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#addAll(java.util.Collection)">addAll</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#clear()">clear</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#contains(java.lang.Object)">contains</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#containsAll(java.util.Collection)">containsAll</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#isEmpty()">isEmpty</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#iterator()">iterator</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#remove(java.lang.Object)">remove</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#removeAll(java.util.Collection)">removeAll</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#retainAll(java.util.Collection)">retainAll</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#size()">size</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#toArray()">toArray</A>, <A HREF="../../../../com/google/common/collect/ForwardingCollection.html#toArray(T[])">toArray</A></CODE></TD>
 248 </TR>
 249 </TABLE>
 250 &nbsp;<A NAME="methods_inherited_from_class_com.google.common.collect.ForwardingObject"><!-- --></A>
 251 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 252 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 253 <TH ALIGN="left"><B>Methods inherited from class com.google.common.collect.<A HREF="../../../../com/google/common/collect/ForwardingObject.html" title="class in com.google.common.collect">ForwardingObject</A></B></TH>
 254 </TR>
 255 <TR BGCOLOR="white" CLASS="TableRowColor">
 256 <TD><CODE><A HREF="../../../../com/google/common/collect/ForwardingObject.html#toString()">toString</A></CODE></TD>
 257 </TR>
 258 </TABLE>
 259 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 260 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 261 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 262 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH>
 263 </TR>
 264 <TR BGCOLOR="white" CLASS="TableRowColor">
 265 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#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#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
 266 </TR>
 267 </TABLE>
 268 &nbsp;<A NAME="methods_inherited_from_class_com.google.common.collect.Multiset"><!-- --></A>
 269 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 270 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 271 <TH ALIGN="left"><B>Methods 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>
 272 </TR>
 273 <TR BGCOLOR="white" CLASS="TableRowColor">
 274 <TD><CODE><A HREF="../../../../com/google/common/collect/Multiset.html#add(E)">add</A>, <A HREF="../../../../com/google/common/collect/Multiset.html#contains(java.lang.Object)">contains</A>, <A HREF="../../../../com/google/common/collect/Multiset.html#containsAll(java.util.Collection)">containsAll</A>, <A HREF="../../../../com/google/common/collect/Multiset.html#remove(java.lang.Object)">remove</A>, <A HREF="../../../../com/google/common/collect/Multiset.html#removeAll(java.util.Collection)">removeAll</A>, <A HREF="../../../../com/google/common/collect/Multiset.html#retainAll(java.util.Collection)">retainAll</A>, <A HREF="../../../../com/google/common/collect/Multiset.html#toString()">toString</A></CODE></TD>
 275 </TR>
 276 </TABLE>
 277 &nbsp;<A NAME="methods_inherited_from_class_java.util.Collection"><!-- --></A>
 278 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 279 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 280 <TH ALIGN="left"><B>Methods inherited from interface java.util.<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A></B></TH>
 281 </TR>
 282 <TR BGCOLOR="white" CLASS="TableRowColor">
 283 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html#addAll(java.util.Collection)" title="class or interface in java.util">addAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html#clear()" title="class or interface in java.util">clear</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html#isEmpty()" title="class or interface in java.util">isEmpty</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html#iterator()" title="class or interface in java.util">iterator</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html#size()" title="class or interface in java.util">size</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html#toArray()" title="class or interface in java.util">toArray</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html#toArray(T[])" title="class or interface in java.util">toArray</A></CODE></TD>
 284 </TR>
 285 </TABLE>
 286 &nbsp;
 287 <P>
 288
 289 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 290
 291 <A NAME="constructor_detail"><!-- --></A>
 292 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 293 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 294 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 295 <B>Constructor Detail</B></FONT></TH>
 296 </TR>
 297 </TABLE>
 298
 299 <A NAME="ForwardingMultiset()"><!-- --></A><H3>
 300 ForwardingMultiset</H3>
 301 <PRE>
 302 public <B>ForwardingMultiset</B>()</PRE>
 303 <DL>
 304 </DL>
 305
 306 <!-- ============ METHOD DETAIL ========== -->
 307
 308 <A NAME="method_detail"><!-- --></A>
 309 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 310 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 311 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 312 <B>Method Detail</B></FONT></TH>
 313 </TR>
 314 </TABLE>
 315
 316 <A NAME="delegate()"><!-- --></A><H3>
 317 delegate</H3>
 318 <PRE>
 319 protected abstract <A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMultiset.html" title="type parameter in ForwardingMultiset">E</A>&gt; <B>delegate</B>()</PRE>
 320 <DL>
 321 <DD><B>Description copied from class: <CODE><A HREF="../../../../com/google/common/collect/ForwardingObject.html#delegate()">ForwardingObject</A></CODE></B></DD>
 322 <DD>Returns the backing delegate instance that methods are forwarded to.
 323  Abstract subclasses generally override the <A HREF="../../../../com/google/common/collect/ForwardingObject.html" title="class in com.google.common.collect"><CODE>ForwardingObject</CODE></A> method
 324  with an abstract method that has a more specific return type, such as
 325  <A HREF="../../../../com/google/common/collect/ForwardingSet.html#delegate()"><CODE>ForwardingSet.delegate()</CODE></A>. Concrete subclasses override this method to
 326  supply the instance being decorated.
 327 <P>
 328 <DD><DL>
 329 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ForwardingCollection.html#delegate()">delegate</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ForwardingCollection.html" title="class in com.google.common.collect">ForwardingCollection</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMultiset.html" title="type parameter in ForwardingMultiset">E</A>&gt;</CODE></DL>
 330 </DD>
 331 <DD><DL>
 332 </DL>
 333 </DD>
 334 </DL>
 335 <HR>
 336
 337 <A NAME="count(java.lang.Object)"><!-- --></A><H3>
 338 count</H3>
 339 <PRE>
 340 public int <B>count</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;element)</PRE>
 341 <DL>
 342 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multiset.html#count(java.lang.Object)">Multiset</A></CODE></B></DD>
 343 <DD>Returns the number of occurrences of an element in this multiset (the
 344  <i>count</i> of the element). Note that for an <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang"><CODE>Object.equals(java.lang.Object)</CODE></A>-based
 345  multiset, this gives the same result as <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collections.html#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>
 346  (which would presumably perform more poorly).
 347
 348  <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
 349  this operation; it correctly delegates to this method when dealing with a
 350  multiset, but it can also accept any other iterable type.
 351 <P>
 352 <DD><DL>
 353 <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;<A HREF="../../../../com/google/common/collect/ForwardingMultiset.html" title="type parameter in ForwardingMultiset">E</A>&gt;</CODE></DL>
 354 </DD>
 355 <DD><DL>
 356 <DT><B>Parameters:</B><DD><CODE>element</CODE> - the element to count occurrences of
 357 <DT><B>Returns:</B><DD>the number of occurrences of the element in this multiset; possibly
 358      zero but never negative</DL>
 359 </DD>
 360 </DL>
 361 <HR>
 362
 363 <A NAME="add(java.lang.Object,int)"><!-- --></A><A NAME="add(E, int)"><!-- --></A><H3>
 364 add</H3>
 365 <PRE>
 366 public boolean <B>add</B>(<A HREF="../../../../com/google/common/collect/ForwardingMultiset.html" title="type parameter in ForwardingMultiset">E</A>&nbsp;element,
 367                    int&nbsp;occurrences)</PRE>
 368 <DL>
 369 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multiset.html#add(E, int)">Multiset</A></CODE></B></DD>
 370 <DD>Adds a number of occurrences of an element to this multiset. Note that if
 371  <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
 372  of overflow) to the call <code>addAll(Collections.nCopies(element,
 373  occurrences))</code>, which would presumably perform much more poorly.
 374 <P>
 375 <DD><DL>
 376 <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;<A HREF="../../../../com/google/common/collect/ForwardingMultiset.html" title="type parameter in ForwardingMultiset">E</A>&gt;</CODE></DL>
 377 </DD>
 378 <DD><DL>
 379 <DT><B>Parameters:</B><DD><CODE>element</CODE> - the element to add occurrences of; may be <code>null</code> only
 380      if explicitly allowed by the implementation<DD><CODE>occurrences</CODE> - the number of occurrences of this element to add. May
 381      be zero, in which case no change will be made.
 382 <DT><B>Returns:</B><DD>the previous count of this element before the operation; possibly
 383      zero - TODO: make this the actual behavior!</DL>
 384 </DD>
 385 </DL>
 386 <HR>
 387
 388 <A NAME="remove(java.lang.Object, int)"><!-- --></A><H3>
 389 remove</H3>
 390 <PRE>
 391 public int <B>remove</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;element,
 392                   int&nbsp;occurrences)</PRE>
 393 <DL>
 394 <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>
 395 <DD>Conditionally removes a number of occurrences of an element from this
 396  multiset, provided that at least this many occurrences are present. If the
 397  count of the element is less than <code>occurrences</code>, no change is made.
 398  Note that if
 399  <code>occurrences == 1</code>, this is functionally equivalent to the call
 400  <code>remove(element)</code>.
 401 <P>
 402 <DD><DL>
 403 <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;<A HREF="../../../../com/google/common/collect/ForwardingMultiset.html" title="type parameter in ForwardingMultiset">E</A>&gt;</CODE></DL>
 404 </DD>
 405 <DD><DL>
 406 <DT><B>Parameters:</B><DD><CODE>element</CODE> - the element to conditionally remove occurrences of<DD><CODE>occurrences</CODE> - the number of occurrences of this element to remove. May
 407      be zero, in which case no change will be made.
 408 <DT><B>Returns:</B><DD><code>true</code> if the condition for modification was met. Unless
 409      <code>occurrences</code> is zero, this implies that the multiset was indeed
 410      modified.</DL>
 411 </DD>
 412 </DL>
 413 <HR>
 414
 415 <A NAME="removeAllOccurrences(java.lang.Object)"><!-- --></A><H3>
 416 removeAllOccurrences</H3>
 417 <PRE>
 418 public int <B>removeAllOccurrences</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;element)</PRE>
 419 <DL>
 420 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multiset.html#removeAllOccurrences(java.lang.Object)">Multiset</A></CODE></B></DD>
 421 <DD>Removes <b>all</b> occurrences of the specified element from this multiset.
 422  This method complements <A HREF="../../../../com/google/common/collect/Multiset.html#remove(java.lang.Object)"><CODE>Multiset.remove(Object)</CODE></A>, which removes only
 423  one occurrence at a time.
 424
 425  TODO: Nuke this.  Use setCount(e, 0).
 426 <P>
 427 <DD><DL>
 428 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multiset.html#removeAllOccurrences(java.lang.Object)">removeAllOccurrences</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMultiset.html" title="type parameter in ForwardingMultiset">E</A>&gt;</CODE></DL>
 429 </DD>
 430 <DD><DL>
 431 <DT><B>Parameters:</B><DD><CODE>element</CODE> - the element whose occurrences should all be removed
 432 <DT><B>Returns:</B><DD>the number of occurrences successfully removed, possibly zero</DL>
 433 </DD>
 434 </DL>
 435 <HR>
 436
 437 <A NAME="elementSet()"><!-- --></A><H3>
 438 elementSet</H3>
 439 <PRE>
 440 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMultiset.html" title="type parameter in ForwardingMultiset">E</A>&gt; <B>elementSet</B>()</PRE>
 441 <DL>
 442 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multiset.html#elementSet()">Multiset</A></CODE></B></DD>
 443 <DD>Returns the set of distinct elements contained in this multiset. The
 444  element set is backed by the same data as the multiset, so any change to
 445  either is immediately reflected in the other. The order of the elements in
 446  the element set is unspecified.
 447
 448  <p>If the element set supports any removal operations, these necessarily
 449  cause <b>all</b> occurrences of the removed element(s) to be removed from
 450  the multiset. Implementations are not expected to support the add
 451  operations, although this is possible.
 452
 453  <p>A common use for the element set is to find the number of distinct
 454  elements in the multiset: <code>elementSet().size()</code>.
 455 <P>
 456 <DD><DL>
 457 <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;<A HREF="../../../../com/google/common/collect/ForwardingMultiset.html" title="type parameter in ForwardingMultiset">E</A>&gt;</CODE></DL>
 458 </DD>
 459 <DD><DL>
 460
 461 <DT><B>Returns:</B><DD>a view of the set of distinct elements in this multiset</DL>
 462 </DD>
 463 </DL>
 464 <HR>
 465
 466 <A NAME="entrySet()"><!-- --></A><H3>
 467 entrySet</H3>
 468 <PRE>
 469 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html" 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;<A HREF="../../../../com/google/common/collect/ForwardingMultiset.html" title="type parameter in ForwardingMultiset">E</A>&gt;&gt; <B>entrySet</B>()</PRE>
 470 <DL>
 471 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multiset.html#entrySet()">Multiset</A></CODE></B></DD>
 472 <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
 473  the count of that element. This set contains exactly one entry for each
 474  distinct element in the multiset (thus it always has the same size as the
 475  <A HREF="../../../../com/google/common/collect/Multiset.html#elementSet()"><CODE>Multiset.elementSet()</CODE></A>). The order of the elements in the element set is
 476  unspecified.
 477
 478  <p>The entry set is backed by the same data as the multiset, so any change
 479  to either is immediately reflected in the other. However, multiset changes
 480  may or may not be reflected in any <code>Entry</code> instances already
 481  retrieved from the entry set (this is implementation-dependent).
 482  Furthermore, implementations are not required to support modifications to
 483  the entry set at all, and the <code>Entry</code> instances themselves don't
 484  even have methods for modification. See the specific implementation class
 485  for more details on how its entry set handles modifications.
 486 <P>
 487 <DD><DL>
 488 <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;<A HREF="../../../../com/google/common/collect/ForwardingMultiset.html" title="type parameter in ForwardingMultiset">E</A>&gt;</CODE></DL>
 489 </DD>
 490 <DD><DL>
 491
 492 <DT><B>Returns:</B><DD>a set of entries representing the data of this multiset</DL>
 493 </DD>
 494 </DL>
 495 <HR>
 496
 497 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>
 498 equals</H3>
 499 <PRE>
 500 public boolean <B>equals</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;obj)</PRE>
 501 <DL>
 502 <DD><B>Description copied from class: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">java.lang.Object</A></CODE></B></DD>
 503 <DD>Indicates whether some other object is "equal to" this one.
 504  <p>
 505  The <code>equals</code> method implements an equivalence relation
 506  on non-null object references:
 507  <ul>
 508  <li>It is <i>reflexive</i>: for any non-null reference value
 509      <code>x</code>, <code>x.equals(x)</code> should return
 510      <code>true</code>.
 511  <li>It is <i>symmetric</i>: for any non-null reference values
 512      <code>x</code> and <code>y</code>, <code>x.equals(y)</code>
 513      should return <code>true</code> if and only if
 514      <code>y.equals(x)</code> returns <code>true</code>.
 515  <li>It is <i>transitive</i>: for any non-null reference values
 516      <code>x</code>, <code>y</code>, and <code>z</code>, if
 517      <code>x.equals(y)</code> returns <code>true</code> and
 518      <code>y.equals(z)</code> returns <code>true</code>, then
 519      <code>x.equals(z)</code> should return <code>true</code>.
 520  <li>It is <i>consistent</i>: for any non-null reference values
 521      <code>x</code> and <code>y</code>, multiple invocations of
 522      <tt>x.equals(y)</tt> consistently return <code>true</code>
 523      or consistently return <code>false</code>, provided no
 524      information used in <code>equals</code> comparisons on the
 525      objects is modified.
 526  <li>For any non-null reference value <code>x</code>,
 527      <code>x.equals(null)</code> should return <code>false</code>.
 528  </ul>
 529  <p>
 530  The <tt>equals</tt> method for class <code>Object</code> implements
 531  the most discriminating possible equivalence relation on objects;
 532  that is, for any non-null reference values <code>x</code> and
 533  <code>y</code>, this method returns <code>true</code> if and only
 534  if <code>x</code> and <code>y</code> refer to the same object
 535  (<code>x == y</code> has the value <code>true</code>).
 536  <p>
 537  Note that it is generally necessary to override the <tt>hashCode</tt>
 538  method whenever this method is overridden, so as to maintain the
 539  general contract for the <tt>hashCode</tt> method, which states
 540  that equal objects must have equal hash codes.
 541 <P>
 542 <DD><DL>
 543 <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;<A HREF="../../../../com/google/common/collect/ForwardingMultiset.html" title="type parameter in ForwardingMultiset">E</A>&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html#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" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMultiset.html" title="type parameter in ForwardingMultiset">E</A>&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#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" title="class or interface in java.lang">Object</A></CODE></DL>
 544 </DD>
 545 <DD><DL>
 546 <DT><B>Parameters:</B><DD><CODE>obj</CODE> - the reference object with which to compare.
 547 <DT><B>Returns:</B><DD><code>true</code> if this object is the same as the obj
 548           argument; <code>false</code> otherwise.<DT><B>See Also:</B><DD><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang"><CODE>Object.hashCode()</CODE></A>,
 549 <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Hashtable.html" title="class or interface in java.util"><CODE>Hashtable</CODE></A></DL>
 550 </DD>
 551 </DL>
 552 <HR>
 553
 554 <A NAME="hashCode()"><!-- --></A><H3>
 555 hashCode</H3>
 556 <PRE>
 557 public int <B>hashCode</B>()</PRE>
 558 <DL>
 559 <DD><B>Description copied from class: <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">java.lang.Object</A></CODE></B></DD>
 560 <DD>Returns a hash code value for the object. This method is
 561  supported for the benefit of hashtables such as those provided by
 562  <code>java.util.Hashtable</code>.
 563  <p>
 564  The general contract of <code>hashCode</code> is:
 565  <ul>
 566  <li>Whenever it is invoked on the same object more than once during
 567      an execution of a Java application, the <tt>hashCode</tt> method
 568      must consistently return the same integer, provided no information
 569      used in <tt>equals</tt> comparisons on the object is modified.
 570      This integer need not remain consistent from one execution of an
 571      application to another execution of the same application.
 572  <li>If two objects are equal according to the <tt>equals(Object)</tt>
 573      method, then calling the <code>hashCode</code> method on each of
 574      the two objects must produce the same integer result.
 575  <li>It is <em>not</em> required that if two objects are unequal
 576      according to the <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang"><CODE>Object.equals(java.lang.Object)</CODE></A>
 577      method, then calling the <tt>hashCode</tt> method on each of the
 578      two objects must produce distinct integer results.  However, the
 579      programmer should be aware that producing distinct integer results
 580      for unequal objects may improve the performance of hashtables.
 581  </ul>
 582  <p>
 583  As much as is reasonably practical, the hashCode method defined by
 584  class <tt>Object</tt> does return distinct integers for distinct
 585  objects. (This is typically implemented by converting the internal
 586  address of the object into an integer, but this implementation
 587  technique is not required by the
 588  Java<font size="-2"><sup>TM</sup></font> programming language.)
 589 <P>
 590 <DD><DL>
 591 <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;<A HREF="../../../../com/google/common/collect/ForwardingMultiset.html" title="type parameter in ForwardingMultiset">E</A>&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html#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" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../com/google/common/collect/ForwardingMultiset.html" title="type parameter in ForwardingMultiset">E</A>&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#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" title="class or interface in java.lang">Object</A></CODE></DL>
 592 </DD>
 593 <DD><DL>
 594
 595 <DT><B>Returns:</B><DD>a hash code value for this object.<DT><B>See Also:</B><DD><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang"><CODE>Object.equals(java.lang.Object)</CODE></A>,
 596 <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Hashtable.html" title="class or interface in java.util"><CODE>Hashtable</CODE></A></DL>
 597 </DD>
 598 </DL>
 599 <!-- ========= END OF CLASS DATA ========= -->
 600 <HR>
 601
 602
 603 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 604 <A NAME="navbar_bottom"><!-- --></A>
 605 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 606 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 607 <TR>
 608 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 609 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 610 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 611   <TR ALIGN="center" VALIGN="top">
 612   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 613   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 614   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 615   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 616   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 617   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 618   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 619   </TR>
 620 </TABLE>
 621 </TD>
 622 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 623 </EM>
 624 </TD>
 625 </TR>
 626
 627 <TR>
 628 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 629 &nbsp;<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A>&nbsp;
 630 &nbsp;<A HREF="../../../../com/google/common/collect/ForwardingObject.html" title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
 631 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 632   <A HREF="../../../../index.html?com/google/common/collect/ForwardingMultiset.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 633 &nbsp;<A HREF="ForwardingMultiset.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 634 &nbsp;<SCRIPT type="text/javascript">
 635   <!--
 636   if(window==top) {
 637     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 638   }
 639   //-->
 640 </SCRIPT>
 641 <NOSCRIPT>
 642   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
 643 </NOSCRIPT>
 644
 645
 646 </FONT></TD>
 647 </TR>
 648 <TR>
 649 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 650   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 651 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 652 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 653 </TR>
 654 </TABLE>
 655 <A NAME="skip-navbar_bottom"></A>
 656 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 657
 658 <HR>
 659
 660 </BODY>
 661 </HTML>