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:59 PST 2010 -->
      6 <TITLE>
      7 Multimap (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="Multimap (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/Multimap.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/Maps.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A>&nbsp;
     59 &nbsp;<A HREF="../../../../com/google/common/collect/Multimaps.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/Multimap.html" target="_top"><B>FRAMES</B></A>  &nbsp;
     62 &nbsp;<A HREF="Multimap.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 Interface Multimap&lt;K,V&gt;</H2>
     94 <DL>
     95 <DT><DT><B>Type Parameters:</B><DD><CODE>K</CODE> - the type of keys maintained by this multimap<DD><CODE>V</CODE> - the type of mapped values</DL>
     96 <DL>
     97 <DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../com/google/common/collect/ListMultimap.html" title="interface in com.google.common.collect">ListMultimap</A>&lt;K,V&gt;, <A HREF="../../../../com/google/common/collect/SetMultimap.html" title="interface in com.google.common.collect">SetMultimap</A>&lt;K,V&gt;, <A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="interface in com.google.common.collect">SortedSetMultimap</A>&lt;K,V&gt;</DD>
     98 </DL>
     99 <DL>
    100 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../com/google/common/collect/ArrayListMultimap.html" title="class in com.google.common.collect">ArrayListMultimap</A>, <A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="class in com.google.common.collect">ForwardingMultimap</A>, <A HREF="../../../../com/google/common/collect/HashMultimap.html" title="class in com.google.common.collect">HashMultimap</A>, <A HREF="../../../../com/google/common/collect/ImmutableListMultimap.html" title="class in com.google.common.collect">ImmutableListMultimap</A>, <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="class in com.google.common.collect">ImmutableMultimap</A>, <A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="class in com.google.common.collect">ImmutableSetMultimap</A>, <A HREF="../../../../com/google/common/collect/LinkedHashMultimap.html" title="class in com.google.common.collect">LinkedHashMultimap</A>, <A HREF="../../../../com/google/common/collect/LinkedListMultimap.html" title="class in com.google.common.collect">LinkedListMultimap</A>, <A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="class in com.google.common.collect">TreeMultimap</A></DD>
    101 </DL>
    102 <HR>
    103 <DL>
    104 <DT><PRE>public interface <B>Multimap&lt;K,V&gt;</B></DL>
    105 </PRE>
    106 
    107 <P>
    108 A collection similar to a <code>Map</code>, but which may associate multiple
    109  values with a single key. If you call <A HREF="../../../../com/google/common/collect/Multimap.html#put(K, V)"><CODE>put(K, V)</CODE></A> twice, with the same key
    110  but different values, the multimap contains mappings from the key to both
    111  values.
    112 
    113  <p>The methods <A HREF="../../../../com/google/common/collect/Multimap.html#get(K)"><CODE>get(K)</CODE></A>, <A HREF="../../../../com/google/common/collect/Multimap.html#keySet()"><CODE>keySet()</CODE></A>, <A HREF="../../../../com/google/common/collect/Multimap.html#keys()"><CODE>keys()</CODE></A>, <A HREF="../../../../com/google/common/collect/Multimap.html#values()"><CODE>values()</CODE></A>,
    114  <A HREF="../../../../com/google/common/collect/Multimap.html#entries()"><CODE>entries()</CODE></A>, and <A HREF="../../../../com/google/common/collect/Multimap.html#asMap()"><CODE>asMap()</CODE></A> return collections that are views of the
    115  multimap. If the multimap is modifiable, updating it can change the contents
    116  of those collections, and updating the collections will change the multimap.
    117  In contrast, <A HREF="../../../../com/google/common/collect/Multimap.html#replaceValues(K, java.lang.Iterable)"><CODE>replaceValues(K, java.lang.Iterable<? extends V>)</CODE></A> and <A HREF="../../../../com/google/common/collect/Multimap.html#removeAll(java.lang.Object)"><CODE>removeAll(java.lang.Object)</CODE></A> return collections
    118  that are independent of subsequent multimap changes.
    119 
    120  <p>Depending on the implementation, a multimap may or may not allow duplicate
    121  key-value pairs. In other words, the multimap contents after adding the same
    122  key and value twice varies between implementations. In multimaps allowing
    123  duplicates, the multimap will contain two mappings, and <code>get</code> will
    124  return a collection that includes the value twice. In multimaps not
    125  supporting duplicates, the multimap will contain a single mapping from the
    126  key to the value, and <code>get</code> will return a collection that includes the
    127  value once.
    128 
    129  <p>All methods that alter the multimap are optional, and the views returned
    130  by the multimap may or may not be modifiable. When modification isn't
    131  supported, those methods will throw an <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang"><CODE>UnsupportedOperationException</CODE></A>.
    132 <P>
    133 
    134 <P>
    135 <DL>
    136 <DT><B>Since:</B></DT>
    137   <DD>2010.01.04 <b>stable</b> (imported from Google Collections Library)</DD>
    138 <DT><B>Author:</B></DT>
    139   <DD>Jared Levy</DD>
    140 </DL>
    141 <HR>
    142 
    143 <P>
    144 
    145 <!-- ========== METHOD SUMMARY =========== -->
    146 
    147 <A NAME="method_summary"><!-- --></A>
    148 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    149 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    150 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    151 <B>Method Summary</B></FONT></TH>
    152 </TR>
    153 <TR BGCOLOR="white" CLASS="TableRowColor">
    154 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    155 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>,<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;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;&gt;</CODE></FONT></TD>
    156 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#asMap()">asMap</A></B>()</CODE>
    157 
    158 <BR>
    159 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a map view that associates each key with the corresponding values
    160  in the multimap.</TD>
    161 </TR>
    162 <TR BGCOLOR="white" CLASS="TableRowColor">
    163 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    164 <CODE>&nbsp;void</CODE></FONT></TD>
    165 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#clear()">clear</A></B>()</CODE>
    166 
    167 <BR>
    168 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes all key-value pairs from the multimap.</TD>
    169 </TR>
    170 <TR BGCOLOR="white" CLASS="TableRowColor">
    171 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    172 <CODE>&nbsp;boolean</CODE></FONT></TD>
    173 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#containsEntry(java.lang.Object, java.lang.Object)">containsEntry</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;key,
    174               <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;value)</CODE>
    175 
    176 <BR>
    177 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if the multimap contains the specified key-value pair.</TD>
    178 </TR>
    179 <TR BGCOLOR="white" CLASS="TableRowColor">
    180 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    181 <CODE>&nbsp;boolean</CODE></FONT></TD>
    182 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#containsKey(java.lang.Object)">containsKey</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;key)</CODE>
    183 
    184 <BR>
    185 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if the multimap contains any values for the specified
    186  key.</TD>
    187 </TR>
    188 <TR BGCOLOR="white" CLASS="TableRowColor">
    189 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    190 <CODE>&nbsp;boolean</CODE></FONT></TD>
    191 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#containsValue(java.lang.Object)">containsValue</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;value)</CODE>
    192 
    193 <BR>
    194 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if the multimap contains the specified value for any
    195  key.</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/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util">Map.Entry</A>&lt;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>,<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;&gt;</CODE></FONT></TD>
    200 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#entries()">entries</A></B>()</CODE>
    201 
    202 <BR>
    203 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a collection of all key-value pairs.</TD>
    204 </TR>
    205 <TR BGCOLOR="white" CLASS="TableRowColor">
    206 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    207 <CODE>&nbsp;boolean</CODE></FONT></TD>
    208 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.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;obj)</CODE>
    209 
    210 <BR>
    211 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compares the specified object with this multimap for equality.</TD>
    212 </TR>
    213 <TR BGCOLOR="white" CLASS="TableRowColor">
    214 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    215 <CODE>&nbsp;<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;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;</CODE></FONT></TD>
    216 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#get(K)">get</A></B>(<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>&nbsp;key)</CODE>
    217 
    218 <BR>
    219 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a collection view of all values associated with a key.</TD>
    220 </TR>
    221 <TR BGCOLOR="white" CLASS="TableRowColor">
    222 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    223 <CODE>&nbsp;int</CODE></FONT></TD>
    224 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#hashCode()">hashCode</A></B>()</CODE>
    225 
    226 <BR>
    227 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the hash code for this multimap.</TD>
    228 </TR>
    229 <TR BGCOLOR="white" CLASS="TableRowColor">
    230 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    231 <CODE>&nbsp;boolean</CODE></FONT></TD>
    232 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#isEmpty()">isEmpty</A></B>()</CODE>
    233 
    234 <BR>
    235 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if the multimap contains no key-value pairs.</TD>
    236 </TR>
    237 <TR BGCOLOR="white" CLASS="TableRowColor">
    238 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    239 <CODE>&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/Multimap.html" title="type parameter in Multimap">K</A>&gt;</CODE></FONT></TD>
    240 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#keys()">keys</A></B>()</CODE>
    241 
    242 <BR>
    243 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a collection, which may contain duplicates, of all keys.</TD>
    244 </TR>
    245 <TR BGCOLOR="white" CLASS="TableRowColor">
    246 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    247 <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/Multimap.html" title="type parameter in Multimap">K</A>&gt;</CODE></FONT></TD>
    248 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#keySet()">keySet</A></B>()</CODE>
    249 
    250 <BR>
    251 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the set of all keys, each appearing once in the returned set.</TD>
    252 </TR>
    253 <TR BGCOLOR="white" CLASS="TableRowColor">
    254 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    255 <CODE>&nbsp;boolean</CODE></FONT></TD>
    256 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#put(K, V)">put</A></B>(<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>&nbsp;key,
    257     <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&nbsp;value)</CODE>
    258 
    259 <BR>
    260 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stores a key-value pair in the multimap.</TD>
    261 </TR>
    262 <TR BGCOLOR="white" CLASS="TableRowColor">
    263 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    264 <CODE>&nbsp;boolean</CODE></FONT></TD>
    265 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#putAll(K, java.lang.Iterable)">putAll</A></B>(<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>&nbsp;key,
    266        <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;? extends <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;&nbsp;values)</CODE>
    267 
    268 <BR>
    269 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stores a collection of values with the same key.</TD>
    270 </TR>
    271 <TR BGCOLOR="white" CLASS="TableRowColor">
    272 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    273 <CODE>&nbsp;boolean</CODE></FONT></TD>
    274 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#putAll(com.google.common.collect.Multimap)">putAll</A></B>(<A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A>&lt;? extends <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>,? extends <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;&nbsp;multimap)</CODE>
    275 
    276 <BR>
    277 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Copies all of another multimap's key-value pairs into this multimap.</TD>
    278 </TR>
    279 <TR BGCOLOR="white" CLASS="TableRowColor">
    280 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    281 <CODE>&nbsp;boolean</CODE></FONT></TD>
    282 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#remove(java.lang.Object, 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;key,
    283        <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;value)</CODE>
    284 
    285 <BR>
    286 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes a key-value pair from the multimap.</TD>
    287 </TR>
    288 <TR BGCOLOR="white" CLASS="TableRowColor">
    289 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    290 <CODE>&nbsp;<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;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;</CODE></FONT></TD>
    291 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#removeAll(java.lang.Object)">removeAll</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;key)</CODE>
    292 
    293 <BR>
    294 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes all values associated with a given key.</TD>
    295 </TR>
    296 <TR BGCOLOR="white" CLASS="TableRowColor">
    297 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    298 <CODE>&nbsp;<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;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;</CODE></FONT></TD>
    299 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#replaceValues(K, java.lang.Iterable)">replaceValues</A></B>(<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>&nbsp;key,
    300               <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;? extends <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;&nbsp;values)</CODE>
    301 
    302 <BR>
    303 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stores a collection of values with the same key, replacing any existing
    304  values for that key.</TD>
    305 </TR>
    306 <TR BGCOLOR="white" CLASS="TableRowColor">
    307 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    308 <CODE>&nbsp;int</CODE></FONT></TD>
    309 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#size()">size</A></B>()</CODE>
    310 
    311 <BR>
    312 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of key-value pairs in the multimap.</TD>
    313 </TR>
    314 <TR BGCOLOR="white" CLASS="TableRowColor">
    315 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    316 <CODE>&nbsp;<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;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;</CODE></FONT></TD>
    317 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#values()">values</A></B>()</CODE>
    318 
    319 <BR>
    320 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a collection of all values in the multimap.</TD>
    321 </TR>
    322 </TABLE>
    323 &nbsp;
    324 <P>
    325 
    326 <!-- ============ METHOD DETAIL ========== -->
    327 
    328 <A NAME="method_detail"><!-- --></A>
    329 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    330 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    331 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    332 <B>Method Detail</B></FONT></TH>
    333 </TR>
    334 </TABLE>
    335 
    336 <A NAME="size()"><!-- --></A><H3>
    337 size</H3>
    338 <PRE>
    339 int <B>size</B>()</PRE>
    340 <DL>
    341 <DD>Returns the number of key-value pairs in the multimap.
    342 <P>
    343 <DD><DL>
    344 </DL>
    345 </DD>
    346 </DL>
    347 <HR>
    348 
    349 <A NAME="isEmpty()"><!-- --></A><H3>
    350 isEmpty</H3>
    351 <PRE>
    352 boolean <B>isEmpty</B>()</PRE>
    353 <DL>
    354 <DD>Returns <code>true</code> if the multimap contains no key-value pairs.
    355 <P>
    356 <DD><DL>
    357 </DL>
    358 </DD>
    359 </DL>
    360 <HR>
    361 
    362 <A NAME="containsKey(java.lang.Object)"><!-- --></A><H3>
    363 containsKey</H3>
    364 <PRE>
    365 boolean <B>containsKey</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>
    366                     <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;key)</PRE>
    367 <DL>
    368 <DD>Returns <code>true</code> if the multimap contains any values for the specified
    369  key.
    370 <P>
    371 <DD><DL>
    372 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to search for in multimap</DL>
    373 </DD>
    374 </DL>
    375 <HR>
    376 
    377 <A NAME="containsValue(java.lang.Object)"><!-- --></A><H3>
    378 containsValue</H3>
    379 <PRE>
    380 boolean <B>containsValue</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>
    381                       <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;value)</PRE>
    382 <DL>
    383 <DD>Returns <code>true</code> if the multimap contains the specified value for any
    384  key.
    385 <P>
    386 <DD><DL>
    387 <DT><B>Parameters:</B><DD><CODE>value</CODE> - value to search for in multimap</DL>
    388 </DD>
    389 </DL>
    390 <HR>
    391 
    392 <A NAME="containsEntry(java.lang.Object, java.lang.Object)"><!-- --></A><H3>
    393 containsEntry</H3>
    394 <PRE>
    395 boolean <B>containsEntry</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>
    396                       <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;key,
    397                       <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>
    398                       <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;value)</PRE>
    399 <DL>
    400 <DD>Returns <code>true</code> if the multimap contains the specified key-value pair.
    401 <P>
    402 <DD><DL>
    403 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to search for in multimap<DD><CODE>value</CODE> - value to search for in multimap</DL>
    404 </DD>
    405 </DL>
    406 <HR>
    407 
    408 <A NAME="put(java.lang.Object,java.lang.Object)"><!-- --></A><A NAME="put(K, V)"><!-- --></A><H3>
    409 put</H3>
    410 <PRE>
    411 boolean <B>put</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>
    412             <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>&nbsp;key,
    413             <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>
    414             <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&nbsp;value)</PRE>
    415 <DL>
    416 <DD>Stores a key-value pair in the multimap.
    417 
    418  <p>Some multimap implementations allow duplicate key-value pairs, in which
    419  case <code>put</code> always adds a new key-value pair and increases the
    420  multimap size by 1. Other implementations prohibit duplicates, and storing
    421  a key-value pair that's already in the multimap has no effect.
    422 <P>
    423 <DD><DL>
    424 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to store in the multimap<DD><CODE>value</CODE> - value to store in the multimap
    425 <DT><B>Returns:</B><DD><code>true</code> if the method increased the size of the multimap, or
    426      <code>false</code> if the multimap already contained the key-value pair and
    427      doesn't allow duplicates</DL>
    428 </DD>
    429 </DL>
    430 <HR>
    431 
    432 <A NAME="remove(java.lang.Object, java.lang.Object)"><!-- --></A><H3>
    433 remove</H3>
    434 <PRE>
    435 boolean <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>
    436                <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;key,
    437                <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>
    438                <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;value)</PRE>
    439 <DL>
    440 <DD>Removes a key-value pair from the multimap.
    441 <P>
    442 <DD><DL>
    443 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key of entry to remove from the multimap<DD><CODE>value</CODE> - value of entry to remove the multimap
    444 <DT><B>Returns:</B><DD><code>true</code> if the multimap changed</DL>
    445 </DD>
    446 </DL>
    447 <HR>
    448 
    449 <A NAME="putAll(java.lang.Object,java.lang.Iterable)"><!-- --></A><A NAME="putAll(K, java.lang.Iterable)"><!-- --></A><H3>
    450 putAll</H3>
    451 <PRE>
    452 boolean <B>putAll</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>
    453                <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>&nbsp;key,
    454                <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;? extends <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;&nbsp;values)</PRE>
    455 <DL>
    456 <DD>Stores a collection of values with the same key.
    457 <P>
    458 <DD><DL>
    459 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to store in the multimap<DD><CODE>values</CODE> - values to store in the multimap
    460 <DT><B>Returns:</B><DD><code>true</code> if the multimap changed</DL>
    461 </DD>
    462 </DL>
    463 <HR>
    464 
    465 <A NAME="putAll(com.google.common.collect.Multimap)"><!-- --></A><H3>
    466 putAll</H3>
    467 <PRE>
    468 boolean <B>putAll</B>(<A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A>&lt;? extends <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>,? extends <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;&nbsp;multimap)</PRE>
    469 <DL>
    470 <DD>Copies all of another multimap's key-value pairs into this multimap. The
    471  order in which the mappings are added is determined by
    472  <code>multimap.entries()</code>.
    473 <P>
    474 <DD><DL>
    475 <DT><B>Parameters:</B><DD><CODE>multimap</CODE> - mappings to store in this multimap
    476 <DT><B>Returns:</B><DD><code>true</code> if the multimap changed</DL>
    477 </DD>
    478 </DL>
    479 <HR>
    480 
    481 <A NAME="replaceValues(java.lang.Object,java.lang.Iterable)"><!-- --></A><A NAME="replaceValues(K, java.lang.Iterable)"><!-- --></A><H3>
    482 replaceValues</H3>
    483 <PRE>
    484 <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;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt; <B>replaceValues</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>
    485                             <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>&nbsp;key,
    486                             <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;? extends <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;&nbsp;values)</PRE>
    487 <DL>
    488 <DD>Stores a collection of values with the same key, replacing any existing
    489  values for that key.
    490 <P>
    491 <DD><DL>
    492 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to store in the multimap<DD><CODE>values</CODE> - values to store in the multimap
    493 <DT><B>Returns:</B><DD>the collection of replaced values, or an empty collection if no
    494      values were previously associated with the key. The collection
    495      <i>may</i> be modifiable, but updating it will have no effect on the
    496      multimap.</DL>
    497 </DD>
    498 </DL>
    499 <HR>
    500 
    501 <A NAME="removeAll(java.lang.Object)"><!-- --></A><H3>
    502 removeAll</H3>
    503 <PRE>
    504 <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;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt; <B>removeAll</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;key)</PRE>
    506 <DL>
    507 <DD>Removes all values associated with a given key.
    508 <P>
    509 <DD><DL>
    510 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key of entries to remove from the multimap
    511 <DT><B>Returns:</B><DD>the collection of removed values, or an empty collection if no
    512      values were associated with the provided key. The collection
    513      <i>may</i> be modifiable, but updating it will have no effect on the
    514      multimap.</DL>
    515 </DD>
    516 </DL>
    517 <HR>
    518 
    519 <A NAME="clear()"><!-- --></A><H3>
    520 clear</H3>
    521 <PRE>
    522 void <B>clear</B>()</PRE>
    523 <DL>
    524 <DD>Removes all key-value pairs from the multimap.
    525 <P>
    526 <DD><DL>
    527 </DL>
    528 </DD>
    529 </DL>
    530 <HR>
    531 
    532 <A NAME="get(java.lang.Object)"><!-- --></A><A NAME="get(K)"><!-- --></A><H3>
    533 get</H3>
    534 <PRE>
    535 <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;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt; <B>get</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>
    536                   <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>&nbsp;key)</PRE>
    537 <DL>
    538 <DD>Returns a collection view of all values associated with a key. If no
    539  mappings in the multimap have the provided key, an empty collection is
    540  returned.
    541 
    542  <p>Changes to the returned collection will update the underlying multimap,
    543  and vice versa.
    544 <P>
    545 <DD><DL>
    546 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to search for in multimap
    547 <DT><B>Returns:</B><DD>the collection of values that the key maps to</DL>
    548 </DD>
    549 </DL>
    550 <HR>
    551 
    552 <A NAME="keySet()"><!-- --></A><H3>
    553 keySet</H3>
    554 <PRE>
    555 <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/Multimap.html" title="type parameter in Multimap">K</A>&gt; <B>keySet</B>()</PRE>
    556 <DL>
    557 <DD>Returns the set of all keys, each appearing once in the returned set.
    558  Changes to the returned set will update the underlying multimap, and vice
    559  versa.
    560 <P>
    561 <DD><DL>
    562 
    563 <DT><B>Returns:</B><DD>the collection of distinct keys</DL>
    564 </DD>
    565 </DL>
    566 <HR>
    567 
    568 <A NAME="keys()"><!-- --></A><H3>
    569 keys</H3>
    570 <PRE>
    571 <A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>&gt; <B>keys</B>()</PRE>
    572 <DL>
    573 <DD>Returns a collection, which may contain duplicates, of all keys. The number
    574  of times of key appears in the returned multiset equals the number of
    575  mappings the key has in the multimap. Changes to the returned multiset will
    576  update the underlying multimap, and vice versa.
    577 <P>
    578 <DD><DL>
    579 
    580 <DT><B>Returns:</B><DD>a multiset with keys corresponding to the distinct keys of the
    581      multimap and frequencies corresponding to the number of values that
    582      each key maps to</DL>
    583 </DD>
    584 </DL>
    585 <HR>
    586 
    587 <A NAME="values()"><!-- --></A><H3>
    588 values</H3>
    589 <PRE>
    590 <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;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt; <B>values</B>()</PRE>
    591 <DL>
    592 <DD>Returns a collection of all values in the multimap. Changes to the returned
    593  collection will update the underlying multimap, and vice versa.
    594 <P>
    595 <DD><DL>
    596 
    597 <DT><B>Returns:</B><DD>collection of values, which may include the same value multiple
    598      times if it occurs in multiple mappings</DL>
    599 </DD>
    600 </DL>
    601 <HR>
    602 
    603 <A NAME="entries()"><!-- --></A><H3>
    604 entries</H3>
    605 <PRE>
    606 <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;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util">Map.Entry</A>&lt;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>,<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;&gt; <B>entries</B>()</PRE>
    607 <DL>
    608 <DD>Returns a collection of all key-value pairs. Changes to the returned
    609  collection will update the underlying multimap, and vice versa. The entries
    610  collection does not support the <code>add</code> or <code>addAll</code> operations.
    611 <P>
    612 <DD><DL>
    613 
    614 <DT><B>Returns:</B><DD>collection of map entries consisting of key-value pairs</DL>
    615 </DD>
    616 </DL>
    617 <HR>
    618 
    619 <A NAME="asMap()"><!-- --></A><H3>
    620 asMap</H3>
    621 <PRE>
    622 <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>,<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;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;&gt; <B>asMap</B>()</PRE>
    623 <DL>
    624 <DD>Returns a map view that associates each key with the corresponding values
    625  in the multimap. Changes to the returned map, such as element removal,
    626  will update the underlying multimap. The map does not support
    627  <code>setValue()</code> on its entries, <code>put</code>, or <code>putAll</code>.
    628 
    629  <p>The collections returned by <code>asMap().get(Object)</code> have the same
    630  behavior as those returned by <A HREF="../../../../com/google/common/collect/Multimap.html#get(K)"><CODE>get(K)</CODE></A>.
    631 <P>
    632 <DD><DL>
    633 
    634 <DT><B>Returns:</B><DD>a map view from a key to its collection of values</DL>
    635 </DD>
    636 </DL>
    637 <HR>
    638 
    639 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>
    640 equals</H3>
    641 <PRE>
    642 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>
    643                <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;obj)</PRE>
    644 <DL>
    645 <DD>Compares the specified object with this multimap for equality. Two
    646  multimaps are equal when their map views, as returned by <A HREF="../../../../com/google/common/collect/Multimap.html#asMap()"><CODE>asMap()</CODE></A>,
    647  are also equal.
    648 
    649  <p>In general, two multimaps with identical key-value mappings may or may
    650  not be equal, depending on the implementation. For example, two
    651  <A HREF="../../../../com/google/common/collect/SetMultimap.html" title="interface in com.google.common.collect"><CODE>SetMultimap</CODE></A> instances with the same key-value mappings are equal,
    652  but equality of two <A HREF="../../../../com/google/common/collect/ListMultimap.html" title="interface in com.google.common.collect"><CODE>ListMultimap</CODE></A> instances depends on the ordering
    653  of the values for each key.
    654 
    655  <p>A non-empty <A HREF="../../../../com/google/common/collect/SetMultimap.html" title="interface in com.google.common.collect"><CODE>SetMultimap</CODE></A> cannot be equal to a non-empty
    656  <A HREF="../../../../com/google/common/collect/ListMultimap.html" title="interface in com.google.common.collect"><CODE>ListMultimap</CODE></A>, since their <A HREF="../../../../com/google/common/collect/Multimap.html#asMap()"><CODE>asMap()</CODE></A> views contain unequal
    657  collections as values. However, any two empty multimaps are equal, because
    658  they both have empty <A HREF="../../../../com/google/common/collect/Multimap.html#asMap()"><CODE>asMap()</CODE></A> views.
    659 <P>
    660 <DD><DL>
    661 <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>
    662 </DD>
    663 <DD><DL>
    664 </DL>
    665 </DD>
    666 </DL>
    667 <HR>
    668 
    669 <A NAME="hashCode()"><!-- --></A><H3>
    670 hashCode</H3>
    671 <PRE>
    672 int <B>hashCode</B>()</PRE>
    673 <DL>
    674 <DD>Returns the hash code for this multimap.
    675 
    676  <p>The hash code of a multimap is defined as the hash code of the map view,
    677  as returned by <A HREF="../../../../com/google/common/collect/Multimap.html#asMap()"><CODE>asMap()</CODE></A>.
    678 <P>
    679 <DD><DL>
    680 <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>
    681 </DD>
    682 <DD><DL>
    683 </DL>
    684 </DD>
    685 </DL>
    686 <!-- ========= END OF CLASS DATA ========= -->
    687 <HR>
    688 
    689 
    690 <!-- ======= START OF BOTTOM NAVBAR ====== -->
    691 <A NAME="navbar_bottom"><!-- --></A>
    692 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
    693 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    694 <TR>
    695 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    696 <A NAME="navbar_bottom_firstrow"><!-- --></A>
    697 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    698   <TR ALIGN="center" VALIGN="top">
    699   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    700   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    701   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    702   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Multimap.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    703   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    704   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    705   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    706   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    707   </TR>
    708 </TABLE>
    709 </TD>
    710 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    711 </EM>
    712 </TD>
    713 </TR>
    714 
    715 <TR>
    716 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    717 &nbsp;<A HREF="../../../../com/google/common/collect/Maps.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A>&nbsp;
    718 &nbsp;<A HREF="../../../../com/google/common/collect/Multimaps.html" title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
    719 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    720   <A HREF="../../../../index.html?com/google/common/collect/Multimap.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    721 &nbsp;<A HREF="Multimap.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    722 &nbsp;<SCRIPT type="text/javascript">
    723   <!--
    724   if(window==top) {
    725     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
    726   }
    727   //-->
    728 </SCRIPT>
    729 <NOSCRIPT>
    730   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
    731 </NOSCRIPT>
    732 
    733 
    734 </FONT></TD>
    735 </TR>
    736 <TR>
    737 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    738   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    739 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    740 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    741 </TR>
    742 </TABLE>
    743 <A NAME="skip-navbar_bottom"></A>
    744 <!-- ======== END OF BOTTOM NAVBAR ======= -->
    745 
    746 <HR>
    747 
    748 </BODY>
    749 </HTML>
    750