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 TreeMultimap (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="TreeMultimap (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> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/TreeMultimap.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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 <A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="interface in com.google.common.collect"><B>PREV CLASS</B></A> 59 <A HREF="../../../../com/google/common/collect/TreeMultiset.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/TreeMultimap.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="TreeMultimap.html" target="_top"><B>NO FRAMES</B></A> 63 <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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 81 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 82 </TR> 83 </TABLE> 84 <A NAME="skip-navbar_top"></A> 85 <!-- ========= END OF TOP NAVBAR ========= --> 86 87 <HR> 88 <!-- ======== START OF CLASS DATA ======== --> 89 <H2> 90 <FONT SIZE="-1"> 91 com.google.common.collect</FONT> 92 <BR> 93 Class TreeMultimap<K,V></H2> 94 <PRE> 95 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> 96 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.google.common.collect.TreeMultimap<K,V></B> 97 </PRE> 98 <DL> 99 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><K,V>, <A HREF="../../../../com/google/common/collect/SetMultimap.html" title="interface in com.google.common.collect">SetMultimap</A><K,V>, <A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="interface in com.google.common.collect">SortedSetMultimap</A><K,V>, <A HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DD> 100 </DL> 101 <HR> 102 <DL> 103 <DT><PRE>public class <B>TreeMultimap<K,V></B><DT>extends <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></DL> 104 </PRE> 105 106 <P> 107 Implementation of <code>Multimap</code> whose keys and values are ordered by 108 their natural ordering or by supplied comparators. In all cases, this 109 implementation uses <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true#compareTo(T)" title="class or interface in java.lang"><CODE>Comparable.compareTo(T)</CODE></A> or <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Comparator.html?is-external=true#compare(T, T)" title="class or interface in java.util"><CODE>Comparator.compare(T, T)</CODE></A> instead of <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang"><CODE>Object.equals(java.lang.Object)</CODE></A> to determine 110 equivalence of instances. 111 112 <p><b>Warning:</b> The comparators or comparables used must be <i>consistent 113 with equals</i> as explained by the <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang"><CODE>Comparable</CODE></A> class specification. 114 Otherwise, the resulting multiset will violate the general contract of <A HREF="../../../../com/google/common/collect/SetMultimap.html" title="interface in com.google.common.collect"><CODE>SetMultimap</CODE></A>, which it is specified in terms of <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang"><CODE>Object.equals(java.lang.Object)</CODE></A>. 115 116 <p>The collections returned by <code>keySet</code> and <code>asMap</code> iterate 117 through the keys according to the key comparator ordering or the natural 118 ordering of the keys. Similarly, <code>get</code>, <code>removeAll</code>, and <code>replaceValues</code> return collections that iterate through the values according 119 to the value comparator ordering or the natural ordering of the values. The 120 collections generated by <code>entries</code>, <code>keys</code>, and <code>values</code> 121 iterate across the keys according to the above key ordering, and for each 122 key they iterate across the values according to the value ordering. 123 124 <p>The multimap does not store duplicate key-value pairs. Adding a new 125 key-value pair equal to an existing key-value pair has no effect. 126 127 <p>Depending on the comparators, null keys and values may or may not be 128 supported. The natural ordering does not support nulls. All optional multimap 129 methods are supported, and all returned views are modifiable. 130 131 <p>This class is not threadsafe when any concurrent operations update the 132 multimap. Concurrent read operations will work correctly. To allow concurrent 133 update operations, wrap your multimap with a call to <A HREF="../../../../com/google/common/collect/Multimaps.html#synchronizedSortedSetMultimap(com.google.common.collect.SortedSetMultimap)"><CODE>Multimaps.synchronizedSortedSetMultimap(com.google.common.collect.SortedSetMultimap<K, V>)</CODE></A>. 134 <P> 135 136 <P> 137 <DL> 138 <DT><B>Since:</B></DT> 139 <DD>2010.01.04 <b>stable</b> (imported from Google Collections Library)</DD> 140 <DT><B>Author:</B></DT> 141 <DD>Jared Levy</DD> 142 <DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#com.google.common.collect.TreeMultimap">Serialized Form</A></DL> 143 <HR> 144 145 <P> 146 147 <!-- ========== METHOD SUMMARY =========== --> 148 149 <A NAME="method_summary"><!-- --></A> 150 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 151 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 152 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 153 <B>Method Summary</B></FONT></TH> 154 </TR> 155 <TR BGCOLOR="white" CLASS="TableRowColor"> 156 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 157 <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</A><<A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="type parameter in TreeMultimap">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><<A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="type parameter in TreeMultimap">V</A>>></CODE></FONT></TD> 158 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.html#asMap()">asMap</A></B>()</CODE> 159 160 <BR> 161 Returns a map view that associates each key with the corresponding values 162 in the multimap.</TD> 163 </TR> 164 <TR BGCOLOR="white" CLASS="TableRowColor"> 165 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 166 <CODE> void</CODE></FONT></TD> 167 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.html#clear()">clear</A></B>()</CODE> 168 169 <BR> 170 Removes all key-value pairs from the multimap.</TD> 171 </TR> 172 <TR BGCOLOR="white" CLASS="TableRowColor"> 173 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 174 <CODE> boolean</CODE></FONT></TD> 175 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.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> key, 176 <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> value)</CODE> 177 178 <BR> 179 Returns <code>true</code> if the multimap contains the specified key-value pair.</TD> 180 </TR> 181 <TR BGCOLOR="white" CLASS="TableRowColor"> 182 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 183 <CODE> boolean</CODE></FONT></TD> 184 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.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> key)</CODE> 185 186 <BR> 187 Returns <code>true</code> if the multimap contains any values for the specified 188 key.</TD> 189 </TR> 190 <TR BGCOLOR="white" CLASS="TableRowColor"> 191 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 192 <CODE> boolean</CODE></FONT></TD> 193 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.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> value)</CODE> 194 195 <BR> 196 Returns <code>true</code> if the multimap contains the specified value for any 197 key.</TD> 198 </TR> 199 <TR BGCOLOR="white" CLASS="TableRowColor"> 200 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 201 <CODE>static 202 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 203 <TR ALIGN="right" VALIGN=""> 204 <TD NOWRAP><FONT SIZE="-1"> 205 <CODE><K extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>,V extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>> 206 <BR> 207 <A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="class in com.google.common.collect">TreeMultimap</A><K,V></CODE></FONT></TD> 208 </TR> 209 </TABLE> 210 </CODE></FONT></TD> 211 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.html#create()">create</A></B>()</CODE> 212 213 <BR> 214 Creates an empty <code>TreeMultimap</code> ordered by the natural ordering of 215 its keys and values.</TD> 216 </TR> 217 <TR BGCOLOR="white" CLASS="TableRowColor"> 218 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 219 <CODE>static 220 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 221 <TR ALIGN="right" VALIGN=""> 222 <TD NOWRAP><FONT SIZE="-1"> 223 <CODE><K,V> <A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="class in com.google.common.collect">TreeMultimap</A><K,V></CODE></FONT></TD> 224 </TR> 225 </TABLE> 226 </CODE></FONT></TD> 227 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.html#create(java.util.Comparator, java.util.Comparator)">create</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A><? super K> keyComparator, 228 <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A><? super V> valueComparator)</CODE> 229 230 <BR> 231 Creates an empty <code>TreeMultimap</code> instance using explicit comparators.</TD> 232 </TR> 233 <TR BGCOLOR="white" CLASS="TableRowColor"> 234 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 235 <CODE>static 236 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 237 <TR ALIGN="right" VALIGN=""> 238 <TD NOWRAP><FONT SIZE="-1"> 239 <CODE><K extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>,V extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>> 240 <BR> 241 <A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="class in com.google.common.collect">TreeMultimap</A><K,V></CODE></FONT></TD> 242 </TR> 243 </TABLE> 244 </CODE></FONT></TD> 245 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.html#create(com.google.common.collect.Multimap)">create</A></B>(<A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><? extends K,? extends V> multimap)</CODE> 246 247 <BR> 248 Constructs a <code>TreeMultimap</code>, ordered by the natural ordering of its 249 keys and values, with the same mappings as the specified multimap.</TD> 250 </TR> 251 <TR BGCOLOR="white" CLASS="TableRowColor"> 252 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 253 <CODE> <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><<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><K,V>></CODE></FONT></TD> 254 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.html#entries()">entries</A></B>()</CODE> 255 256 <BR> 257 Returns a collection of all key-value pairs.</TD> 258 </TR> 259 <TR BGCOLOR="white" CLASS="TableRowColor"> 260 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 261 <CODE> boolean</CODE></FONT></TD> 262 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.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> object)</CODE> 263 264 <BR> 265 Compares the specified object to this multimap for equality.</TD> 266 </TR> 267 <TR BGCOLOR="white" CLASS="TableRowColor"> 268 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 269 <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</A><V></CODE></FONT></TD> 270 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.html#get(K)">get</A></B>(K key)</CODE> 271 272 <BR> 273 Returns a collection view of all values associated with a key.</TD> 274 </TR> 275 <TR BGCOLOR="white" CLASS="TableRowColor"> 276 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 277 <CODE> int</CODE></FONT></TD> 278 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.html#hashCode()">hashCode</A></B>()</CODE> 279 280 <BR> 281 Returns the hash code for this multimap.</TD> 282 </TR> 283 <TR BGCOLOR="white" CLASS="TableRowColor"> 284 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 285 <CODE> boolean</CODE></FONT></TD> 286 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.html#isEmpty()">isEmpty</A></B>()</CODE> 287 288 <BR> 289 Returns <code>true</code> if the multimap contains no key-value pairs.</TD> 290 </TR> 291 <TR BGCOLOR="white" CLASS="TableRowColor"> 292 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 293 <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A><? super <A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="type parameter in TreeMultimap">K</A>></CODE></FONT></TD> 294 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.html#keyComparator()">keyComparator</A></B>()</CODE> 295 296 <BR> 297 Returns the comparator that orders the multimap keys.</TD> 298 </TR> 299 <TR BGCOLOR="white" CLASS="TableRowColor"> 300 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 301 <CODE> <A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A><K></CODE></FONT></TD> 302 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.html#keys()">keys</A></B>()</CODE> 303 304 <BR> 305 Returns a collection, which may contain duplicates, of all keys.</TD> 306 </TR> 307 <TR BGCOLOR="white" CLASS="TableRowColor"> 308 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 309 <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</A><<A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="type parameter in TreeMultimap">K</A>></CODE></FONT></TD> 310 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.html#keySet()">keySet</A></B>()</CODE> 311 312 <BR> 313 Returns the set of all keys, each appearing once in the returned set.</TD> 314 </TR> 315 <TR BGCOLOR="white" CLASS="TableRowColor"> 316 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 317 <CODE> boolean</CODE></FONT></TD> 318 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.html#put(K, V)">put</A></B>(K key, 319 V value)</CODE> 320 321 <BR> 322 Stores a key-value pair in the multimap.</TD> 323 </TR> 324 <TR BGCOLOR="white" CLASS="TableRowColor"> 325 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 326 <CODE> boolean</CODE></FONT></TD> 327 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.html#putAll(K, java.lang.Iterable)">putAll</A></B>(K key, 328 <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><? extends V> values)</CODE> 329 330 <BR> 331 Stores a collection of values with the same key.</TD> 332 </TR> 333 <TR BGCOLOR="white" CLASS="TableRowColor"> 334 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 335 <CODE> boolean</CODE></FONT></TD> 336 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.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><? extends K,? extends V> multimap)</CODE> 337 338 <BR> 339 Copies all of another multimap's key-value pairs into this multimap.</TD> 340 </TR> 341 <TR BGCOLOR="white" CLASS="TableRowColor"> 342 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 343 <CODE> boolean</CODE></FONT></TD> 344 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.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> key, 345 <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> value)</CODE> 346 347 <BR> 348 Removes a key-value pair from the multimap.</TD> 349 </TR> 350 <TR BGCOLOR="white" CLASS="TableRowColor"> 351 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 352 <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</A><V></CODE></FONT></TD> 353 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.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> key)</CODE> 354 355 <BR> 356 Removes all values associated with a given key.</TD> 357 </TR> 358 <TR BGCOLOR="white" CLASS="TableRowColor"> 359 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 360 <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</A><V></CODE></FONT></TD> 361 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.html#replaceValues(K, java.lang.Iterable)">replaceValues</A></B>(K key, 362 <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><? extends V> values)</CODE> 363 364 <BR> 365 Stores a collection of values with the same key, replacing any existing 366 values for that key.</TD> 367 </TR> 368 <TR BGCOLOR="white" CLASS="TableRowColor"> 369 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 370 <CODE> int</CODE></FONT></TD> 371 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.html#size()">size</A></B>()</CODE> 372 373 <BR> 374 Returns the number of key-value pairs in the multimap.</TD> 375 </TR> 376 <TR BGCOLOR="white" CLASS="TableRowColor"> 377 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 378 <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> 379 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.html#toString()">toString</A></B>()</CODE> 380 381 <BR> 382 Returns a string representation of the multimap, generated by calling 383 <code>toString</code> on the map returned by <A HREF="../../../../com/google/common/collect/Multimap.html#asMap()"><CODE>Multimap.asMap()</CODE></A>.</TD> 384 </TR> 385 <TR BGCOLOR="white" CLASS="TableRowColor"> 386 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 387 <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A><? super <A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="type parameter in TreeMultimap">V</A>></CODE></FONT></TD> 388 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.html#valueComparator()">valueComparator</A></B>()</CODE> 389 390 <BR> 391 Returns the comparator that orders the multimap values, with a <code>null</code> 392 indicating that natural ordering is used.</TD> 393 </TR> 394 <TR BGCOLOR="white" CLASS="TableRowColor"> 395 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 396 <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><V></CODE></FONT></TD> 397 <TD><CODE><B><A HREF="../../../../com/google/common/collect/TreeMultimap.html#values()">values</A></B>()</CODE> 398 399 <BR> 400 Returns a collection of all values in the multimap.</TD> 401 </TR> 402 </TABLE> 403 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 404 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 405 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 406 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> 407 </TR> 408 <TR BGCOLOR="white" CLASS="TableRowColor"> 409 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> 410 </TR> 411 </TABLE> 412 <A NAME="methods_inherited_from_class_com.google.common.collect.SetMultimap"><!-- --></A> 413 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 414 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 415 <TH ALIGN="left"><B>Methods inherited from interface com.google.common.collect.<A HREF="../../../../com/google/common/collect/SetMultimap.html" title="interface in com.google.common.collect">SetMultimap</A></B></TH> 416 </TR> 417 <TR BGCOLOR="white" CLASS="TableRowColor"> 418 <TD><CODE><A HREF="../../../../com/google/common/collect/SetMultimap.html#entries()">entries</A>, <A HREF="../../../../com/google/common/collect/SetMultimap.html#equals(java.lang.Object)">equals</A></CODE></TD> 419 </TR> 420 </TABLE> 421 <A NAME="methods_inherited_from_class_com.google.common.collect.Multimap"><!-- --></A> 422 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 423 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 424 <TH ALIGN="left"><B>Methods inherited from interface com.google.common.collect.<A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A></B></TH> 425 </TR> 426 <TR BGCOLOR="white" CLASS="TableRowColor"> 427 <TD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#clear()">clear</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#containsEntry(java.lang.Object, java.lang.Object)">containsEntry</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#containsKey(java.lang.Object)">containsKey</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#containsValue(java.lang.Object)">containsValue</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#hashCode()">hashCode</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#isEmpty()">isEmpty</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#keys()">keys</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#put(K, V)">put</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#putAll(K, java.lang.Iterable)">putAll</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#putAll(com.google.common.collect.Multimap)">putAll</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#remove(java.lang.Object, java.lang.Object)">remove</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#size()">size</A></CODE></TD> 428 </TR> 429 </TABLE> 430 431 <P> 432 433 <!-- ============ METHOD DETAIL ========== --> 434 435 <A NAME="method_detail"><!-- --></A> 436 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 437 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 438 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 439 <B>Method Detail</B></FONT></TH> 440 </TR> 441 </TABLE> 442 443 <A NAME="create()"><!-- --></A><H3> 444 create</H3> 445 <PRE> 446 public static <K extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>,V extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>> <A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="class in com.google.common.collect">TreeMultimap</A><K,V> <B>create</B>()</PRE> 447 <DL> 448 <DD>Creates an empty <code>TreeMultimap</code> ordered by the natural ordering of 449 its keys and values. 450 <P> 451 <DD><DL> 452 </DL> 453 </DD> 454 </DL> 455 <HR> 456 457 <A NAME="create(java.util.Comparator, java.util.Comparator)"><!-- --></A><H3> 458 create</H3> 459 <PRE> 460 public static <K,V> <A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="class in com.google.common.collect">TreeMultimap</A><K,V> <B>create</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A><? super K> keyComparator, 461 <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A><? super V> valueComparator)</PRE> 462 <DL> 463 <DD>Creates an empty <code>TreeMultimap</code> instance using explicit comparators. 464 Neither comparator may be null; use <A HREF="../../../../com/google/common/collect/Ordering.html#natural()"><CODE>Ordering.natural()</CODE></A> to specify 465 natural order. 466 <P> 467 <DD><DL> 468 <DT><B>Parameters:</B><DD><CODE>keyComparator</CODE> - the comparator that determines the key ordering<DD><CODE>valueComparator</CODE> - the comparator that determines the value ordering</DL> 469 </DD> 470 </DL> 471 <HR> 472 473 <A NAME="create(com.google.common.collect.Multimap)"><!-- --></A><H3> 474 create</H3> 475 <PRE> 476 public static <K extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>,V extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>> <A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="class in com.google.common.collect">TreeMultimap</A><K,V> <B>create</B>(<A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><? extends K,? extends V> multimap)</PRE> 477 <DL> 478 <DD>Constructs a <code>TreeMultimap</code>, ordered by the natural ordering of its 479 keys and values, with the same mappings as the specified multimap. 480 <P> 481 <DD><DL> 482 <DT><B>Parameters:</B><DD><CODE>multimap</CODE> - the multimap whose contents are copied to this multimap</DL> 483 </DD> 484 </DL> 485 <HR> 486 487 <A NAME="keyComparator()"><!-- --></A><H3> 488 keyComparator</H3> 489 <PRE> 490 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A><? super <A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="type parameter in TreeMultimap">K</A>> <B>keyComparator</B>()</PRE> 491 <DL> 492 <DD>Returns the comparator that orders the multimap keys. 493 <P> 494 <DD><DL> 495 </DL> 496 </DD> 497 </DL> 498 <HR> 499 500 <A NAME="valueComparator()"><!-- --></A><H3> 501 valueComparator</H3> 502 <PRE> 503 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A><? super <A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="type parameter in TreeMultimap">V</A>> <B>valueComparator</B>()</PRE> 504 <DL> 505 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/SortedSetMultimap.html#valueComparator()">SortedSetMultimap</A></CODE></B></DD> 506 <DD>Returns the comparator that orders the multimap values, with a <code>null</code> 507 indicating that natural ordering is used. 508 <P> 509 <DD><DL> 510 </DL> 511 </DD> 512 </DL> 513 <HR> 514 515 <A NAME="keySet()"><!-- --></A><H3> 516 keySet</H3> 517 <PRE> 518 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</A><<A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="type parameter in TreeMultimap">K</A>> <B>keySet</B>()</PRE> 519 <DL> 520 <DD>Returns the set of all keys, each appearing once in the returned set. 521 Changes to the returned set will update the underlying multimap, and vice 522 versa. 523 524 <p>Because a <code>TreeMultimap</code> has unique sorted keys, this method 525 returns a <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util"><CODE>SortedSet</CODE></A>, instead of the <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util"><CODE>Set</CODE></A> specified in the 526 <A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect"><CODE>Multimap</CODE></A> interface. 527 <P> 528 <DD><DL> 529 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#keySet()">keySet</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><<A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="type parameter in TreeMultimap">K</A>,<A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="type parameter in TreeMultimap">V</A>></CODE></DL> 530 </DD> 531 <DD><DL> 532 533 <DT><B>Returns:</B><DD>the collection of distinct keys</DL> 534 </DD> 535 </DL> 536 <HR> 537 538 <A NAME="asMap()"><!-- --></A><H3> 539 asMap</H3> 540 <PRE> 541 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</A><<A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="type parameter in TreeMultimap">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><<A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="type parameter in TreeMultimap">V</A>>> <B>asMap</B>()</PRE> 542 <DL> 543 <DD>Returns a map view that associates each key with the corresponding values 544 in the multimap. Changes to the returned map, such as element removal, 545 will update the underlying multimap. The map does not support 546 <code>setValue()</code> on its entries, <code>put</code>, or <code>putAll</code>. 547 548 <p>The collections returned by <code>asMap().get(Object)</code> have the same 549 behavior as those returned by <A HREF="../../../../com/google/common/collect/Multimap.html#get(K)"><CODE>Multimap.get(K)</CODE></A>. 550 551 <p>Because a <code>TreeMultimap</code> has unique sorted keys, this method 552 returns a <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util"><CODE>SortedMap</CODE></A>, instead of the <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><CODE>Map</CODE></A> specified 553 in the <A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect"><CODE>Multimap</CODE></A> interface. 554 <P> 555 <DD><DL> 556 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#asMap()">asMap</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><<A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="type parameter in TreeMultimap">K</A>,<A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="type parameter in TreeMultimap">V</A>></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/SetMultimap.html#asMap()">asMap</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/SetMultimap.html" title="interface in com.google.common.collect">SetMultimap</A><<A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="type parameter in TreeMultimap">K</A>,<A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="type parameter in TreeMultimap">V</A>></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/SortedSetMultimap.html#asMap()">asMap</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="interface in com.google.common.collect">SortedSetMultimap</A><<A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="type parameter in TreeMultimap">K</A>,<A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="type parameter in TreeMultimap">V</A>></CODE></DL> 557 </DD> 558 <DD><DL> 559 560 <DT><B>Returns:</B><DD>a map view from a key to its collection of values</DL> 561 </DD> 562 </DL> 563 <HR> 564 565 <A NAME="get(java.lang.Object)"><!-- --></A><A NAME="get(K)"><!-- --></A><H3> 566 get</H3> 567 <PRE> 568 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</A><V> <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> 569 K key)</PRE> 570 <DL> 571 <DD>Returns a collection view of all values associated with a key. If no 572 mappings in the multimap have the provided key, an empty collection is 573 returned. 574 575 <p>Changes to the returned collection will update the underlying multimap, 576 and vice versa. 577 578 <p>The returned collection is not serializable. 579 <P> 580 <DD><DL> 581 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#get(K)">get</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><K,V></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/SetMultimap.html#get(K)">get</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/SetMultimap.html" title="interface in com.google.common.collect">SetMultimap</A><K,V></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/SortedSetMultimap.html#get(K)">get</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="interface in com.google.common.collect">SortedSetMultimap</A><K,V></CODE></DL> 582 </DD> 583 <DD><DL> 584 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to search for in multimap 585 <DT><B>Returns:</B><DD>the collection of values that the key maps to</DL> 586 </DD> 587 </DL> 588 <HR> 589 590 <A NAME="removeAll(java.lang.Object)"><!-- --></A><H3> 591 removeAll</H3> 592 <PRE> 593 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</A><V> <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> 594 <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> key)</PRE> 595 <DL> 596 <DD>Removes all values associated with a given key. 597 598 <p>The returned collection is immutable. 599 <P> 600 <DD><DL> 601 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#removeAll(java.lang.Object)">removeAll</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><K,V></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/SetMultimap.html#removeAll(java.lang.Object)">removeAll</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/SetMultimap.html" title="interface in com.google.common.collect">SetMultimap</A><K,V></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/SortedSetMultimap.html#removeAll(java.lang.Object)">removeAll</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="interface in com.google.common.collect">SortedSetMultimap</A><K,V></CODE></DL> 602 </DD> 603 <DD><DL> 604 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key of entries to remove from the multimap 605 <DT><B>Returns:</B><DD>the collection of removed values, or an empty collection if no 606 values were associated with the provided key. The collection 607 <i>may</i> be modifiable, but updating it will have no effect on the 608 multimap.</DL> 609 </DD> 610 </DL> 611 <HR> 612 613 <A NAME="replaceValues(java.lang.Object,java.lang.Iterable)"><!-- --></A><A NAME="replaceValues(K, java.lang.Iterable)"><!-- --></A><H3> 614 replaceValues</H3> 615 <PRE> 616 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</A><V> <B>replaceValues</B>(K key, 617 <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><? extends V> values)</PRE> 618 <DL> 619 <DD>Stores a collection of values with the same key, replacing any existing 620 values for that key. 621 622 <p>The returned collection is immutable. 623 624 <p>Any duplicates in <code>values</code> will be stored in the multimap once. 625 <P> 626 <DD><DL> 627 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#replaceValues(K, java.lang.Iterable)">replaceValues</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><K,V></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/SetMultimap.html#replaceValues(K, java.lang.Iterable)">replaceValues</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/SetMultimap.html" title="interface in com.google.common.collect">SetMultimap</A><K,V></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/SortedSetMultimap.html#replaceValues(K, java.lang.Iterable)">replaceValues</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="interface in com.google.common.collect">SortedSetMultimap</A><K,V></CODE></DL> 628 </DD> 629 <DD><DL> 630 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to store in the multimap<DD><CODE>values</CODE> - values to store in the multimap 631 <DT><B>Returns:</B><DD>the collection of replaced values, or an empty collection if no 632 values were previously associated with the key. The collection 633 <i>may</i> be modifiable, but updating it will have no effect on the 634 multimap.</DL> 635 </DD> 636 </DL> 637 <HR> 638 639 <A NAME="values()"><!-- --></A><H3> 640 values</H3> 641 <PRE> 642 public <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><V> <B>values</B>()</PRE> 643 <DL> 644 <DD>Returns a collection of all values in the multimap. Changes to the returned 645 collection will update the underlying multimap, and vice versa. 646 647 <p>The iterator generated by the returned collection traverses the values 648 for one key, followed by the values of a second key, and so on. 649 650 Consequently, the values do not follow their natural ordering or the 651 ordering of the value comparator. 652 <P> 653 <DD><DL> 654 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#values()">values</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><K,V></CODE></DL> 655 </DD> 656 <DD><DL> 657 658 <DT><B>Returns:</B><DD>collection of values, which may include the same value multiple 659 times if it occurs in multiple mappings</DL> 660 </DD> 661 </DL> 662 <HR> 663 664 <A NAME="entries()"><!-- --></A><H3> 665 entries</H3> 666 <PRE> 667 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<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><K,V>> <B>entries</B>()</PRE> 668 <DL> 669 <DD>Returns a collection of all key-value pairs. Changes to the returned 670 collection will update the underlying multimap, and vice versa. The entries 671 collection does not support the <code>add</code> or <code>addAll</code> operations. 672 673 <p>The iterator generated by the returned collection traverses the values 674 for one key, followed by the values of a second key, and so on. 675 676 <p>Each entry is an immutable snapshot of a key-value mapping in the 677 multimap, taken at the time the entry is returned by a method call to the 678 collection or its iterator. 679 <P> 680 <DD><DL> 681 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#entries()">entries</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><K,V></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/SetMultimap.html#entries()">entries</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/SetMultimap.html" title="interface in com.google.common.collect">SetMultimap</A><K,V></CODE></DL> 682 </DD> 683 <DD><DL> 684 685 <DT><B>Returns:</B><DD>collection of map entries consisting of key-value pairs</DL> 686 </DD> 687 </DL> 688 <HR> 689 690 <A NAME="put(java.lang.Object,java.lang.Object)"><!-- --></A><A NAME="put(K, V)"><!-- --></A><H3> 691 put</H3> 692 <PRE> 693 public boolean <B>put</B>(K key, 694 V value)</PRE> 695 <DL> 696 <DD>Stores a key-value pair in the multimap. 697 <P> 698 <DD><DL> 699 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#put(K, V)">put</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><K,V></CODE></DL> 700 </DD> 701 <DD><DL> 702 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to store in the multimap<DD><CODE>value</CODE> - value to store in the multimap 703 <DT><B>Returns:</B><DD><code>true</code> if the method increased the size of the multimap, or 704 <code>false</code> if the multimap already contained the key-value pair</DL> 705 </DD> 706 </DL> 707 <HR> 708 709 <A NAME="equals(java.lang.Object)"><!-- --></A><H3> 710 equals</H3> 711 <PRE> 712 public boolean <B>equals</B>(<FONT SIZE="-1"><A HREF="http://jsr-305.googlecode.com/svn/trunk/javadoc/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</A></FONT> 713 <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> object)</PRE> 714 <DL> 715 <DD>Compares the specified object to this multimap for equality. 716 717 <p>Two <code>SetMultimap</code> instances are equal if, for each key, they 718 contain the same values. Equality does not depend on the ordering of keys 719 or values. 720 <P> 721 <DD><DL> 722 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#equals(java.lang.Object)">equals</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><K,V></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/SetMultimap.html#equals(java.lang.Object)">equals</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/SetMultimap.html" title="interface in com.google.common.collect">SetMultimap</A><K,V></CODE></DL> 723 </DD> 724 <DD><DL> 725 </DL> 726 </DD> 727 </DL> 728 <HR> 729 730 <A NAME="size()"><!-- --></A><H3> 731 size</H3> 732 <PRE> 733 public int <B>size</B>()</PRE> 734 <DL> 735 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#size()">Multimap</A></CODE></B></DD> 736 <DD>Returns the number of key-value pairs in the multimap. 737 <P> 738 <DD><DL> 739 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#size()">size</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><K,V></CODE></DL> 740 </DD> 741 <DD><DL> 742 </DL> 743 </DD> 744 </DL> 745 <HR> 746 747 <A NAME="isEmpty()"><!-- --></A><H3> 748 isEmpty</H3> 749 <PRE> 750 public boolean <B>isEmpty</B>()</PRE> 751 <DL> 752 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#isEmpty()">Multimap</A></CODE></B></DD> 753 <DD>Returns <code>true</code> if the multimap contains no key-value pairs. 754 <P> 755 <DD><DL> 756 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#isEmpty()">isEmpty</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><K,V></CODE></DL> 757 </DD> 758 <DD><DL> 759 </DL> 760 </DD> 761 </DL> 762 <HR> 763 764 <A NAME="containsKey(java.lang.Object)"><!-- --></A><H3> 765 containsKey</H3> 766 <PRE> 767 public 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> 768 <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> key)</PRE> 769 <DL> 770 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#containsKey(java.lang.Object)">Multimap</A></CODE></B></DD> 771 <DD>Returns <code>true</code> if the multimap contains any values for the specified 772 key. 773 <P> 774 <DD><DL> 775 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#containsKey(java.lang.Object)">containsKey</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><K,V></CODE></DL> 776 </DD> 777 <DD><DL> 778 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to search for in multimap</DL> 779 </DD> 780 </DL> 781 <HR> 782 783 <A NAME="containsValue(java.lang.Object)"><!-- --></A><H3> 784 containsValue</H3> 785 <PRE> 786 public 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> 787 <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> value)</PRE> 788 <DL> 789 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#containsValue(java.lang.Object)">Multimap</A></CODE></B></DD> 790 <DD>Returns <code>true</code> if the multimap contains the specified value for any 791 key. 792 <P> 793 <DD><DL> 794 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#containsValue(java.lang.Object)">containsValue</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><K,V></CODE></DL> 795 </DD> 796 <DD><DL> 797 <DT><B>Parameters:</B><DD><CODE>value</CODE> - value to search for in multimap</DL> 798 </DD> 799 </DL> 800 <HR> 801 802 <A NAME="containsEntry(java.lang.Object, java.lang.Object)"><!-- --></A><H3> 803 containsEntry</H3> 804 <PRE> 805 public 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> 806 <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> key, 807 <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> 808 <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> value)</PRE> 809 <DL> 810 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#containsEntry(java.lang.Object, java.lang.Object)">Multimap</A></CODE></B></DD> 811 <DD>Returns <code>true</code> if the multimap contains the specified key-value pair. 812 <P> 813 <DD><DL> 814 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#containsEntry(java.lang.Object, java.lang.Object)">containsEntry</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><K,V></CODE></DL> 815 </DD> 816 <DD><DL> 817 <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> 818 </DD> 819 </DL> 820 <HR> 821 822 <A NAME="remove(java.lang.Object, java.lang.Object)"><!-- --></A><H3> 823 remove</H3> 824 <PRE> 825 public 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> 826 <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> key, 827 <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> 828 <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> value)</PRE> 829 <DL> 830 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#remove(java.lang.Object, java.lang.Object)">Multimap</A></CODE></B></DD> 831 <DD>Removes a key-value pair from the multimap. 832 <P> 833 <DD><DL> 834 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#remove(java.lang.Object, java.lang.Object)">remove</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><K,V></CODE></DL> 835 </DD> 836 <DD><DL> 837 <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 838 <DT><B>Returns:</B><DD><code>true</code> if the multimap changed</DL> 839 </DD> 840 </DL> 841 <HR> 842 843 <A NAME="putAll(java.lang.Object,java.lang.Iterable)"><!-- --></A><A NAME="putAll(K, java.lang.Iterable)"><!-- --></A><H3> 844 putAll</H3> 845 <PRE> 846 public 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> 847 K key, 848 <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><? extends V> values)</PRE> 849 <DL> 850 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#putAll(K, java.lang.Iterable)">Multimap</A></CODE></B></DD> 851 <DD>Stores a collection of values with the same key. 852 <P> 853 <DD><DL> 854 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#putAll(K, java.lang.Iterable)">putAll</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><K,V></CODE></DL> 855 </DD> 856 <DD><DL> 857 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to store in the multimap<DD><CODE>values</CODE> - values to store in the multimap 858 <DT><B>Returns:</B><DD><code>true</code> if the multimap changed</DL> 859 </DD> 860 </DL> 861 <HR> 862 863 <A NAME="putAll(com.google.common.collect.Multimap)"><!-- --></A><H3> 864 putAll</H3> 865 <PRE> 866 public boolean <B>putAll</B>(<A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><? extends K,? extends V> multimap)</PRE> 867 <DL> 868 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#putAll(com.google.common.collect.Multimap)">Multimap</A></CODE></B></DD> 869 <DD>Copies all of another multimap's key-value pairs into this multimap. The 870 order in which the mappings are added is determined by 871 <code>multimap.entries()</code>. 872 <P> 873 <DD><DL> 874 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#putAll(com.google.common.collect.Multimap)">putAll</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><K,V></CODE></DL> 875 </DD> 876 <DD><DL> 877 <DT><B>Parameters:</B><DD><CODE>multimap</CODE> - mappings to store in this multimap 878 <DT><B>Returns:</B><DD><code>true</code> if the multimap changed</DL> 879 </DD> 880 </DL> 881 <HR> 882 883 <A NAME="clear()"><!-- --></A><H3> 884 clear</H3> 885 <PRE> 886 public void <B>clear</B>()</PRE> 887 <DL> 888 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#clear()">Multimap</A></CODE></B></DD> 889 <DD>Removes all key-value pairs from the multimap. 890 <P> 891 <DD><DL> 892 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#clear()">clear</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><K,V></CODE></DL> 893 </DD> 894 <DD><DL> 895 </DL> 896 </DD> 897 </DL> 898 <HR> 899 900 <A NAME="keys()"><!-- --></A><H3> 901 keys</H3> 902 <PRE> 903 public <A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A><K> <B>keys</B>()</PRE> 904 <DL> 905 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#keys()">Multimap</A></CODE></B></DD> 906 <DD>Returns a collection, which may contain duplicates, of all keys. The number 907 of times of key appears in the returned multiset equals the number of 908 mappings the key has in the multimap. Changes to the returned multiset will 909 update the underlying multimap, and vice versa. 910 <P> 911 <DD><DL> 912 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#keys()">keys</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><K,V></CODE></DL> 913 </DD> 914 <DD><DL> 915 916 <DT><B>Returns:</B><DD>a multiset with keys corresponding to the distinct keys of the 917 multimap and frequencies corresponding to the number of values that 918 each key maps to</DL> 919 </DD> 920 </DL> 921 <HR> 922 923 <A NAME="hashCode()"><!-- --></A><H3> 924 hashCode</H3> 925 <PRE> 926 public int <B>hashCode</B>()</PRE> 927 <DL> 928 <DD>Returns the hash code for this multimap. 929 930 <p>The hash code of a multimap is defined as the hash code of the map view, 931 as returned by <A HREF="../../../../com/google/common/collect/Multimap.html#asMap()"><CODE>Multimap.asMap()</CODE></A>. 932 <P> 933 <DD><DL> 934 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#hashCode()">hashCode</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><K,V></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> 935 </DD> 936 <DD><DL> 937 <DT><B>See Also:</B><DD><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#hashCode()" title="class or interface in java.util"><CODE>Map.hashCode()</CODE></A></DL> 938 </DD> 939 </DL> 940 <HR> 941 942 <A NAME="toString()"><!-- --></A><H3> 943 toString</H3> 944 <PRE> 945 public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE> 946 <DL> 947 <DD>Returns a string representation of the multimap, generated by calling 948 <code>toString</code> on the map returned by <A HREF="../../../../com/google/common/collect/Multimap.html#asMap()"><CODE>Multimap.asMap()</CODE></A>. 949 <P> 950 <DD><DL> 951 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</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> 952 </DD> 953 <DD><DL> 954 955 <DT><B>Returns:</B><DD>a string representation of the multimap</DL> 956 </DD> 957 </DL> 958 <!-- ========= END OF CLASS DATA ========= --> 959 <HR> 960 961 962 <!-- ======= START OF BOTTOM NAVBAR ====== --> 963 <A NAME="navbar_bottom"><!-- --></A> 964 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 965 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 966 <TR> 967 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 968 <A NAME="navbar_bottom_firstrow"><!-- --></A> 969 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 970 <TR ALIGN="center" VALIGN="top"> 971 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 972 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 973 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 974 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/TreeMultimap.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 975 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 976 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 977 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 978 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 979 </TR> 980 </TABLE> 981 </TD> 982 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 983 </EM> 984 </TD> 985 </TR> 986 987 <TR> 988 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 989 <A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="interface in com.google.common.collect"><B>PREV CLASS</B></A> 990 <A HREF="../../../../com/google/common/collect/TreeMultiset.html" title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD> 991 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 992 <A HREF="../../../../index.html?com/google/common/collect/TreeMultimap.html" target="_top"><B>FRAMES</B></A> 993 <A HREF="TreeMultimap.html" target="_top"><B>NO FRAMES</B></A> 994 <SCRIPT type="text/javascript"> 995 <!-- 996 if(window==top) { 997 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 998 } 999 //--> 1000 </SCRIPT> 1001 <NOSCRIPT> 1002 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 1003 </NOSCRIPT> 1004 1005 1006 </FONT></TD> 1007 </TR> 1008 <TR> 1009 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 1010 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 1011 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 1012 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 1013 </TR> 1014 </TABLE> 1015 <A NAME="skip-navbar_bottom"></A> 1016 <!-- ======== END OF BOTTOM NAVBAR ======= --> 1017 1018 <HR> 1019 1020 </BODY> 1021 </HTML> 1022
