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:58 PST 2010 --> 6 <TITLE> 7 ImmutableMultimap (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="ImmutableMultimap (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/ImmutableMultimap.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/ImmutableMap.Builder.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A> 59 <A HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.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/ImmutableMultimap.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="ImmutableMultimap.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: <A HREF="#nested_class_summary">NESTED</A> | 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 ImmutableMultimap<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.ImmutableMultimap<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="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 <DL> 102 <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../com/google/common/collect/ImmutableListMultimap.html" title="class in com.google.common.collect">ImmutableListMultimap</A>, <A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="class in com.google.common.collect">ImmutableSetMultimap</A></DD> 103 </DL> 104 <HR> 105 <DL> 106 <DT><PRE>public abstract class <B>ImmutableMultimap<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><DT>implements <A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</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></DL> 107 </PRE> 108 109 <P> 110 An immutable <A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect"><CODE>Multimap</CODE></A>. Does not permit null keys or values. 111 112 <p>Unlike <A HREF="../../../../com/google/common/collect/Multimaps.html#unmodifiableMultimap(com.google.common.collect.Multimap)"><CODE>Multimaps.unmodifiableMultimap(Multimap)</CODE></A>, which is 113 a <i>view</i> of a separate multimap which can still change, an instance of 114 <code>ImmutableMultimap</code> contains its own data and will <i>never</i> 115 change. <code>ImmutableMultimap</code> is convenient for 116 <code>public static final</code> multimaps ("constant multimaps") and also lets 117 you easily make a "defensive copy" of a multimap provided to your class by 118 a caller. 119 120 <p><b>Note</b>: Although this class is not final, it cannot be subclassed as 121 it has no public or protected constructors. Thus, instances of this class 122 are guaranteed to be immutable. 123 <P> 124 125 <P> 126 <DL> 127 <DT><B>Since:</B></DT> 128 <DD>2010.01.04 <b>stable</b> (imported from Google Collections Library)</DD> 129 <DT><B>Author:</B></DT> 130 <DD>Jared Levy</DD> 131 <DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#com.google.common.collect.ImmutableMultimap">Serialized Form</A></DL> 132 <HR> 133 134 <P> 135 <!-- ======== NESTED CLASS SUMMARY ======== --> 136 137 <A NAME="nested_class_summary"><!-- --></A> 138 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 139 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 140 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 141 <B>Nested Class Summary</B></FONT></TH> 142 </TR> 143 <TR BGCOLOR="white" CLASS="TableRowColor"> 144 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 145 <CODE>static class</CODE></FONT></TD> 146 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html" title="class in com.google.common.collect">ImmutableMultimap.Builder</A><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html" title="type parameter in ImmutableMultimap.Builder">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html" title="type parameter in ImmutableMultimap.Builder">V</A>></B></CODE> 147 148 <BR> 149 A builder for creating immutable multimap instances, especially 150 <code>public static final</code> multimaps ("constant multimaps").</TD> 151 </TR> 152 </TABLE> 153 154 <!-- ========== METHOD SUMMARY =========== --> 155 156 <A NAME="method_summary"><!-- --></A> 157 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 158 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 159 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 160 <B>Method Summary</B></FONT></TH> 161 </TR> 162 <TR BGCOLOR="white" CLASS="TableRowColor"> 163 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 164 <CODE> <A HREF="../../../../com/google/common/collect/ImmutableMap.html" title="class in com.google.common.collect">ImmutableMap</A><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">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/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>>></CODE></FONT></TD> 165 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#asMap()">asMap</A></B>()</CODE> 166 167 <BR> 168 Returns an immutable map that associates each key with its corresponding 169 values in the multimap.</TD> 170 </TR> 171 <TR BGCOLOR="white" CLASS="TableRowColor"> 172 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 173 <CODE>static 174 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 175 <TR ALIGN="right" VALIGN=""> 176 <TD NOWRAP><FONT SIZE="-1"> 177 <CODE><K,V> <A HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html" title="class in com.google.common.collect">ImmutableMultimap.Builder</A><K,V></CODE></FONT></TD> 178 </TR> 179 </TABLE> 180 </CODE></FONT></TD> 181 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#builder()">builder</A></B>()</CODE> 182 183 <BR> 184 Returns a new builder.</TD> 185 </TR> 186 <TR BGCOLOR="white" CLASS="TableRowColor"> 187 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 188 <CODE> void</CODE></FONT></TD> 189 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#clear()">clear</A></B>()</CODE> 190 191 <BR> 192 Guaranteed to throw an exception and leave the multimap unmodified.</TD> 193 </TR> 194 <TR BGCOLOR="white" CLASS="TableRowColor"> 195 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 196 <CODE> boolean</CODE></FONT></TD> 197 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.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, 198 <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> 199 200 <BR> 201 Returns <code>true</code> if the multimap contains the specified key-value pair.</TD> 202 </TR> 203 <TR BGCOLOR="white" CLASS="TableRowColor"> 204 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 205 <CODE> boolean</CODE></FONT></TD> 206 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.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> 207 208 <BR> 209 Returns <code>true</code> if the multimap contains any values for the specified 210 key.</TD> 211 </TR> 212 <TR BGCOLOR="white" CLASS="TableRowColor"> 213 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 214 <CODE> boolean</CODE></FONT></TD> 215 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.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> 216 217 <BR> 218 Returns <code>true</code> if the multimap contains the specified value for any 219 key.</TD> 220 </TR> 221 <TR BGCOLOR="white" CLASS="TableRowColor"> 222 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 223 <CODE>static 224 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 225 <TR ALIGN="right" VALIGN=""> 226 <TD NOWRAP><FONT SIZE="-1"> 227 <CODE><K,V> <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="class in com.google.common.collect">ImmutableMultimap</A><K,V></CODE></FONT></TD> 228 </TR> 229 </TABLE> 230 </CODE></FONT></TD> 231 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#copyOf(com.google.common.collect.Multimap)">copyOf</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> 232 233 <BR> 234 Returns an immutable multimap containing the same mappings as 235 <code>multimap</code>.</TD> 236 </TR> 237 <TR BGCOLOR="white" CLASS="TableRowColor"> 238 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 239 <CODE> <A HREF="../../../../com/google/common/collect/ImmutableCollection.html" title="class in com.google.common.collect">ImmutableCollection</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><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>>></CODE></FONT></TD> 240 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#entries()">entries</A></B>()</CODE> 241 242 <BR> 243 Returns an immutable collection of all key-value pairs in the multimap.</TD> 244 </TR> 245 <TR BGCOLOR="white" CLASS="TableRowColor"> 246 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 247 <CODE> boolean</CODE></FONT></TD> 248 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.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> 249 250 <BR> 251 Compares the specified object with this multimap for equality.</TD> 252 </TR> 253 <TR BGCOLOR="white" CLASS="TableRowColor"> 254 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 255 <CODE>abstract <A HREF="../../../../com/google/common/collect/ImmutableCollection.html" title="class in com.google.common.collect">ImmutableCollection</A><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></CODE></FONT></TD> 256 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#get(K)">get</A></B>(<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A> key)</CODE> 257 258 <BR> 259 Returns an immutable collection of the values for the given key.</TD> 260 </TR> 261 <TR BGCOLOR="white" CLASS="TableRowColor"> 262 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 263 <CODE> int</CODE></FONT></TD> 264 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#hashCode()">hashCode</A></B>()</CODE> 265 266 <BR> 267 Returns the hash code for this multimap.</TD> 268 </TR> 269 <TR BGCOLOR="white" CLASS="TableRowColor"> 270 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 271 <CODE> boolean</CODE></FONT></TD> 272 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#isEmpty()">isEmpty</A></B>()</CODE> 273 274 <BR> 275 Returns <code>true</code> if the multimap contains no key-value pairs.</TD> 276 </TR> 277 <TR BGCOLOR="white" CLASS="TableRowColor"> 278 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 279 <CODE> <A HREF="../../../../com/google/common/collect/ImmutableMultiset.html" title="class in com.google.common.collect">ImmutableMultiset</A><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>></CODE></FONT></TD> 280 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#keys()">keys</A></B>()</CODE> 281 282 <BR> 283 Returns a collection, which may contain duplicates, of all keys.</TD> 284 </TR> 285 <TR BGCOLOR="white" CLASS="TableRowColor"> 286 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 287 <CODE> <A HREF="../../../../com/google/common/collect/ImmutableSet.html" title="class in com.google.common.collect">ImmutableSet</A><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>></CODE></FONT></TD> 288 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#keySet()">keySet</A></B>()</CODE> 289 290 <BR> 291 Returns an immutable set of the distinct keys in this multimap.</TD> 292 </TR> 293 <TR BGCOLOR="white" CLASS="TableRowColor"> 294 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 295 <CODE>static 296 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 297 <TR ALIGN="right" VALIGN=""> 298 <TD NOWRAP><FONT SIZE="-1"> 299 <CODE><K,V> <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="class in com.google.common.collect">ImmutableMultimap</A><K,V></CODE></FONT></TD> 300 </TR> 301 </TABLE> 302 </CODE></FONT></TD> 303 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#of()">of</A></B>()</CODE> 304 305 <BR> 306 Returns an empty multimap.</TD> 307 </TR> 308 <TR BGCOLOR="white" CLASS="TableRowColor"> 309 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 310 <CODE>static 311 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 312 <TR ALIGN="right" VALIGN=""> 313 <TD NOWRAP><FONT SIZE="-1"> 314 <CODE><K,V> <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="class in com.google.common.collect">ImmutableMultimap</A><K,V></CODE></FONT></TD> 315 </TR> 316 </TABLE> 317 </CODE></FONT></TD> 318 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#of(K, V)">of</A></B>(K k1, 319 V v1)</CODE> 320 321 <BR> 322 Returns an immutable multimap containing a single entry.</TD> 323 </TR> 324 <TR BGCOLOR="white" CLASS="TableRowColor"> 325 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 326 <CODE>static 327 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 328 <TR ALIGN="right" VALIGN=""> 329 <TD NOWRAP><FONT SIZE="-1"> 330 <CODE><K,V> <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="class in com.google.common.collect">ImmutableMultimap</A><K,V></CODE></FONT></TD> 331 </TR> 332 </TABLE> 333 </CODE></FONT></TD> 334 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#of(K, V, K, V)">of</A></B>(K k1, 335 V v1, 336 K k2, 337 V v2)</CODE> 338 339 <BR> 340 Returns an immutable multimap containing the given entries, in order.</TD> 341 </TR> 342 <TR BGCOLOR="white" CLASS="TableRowColor"> 343 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 344 <CODE>static 345 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 346 <TR ALIGN="right" VALIGN=""> 347 <TD NOWRAP><FONT SIZE="-1"> 348 <CODE><K,V> <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="class in com.google.common.collect">ImmutableMultimap</A><K,V></CODE></FONT></TD> 349 </TR> 350 </TABLE> 351 </CODE></FONT></TD> 352 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#of(K, V, K, V, K, V)">of</A></B>(K k1, 353 V v1, 354 K k2, 355 V v2, 356 K k3, 357 V v3)</CODE> 358 359 <BR> 360 Returns an immutable multimap containing the given entries, in order.</TD> 361 </TR> 362 <TR BGCOLOR="white" CLASS="TableRowColor"> 363 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 364 <CODE>static 365 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 366 <TR ALIGN="right" VALIGN=""> 367 <TD NOWRAP><FONT SIZE="-1"> 368 <CODE><K,V> <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="class in com.google.common.collect">ImmutableMultimap</A><K,V></CODE></FONT></TD> 369 </TR> 370 </TABLE> 371 </CODE></FONT></TD> 372 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#of(K, V, K, V, K, V, K, V)">of</A></B>(K k1, 373 V v1, 374 K k2, 375 V v2, 376 K k3, 377 V v3, 378 K k4, 379 V v4)</CODE> 380 381 <BR> 382 Returns an immutable multimap containing the given entries, in order.</TD> 383 </TR> 384 <TR BGCOLOR="white" CLASS="TableRowColor"> 385 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 386 <CODE>static 387 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 388 <TR ALIGN="right" VALIGN=""> 389 <TD NOWRAP><FONT SIZE="-1"> 390 <CODE><K,V> <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="class in com.google.common.collect">ImmutableMultimap</A><K,V></CODE></FONT></TD> 391 </TR> 392 </TABLE> 393 </CODE></FONT></TD> 394 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#of(K, V, K, V, K, V, K, V, K, V)">of</A></B>(K k1, 395 V v1, 396 K k2, 397 V v2, 398 K k3, 399 V v3, 400 K k4, 401 V v4, 402 K k5, 403 V v5)</CODE> 404 405 <BR> 406 Returns an immutable multimap containing the given entries, in order.</TD> 407 </TR> 408 <TR BGCOLOR="white" CLASS="TableRowColor"> 409 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 410 <CODE> boolean</CODE></FONT></TD> 411 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#put(K, V)">put</A></B>(<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A> key, 412 <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A> value)</CODE> 413 414 <BR> 415 Guaranteed to throw an exception and leave the multimap unmodified.</TD> 416 </TR> 417 <TR BGCOLOR="white" CLASS="TableRowColor"> 418 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 419 <CODE> boolean</CODE></FONT></TD> 420 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#putAll(K, java.lang.Iterable)">putAll</A></B>(<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A> key, 421 <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 <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>> values)</CODE> 422 423 <BR> 424 Guaranteed to throw an exception and leave the multimap unmodified.</TD> 425 </TR> 426 <TR BGCOLOR="white" CLASS="TableRowColor"> 427 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 428 <CODE> boolean</CODE></FONT></TD> 429 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.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 <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,? extends <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>> multimap)</CODE> 430 431 <BR> 432 Guaranteed to throw an exception and leave the multimap unmodified.</TD> 433 </TR> 434 <TR BGCOLOR="white" CLASS="TableRowColor"> 435 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 436 <CODE> boolean</CODE></FONT></TD> 437 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.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, 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> value)</CODE> 439 440 <BR> 441 Guaranteed to throw an exception and leave the multimap unmodified.</TD> 442 </TR> 443 <TR BGCOLOR="white" CLASS="TableRowColor"> 444 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 445 <CODE> <A HREF="../../../../com/google/common/collect/ImmutableCollection.html" title="class in com.google.common.collect">ImmutableCollection</A><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></CODE></FONT></TD> 446 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.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> 447 448 <BR> 449 Guaranteed to throw an exception and leave the multimap unmodified.</TD> 450 </TR> 451 <TR BGCOLOR="white" CLASS="TableRowColor"> 452 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 453 <CODE> <A HREF="../../../../com/google/common/collect/ImmutableCollection.html" title="class in com.google.common.collect">ImmutableCollection</A><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></CODE></FONT></TD> 454 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#replaceValues(K, java.lang.Iterable)">replaceValues</A></B>(<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A> key, 455 <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 <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>> values)</CODE> 456 457 <BR> 458 Guaranteed to throw an exception and leave the multimap unmodified.</TD> 459 </TR> 460 <TR BGCOLOR="white" CLASS="TableRowColor"> 461 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 462 <CODE> int</CODE></FONT></TD> 463 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#size()">size</A></B>()</CODE> 464 465 <BR> 466 Returns the number of key-value pairs in the multimap.</TD> 467 </TR> 468 <TR BGCOLOR="white" CLASS="TableRowColor"> 469 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 470 <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> 471 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#toString()">toString</A></B>()</CODE> 472 473 <BR> 474 </TD> 475 </TR> 476 <TR BGCOLOR="white" CLASS="TableRowColor"> 477 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 478 <CODE> <A HREF="../../../../com/google/common/collect/ImmutableCollection.html" title="class in com.google.common.collect">ImmutableCollection</A><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></CODE></FONT></TD> 479 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#values()">values</A></B>()</CODE> 480 481 <BR> 482 Returns an immutable collection of the values in this multimap.</TD> 483 </TR> 484 </TABLE> 485 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 486 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 487 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 488 <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> 489 </TR> 490 <TR BGCOLOR="white" CLASS="TableRowColor"> 491 <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> 492 </TR> 493 </TABLE> 494 495 <P> 496 497 <!-- ============ METHOD DETAIL ========== --> 498 499 <A NAME="method_detail"><!-- --></A> 500 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 501 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 502 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 503 <B>Method Detail</B></FONT></TH> 504 </TR> 505 </TABLE> 506 507 <A NAME="of()"><!-- --></A><H3> 508 of</H3> 509 <PRE> 510 public static <K,V> <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="class in com.google.common.collect">ImmutableMultimap</A><K,V> <B>of</B>()</PRE> 511 <DL> 512 <DD>Returns an empty multimap. 513 <P> 514 <DD><DL> 515 </DL> 516 </DD> 517 <DD><DL> 518 </DL> 519 </DD> 520 </DL> 521 <HR> 522 523 <A NAME="of(java.lang.Object,java.lang.Object)"><!-- --></A><A NAME="of(K, V)"><!-- --></A><H3> 524 of</H3> 525 <PRE> 526 public static <K,V> <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="class in com.google.common.collect">ImmutableMultimap</A><K,V> <B>of</B>(K k1, 527 V v1)</PRE> 528 <DL> 529 <DD>Returns an immutable multimap containing a single entry. 530 <P> 531 <DD><DL> 532 </DL> 533 </DD> 534 <DD><DL> 535 </DL> 536 </DD> 537 </DL> 538 <HR> 539 540 <A NAME="of(java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object)"><!-- --></A><A NAME="of(K, V, K, V)"><!-- --></A><H3> 541 of</H3> 542 <PRE> 543 public static <K,V> <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="class in com.google.common.collect">ImmutableMultimap</A><K,V> <B>of</B>(K k1, 544 V v1, 545 K k2, 546 V v2)</PRE> 547 <DL> 548 <DD>Returns an immutable multimap containing the given entries, in order. 549 <P> 550 <DD><DL> 551 </DL> 552 </DD> 553 <DD><DL> 554 </DL> 555 </DD> 556 </DL> 557 <HR> 558 559 <A NAME="of(java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object)"><!-- --></A><A NAME="of(K, V, K, V, K, V)"><!-- --></A><H3> 560 of</H3> 561 <PRE> 562 public static <K,V> <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="class in com.google.common.collect">ImmutableMultimap</A><K,V> <B>of</B>(K k1, 563 V v1, 564 K k2, 565 V v2, 566 K k3, 567 V v3)</PRE> 568 <DL> 569 <DD>Returns an immutable multimap containing the given entries, in order. 570 <P> 571 <DD><DL> 572 </DL> 573 </DD> 574 <DD><DL> 575 </DL> 576 </DD> 577 </DL> 578 <HR> 579 580 <A NAME="of(java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object)"><!-- --></A><A NAME="of(K, V, K, V, K, V, K, V)"><!-- --></A><H3> 581 of</H3> 582 <PRE> 583 public static <K,V> <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="class in com.google.common.collect">ImmutableMultimap</A><K,V> <B>of</B>(K k1, 584 V v1, 585 K k2, 586 V v2, 587 K k3, 588 V v3, 589 K k4, 590 V v4)</PRE> 591 <DL> 592 <DD>Returns an immutable multimap containing the given entries, in order. 593 <P> 594 <DD><DL> 595 </DL> 596 </DD> 597 <DD><DL> 598 </DL> 599 </DD> 600 </DL> 601 <HR> 602 603 <A NAME="of(java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object)"><!-- --></A><A NAME="of(K, V, K, V, K, V, K, V, K, V)"><!-- --></A><H3> 604 of</H3> 605 <PRE> 606 public static <K,V> <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="class in com.google.common.collect">ImmutableMultimap</A><K,V> <B>of</B>(K k1, 607 V v1, 608 K k2, 609 V v2, 610 K k3, 611 V v3, 612 K k4, 613 V v4, 614 K k5, 615 V v5)</PRE> 616 <DL> 617 <DD>Returns an immutable multimap containing the given entries, in order. 618 <P> 619 <DD><DL> 620 </DL> 621 </DD> 622 <DD><DL> 623 </DL> 624 </DD> 625 </DL> 626 <HR> 627 628 <A NAME="builder()"><!-- --></A><H3> 629 builder</H3> 630 <PRE> 631 public static <K,V> <A HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html" title="class in com.google.common.collect">ImmutableMultimap.Builder</A><K,V> <B>builder</B>()</PRE> 632 <DL> 633 <DD>Returns a new builder. The generated builder is equivalent to the builder 634 created by the <A HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html" title="class in com.google.common.collect"><CODE>ImmutableMultimap.Builder</CODE></A> constructor. 635 <P> 636 <DD><DL> 637 </DL> 638 </DD> 639 <DD><DL> 640 </DL> 641 </DD> 642 </DL> 643 <HR> 644 645 <A NAME="copyOf(com.google.common.collect.Multimap)"><!-- --></A><H3> 646 copyOf</H3> 647 <PRE> 648 public static <K,V> <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="class in com.google.common.collect">ImmutableMultimap</A><K,V> <B>copyOf</B>(<A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><? extends K,? extends V> multimap)</PRE> 649 <DL> 650 <DD>Returns an immutable multimap containing the same mappings as 651 <code>multimap</code>. The generated multimap's key and value orderings 652 correspond to the iteration ordering of the <code>multimap.asMap()</code> view. 653 654 <p><b>Note:</b> Despite what the method name suggests, if 655 <code>multimap</code> is an <code>ImmutableMultimap</code>, no copy will actually be 656 performed, and the given multimap itself will be returned. 657 <P> 658 <DD><DL> 659 </DL> 660 </DD> 661 <DD><DL> 662 663 <DT><B>Throws:</B> 664 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if any key or value in <code>multimap</code> is 665 null</DL> 666 </DD> 667 </DL> 668 <HR> 669 670 <A NAME="removeAll(java.lang.Object)"><!-- --></A><H3> 671 removeAll</H3> 672 <PRE> 673 public <A HREF="../../../../com/google/common/collect/ImmutableCollection.html" title="class in com.google.common.collect">ImmutableCollection</A><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>> <B>removeAll</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)</PRE> 674 <DL> 675 <DD>Guaranteed to throw an exception and leave the multimap unmodified. 676 <P> 677 <DD><DL> 678 <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><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></CODE></DL> 679 </DD> 680 <DD><DL> 681 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key of entries to remove from the multimap 682 <DT><B>Returns:</B><DD>the collection of removed values, or an empty collection if no 683 values were associated with the provided key. The collection 684 <i>may</i> be modifiable, but updating it will have no effect on the 685 multimap. 686 <DT><B>Throws:</B> 687 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - always</DL> 688 </DD> 689 </DL> 690 <HR> 691 692 <A NAME="replaceValues(java.lang.Object,java.lang.Iterable)"><!-- --></A><A NAME="replaceValues(K, java.lang.Iterable)"><!-- --></A><H3> 693 replaceValues</H3> 694 <PRE> 695 public <A HREF="../../../../com/google/common/collect/ImmutableCollection.html" title="class in com.google.common.collect">ImmutableCollection</A><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>> <B>replaceValues</B>(<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A> key, 696 <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 <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>> values)</PRE> 697 <DL> 698 <DD>Guaranteed to throw an exception and leave the multimap unmodified. 699 <P> 700 <DD><DL> 701 <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><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></CODE></DL> 702 </DD> 703 <DD><DL> 704 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to store in the multimap<DD><CODE>values</CODE> - values to store in the multimap 705 <DT><B>Returns:</B><DD>the collection of replaced values, or an empty collection if no 706 values were previously associated with the key. The collection 707 <i>may</i> be modifiable, but updating it will have no effect on the 708 multimap. 709 <DT><B>Throws:</B> 710 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - always</DL> 711 </DD> 712 </DL> 713 <HR> 714 715 <A NAME="clear()"><!-- --></A><H3> 716 clear</H3> 717 <PRE> 718 public void <B>clear</B>()</PRE> 719 <DL> 720 <DD>Guaranteed to throw an exception and leave the multimap unmodified. 721 <P> 722 <DD><DL> 723 <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><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></CODE></DL> 724 </DD> 725 <DD><DL> 726 727 <DT><B>Throws:</B> 728 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - always</DL> 729 </DD> 730 </DL> 731 <HR> 732 733 <A NAME="get(java.lang.Object)"><!-- --></A><A NAME="get(K)"><!-- --></A><H3> 734 get</H3> 735 <PRE> 736 public abstract <A HREF="../../../../com/google/common/collect/ImmutableCollection.html" title="class in com.google.common.collect">ImmutableCollection</A><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>> <B>get</B>(<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A> key)</PRE> 737 <DL> 738 <DD>Returns an immutable collection of the values for the given key. If no 739 mappings in the multimap have the provided key, an empty immutable 740 collection is returned. The values are in the same order as the parameters 741 used to build this multimap. 742 <P> 743 <DD><DL> 744 <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><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></CODE></DL> 745 </DD> 746 <DD><DL> 747 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to search for in multimap 748 <DT><B>Returns:</B><DD>the collection of values that the key maps to</DL> 749 </DD> 750 </DL> 751 <HR> 752 753 <A NAME="put(java.lang.Object,java.lang.Object)"><!-- --></A><A NAME="put(K, V)"><!-- --></A><H3> 754 put</H3> 755 <PRE> 756 public boolean <B>put</B>(<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A> key, 757 <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A> value)</PRE> 758 <DL> 759 <DD>Guaranteed to throw an exception and leave the multimap unmodified. 760 <P> 761 <DD><DL> 762 <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><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></CODE></DL> 763 </DD> 764 <DD><DL> 765 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to store in the multimap<DD><CODE>value</CODE> - value to store in the multimap 766 <DT><B>Returns:</B><DD><code>true</code> if the method increased the size of the multimap, or 767 <code>false</code> if the multimap already contained the key-value pair and 768 doesn't allow duplicates 769 <DT><B>Throws:</B> 770 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - always</DL> 771 </DD> 772 </DL> 773 <HR> 774 775 <A NAME="putAll(java.lang.Object,java.lang.Iterable)"><!-- --></A><A NAME="putAll(K, java.lang.Iterable)"><!-- --></A><H3> 776 putAll</H3> 777 <PRE> 778 public boolean <B>putAll</B>(<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A> key, 779 <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 <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>> values)</PRE> 780 <DL> 781 <DD>Guaranteed to throw an exception and leave the multimap unmodified. 782 <P> 783 <DD><DL> 784 <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><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></CODE></DL> 785 </DD> 786 <DD><DL> 787 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to store in the multimap<DD><CODE>values</CODE> - values to store in the multimap 788 <DT><B>Returns:</B><DD><code>true</code> if the multimap changed 789 <DT><B>Throws:</B> 790 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - always</DL> 791 </DD> 792 </DL> 793 <HR> 794 795 <A NAME="putAll(com.google.common.collect.Multimap)"><!-- --></A><H3> 796 putAll</H3> 797 <PRE> 798 public boolean <B>putAll</B>(<A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><? extends <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,? extends <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>> multimap)</PRE> 799 <DL> 800 <DD>Guaranteed to throw an exception and leave the multimap unmodified. 801 <P> 802 <DD><DL> 803 <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><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></CODE></DL> 804 </DD> 805 <DD><DL> 806 <DT><B>Parameters:</B><DD><CODE>multimap</CODE> - mappings to store in this multimap 807 <DT><B>Returns:</B><DD><code>true</code> if the multimap changed 808 <DT><B>Throws:</B> 809 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - always</DL> 810 </DD> 811 </DL> 812 <HR> 813 814 <A NAME="remove(java.lang.Object, java.lang.Object)"><!-- --></A><H3> 815 remove</H3> 816 <PRE> 817 public boolean <B>remove</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> key, 818 <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> 819 <DL> 820 <DD>Guaranteed to throw an exception and leave the multimap unmodified. 821 <P> 822 <DD><DL> 823 <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><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></CODE></DL> 824 </DD> 825 <DD><DL> 826 <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 827 <DT><B>Returns:</B><DD><code>true</code> if the multimap changed 828 <DT><B>Throws:</B> 829 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - always</DL> 830 </DD> 831 </DL> 832 <HR> 833 834 <A NAME="containsEntry(java.lang.Object, java.lang.Object)"><!-- --></A><H3> 835 containsEntry</H3> 836 <PRE> 837 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> 838 <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, 839 <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> 840 <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> 841 <DL> 842 <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> 843 <DD>Returns <code>true</code> if the multimap contains the specified key-value pair. 844 <P> 845 <DD><DL> 846 <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><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></CODE></DL> 847 </DD> 848 <DD><DL> 849 <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> 850 </DD> 851 </DL> 852 <HR> 853 854 <A NAME="containsKey(java.lang.Object)"><!-- --></A><H3> 855 containsKey</H3> 856 <PRE> 857 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> 858 <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> 859 <DL> 860 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#containsKey(java.lang.Object)">Multimap</A></CODE></B></DD> 861 <DD>Returns <code>true</code> if the multimap contains any values for the specified 862 key. 863 <P> 864 <DD><DL> 865 <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><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></CODE></DL> 866 </DD> 867 <DD><DL> 868 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to search for in multimap</DL> 869 </DD> 870 </DL> 871 <HR> 872 873 <A NAME="containsValue(java.lang.Object)"><!-- --></A><H3> 874 containsValue</H3> 875 <PRE> 876 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> 877 <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> 878 <DL> 879 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#containsValue(java.lang.Object)">Multimap</A></CODE></B></DD> 880 <DD>Returns <code>true</code> if the multimap contains the specified value for any 881 key. 882 <P> 883 <DD><DL> 884 <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><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></CODE></DL> 885 </DD> 886 <DD><DL> 887 <DT><B>Parameters:</B><DD><CODE>value</CODE> - value to search for in multimap</DL> 888 </DD> 889 </DL> 890 <HR> 891 892 <A NAME="isEmpty()"><!-- --></A><H3> 893 isEmpty</H3> 894 <PRE> 895 public boolean <B>isEmpty</B>()</PRE> 896 <DL> 897 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#isEmpty()">Multimap</A></CODE></B></DD> 898 <DD>Returns <code>true</code> if the multimap contains no key-value pairs. 899 <P> 900 <DD><DL> 901 <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><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></CODE></DL> 902 </DD> 903 <DD><DL> 904 </DL> 905 </DD> 906 </DL> 907 <HR> 908 909 <A NAME="size()"><!-- --></A><H3> 910 size</H3> 911 <PRE> 912 public int <B>size</B>()</PRE> 913 <DL> 914 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#size()">Multimap</A></CODE></B></DD> 915 <DD>Returns the number of key-value pairs in the multimap. 916 <P> 917 <DD><DL> 918 <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><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></CODE></DL> 919 </DD> 920 <DD><DL> 921 </DL> 922 </DD> 923 </DL> 924 <HR> 925 926 <A NAME="equals(java.lang.Object)"><!-- --></A><H3> 927 equals</H3> 928 <PRE> 929 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> 930 <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> 931 <DL> 932 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#equals(java.lang.Object)">Multimap</A></CODE></B></DD> 933 <DD>Compares the specified object with this multimap for equality. Two 934 multimaps are equal when their map views, as returned by <A HREF="../../../../com/google/common/collect/Multimap.html#asMap()"><CODE>Multimap.asMap()</CODE></A>, 935 are also equal. 936 937 <p>In general, two multimaps with identical key-value mappings may or may 938 not be equal, depending on the implementation. For example, two 939 <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, 940 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 941 of the values for each key. 942 943 <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 944 <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>Multimap.asMap()</CODE></A> views contain unequal 945 collections as values. However, any two empty multimaps are equal, because 946 they both have empty <A HREF="../../../../com/google/common/collect/Multimap.html#asMap()"><CODE>Multimap.asMap()</CODE></A> views. 947 <P> 948 <DD><DL> 949 <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><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> 950 </DD> 951 <DD><DL> 952 </DL> 953 </DD> 954 </DL> 955 <HR> 956 957 <A NAME="hashCode()"><!-- --></A><H3> 958 hashCode</H3> 959 <PRE> 960 public int <B>hashCode</B>()</PRE> 961 <DL> 962 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#hashCode()">Multimap</A></CODE></B></DD> 963 <DD>Returns the hash code for this multimap. 964 965 <p>The hash code of a multimap is defined as the hash code of the map view, 966 as returned by <A HREF="../../../../com/google/common/collect/Multimap.html#asMap()"><CODE>Multimap.asMap()</CODE></A>. 967 <P> 968 <DD><DL> 969 <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><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></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> 970 </DD> 971 <DD><DL> 972 </DL> 973 </DD> 974 </DL> 975 <HR> 976 977 <A NAME="toString()"><!-- --></A><H3> 978 toString</H3> 979 <PRE> 980 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> 981 <DL> 982 <DD><DL> 983 <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> 984 </DD> 985 <DD><DL> 986 </DL> 987 </DD> 988 </DL> 989 <HR> 990 991 <A NAME="keySet()"><!-- --></A><H3> 992 keySet</H3> 993 <PRE> 994 public <A HREF="../../../../com/google/common/collect/ImmutableSet.html" title="class in com.google.common.collect">ImmutableSet</A><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>> <B>keySet</B>()</PRE> 995 <DL> 996 <DD>Returns an immutable set of the distinct keys in this multimap. These keys 997 are ordered according to when they first appeared during the construction 998 of this multimap. 999 <P> 1000 <DD><DL> 1001 <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/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></CODE></DL> 1002 </DD> 1003 <DD><DL> 1004 1005 <DT><B>Returns:</B><DD>the collection of distinct keys</DL> 1006 </DD> 1007 </DL> 1008 <HR> 1009 1010 <A NAME="asMap()"><!-- --></A><H3> 1011 asMap</H3> 1012 <PRE> 1013 public <A HREF="../../../../com/google/common/collect/ImmutableMap.html" title="class in com.google.common.collect">ImmutableMap</A><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">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/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>>> <B>asMap</B>()</PRE> 1014 <DL> 1015 <DD>Returns an immutable map that associates each key with its corresponding 1016 values in the multimap. 1017 <P> 1018 <DD><DL> 1019 <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/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></CODE></DL> 1020 </DD> 1021 <DD><DL> 1022 1023 <DT><B>Returns:</B><DD>a map view from a key to its collection of values</DL> 1024 </DD> 1025 </DL> 1026 <HR> 1027 1028 <A NAME="entries()"><!-- --></A><H3> 1029 entries</H3> 1030 <PRE> 1031 public <A HREF="../../../../com/google/common/collect/ImmutableCollection.html" title="class in com.google.common.collect">ImmutableCollection</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><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>>> <B>entries</B>()</PRE> 1032 <DL> 1033 <DD>Returns an immutable collection of all key-value pairs in the multimap. Its 1034 iterator traverses the values for the first key, the values for the second 1035 key, and so on. 1036 <P> 1037 <DD><DL> 1038 <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><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></CODE></DL> 1039 </DD> 1040 <DD><DL> 1041 1042 <DT><B>Returns:</B><DD>collection of map entries consisting of key-value pairs</DL> 1043 </DD> 1044 </DL> 1045 <HR> 1046 1047 <A NAME="keys()"><!-- --></A><H3> 1048 keys</H3> 1049 <PRE> 1050 public <A HREF="../../../../com/google/common/collect/ImmutableMultiset.html" title="class in com.google.common.collect">ImmutableMultiset</A><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>> <B>keys</B>()</PRE> 1051 <DL> 1052 <DD>Returns a collection, which may contain duplicates, of all keys. The number 1053 of times a key appears in the returned multiset equals the number of 1054 mappings the key has in the multimap. Duplicate keys appear consecutively 1055 in the multiset's iteration order. 1056 <P> 1057 <DD><DL> 1058 <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><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></CODE></DL> 1059 </DD> 1060 <DD><DL> 1061 1062 <DT><B>Returns:</B><DD>a multiset with keys corresponding to the distinct keys of the 1063 multimap and frequencies corresponding to the number of values that 1064 each key maps to</DL> 1065 </DD> 1066 </DL> 1067 <HR> 1068 1069 <A NAME="values()"><!-- --></A><H3> 1070 values</H3> 1071 <PRE> 1072 public <A HREF="../../../../com/google/common/collect/ImmutableCollection.html" title="class in com.google.common.collect">ImmutableCollection</A><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>> <B>values</B>()</PRE> 1073 <DL> 1074 <DD>Returns an immutable collection of the values in this multimap. Its 1075 iterator traverses the values for the first key, the values for the second 1076 key, and so on. 1077 <P> 1078 <DD><DL> 1079 <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><<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="type parameter in ImmutableMultimap">V</A>></CODE></DL> 1080 </DD> 1081 <DD><DL> 1082 1083 <DT><B>Returns:</B><DD>collection of values, which may include the same value multiple 1084 times if it occurs in multiple mappings</DL> 1085 </DD> 1086 </DL> 1087 <!-- ========= END OF CLASS DATA ========= --> 1088 <HR> 1089 1090 1091 <!-- ======= START OF BOTTOM NAVBAR ====== --> 1092 <A NAME="navbar_bottom"><!-- --></A> 1093 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 1094 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 1095 <TR> 1096 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 1097 <A NAME="navbar_bottom_firstrow"><!-- --></A> 1098 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 1099 <TR ALIGN="center" VALIGN="top"> 1100 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 1101 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 1102 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 1103 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ImmutableMultimap.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 1104 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 1105 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 1106 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 1107 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 1108 </TR> 1109 </TABLE> 1110 </TD> 1111 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 1112 </EM> 1113 </TD> 1114 </TR> 1115 1116 <TR> 1117 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 1118 <A HREF="../../../../com/google/common/collect/ImmutableMap.Builder.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A> 1119 <A HREF="../../../../com/google/common/collect/ImmutableMultimap.Builder.html" title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD> 1120 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 1121 <A HREF="../../../../index.html?com/google/common/collect/ImmutableMultimap.html" target="_top"><B>FRAMES</B></A> 1122 <A HREF="ImmutableMultimap.html" target="_top"><B>NO FRAMES</B></A> 1123 <SCRIPT type="text/javascript"> 1124 <!-- 1125 if(window==top) { 1126 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 1127 } 1128 //--> 1129 </SCRIPT> 1130 <NOSCRIPT> 1131 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 1132 </NOSCRIPT> 1133 1134 1135 </FONT></TD> 1136 </TR> 1137 <TR> 1138 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 1139 SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 1140 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 1141 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 1142 </TR> 1143 </TABLE> 1144 <A NAME="skip-navbar_bottom"></A> 1145 <!-- ======== END OF BOTTOM NAVBAR ======= --> 1146 1147 <HR> 1148 1149 </BODY> 1150 </HTML> 1151
