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 ImmutableSetMultimap (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="ImmutableSetMultimap (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/ImmutableSetMultimap.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/ImmutableSet.Builder.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A> 59 <A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.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/ImmutableSetMultimap.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="ImmutableSetMultimap.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 ImmutableSetMultimap<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 "><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="class in com.google.common.collect">com.google.common.collect.ImmutableMultimap</A><K,V> 97 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.google.common.collect.ImmutableSetMultimap<K,V></B> 98 </PRE> 99 <DL> 100 <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="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> 101 </DL> 102 <HR> 103 <DL> 104 <DT><PRE>public class <B>ImmutableSetMultimap<K,V></B><DT>extends <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="class in com.google.common.collect">ImmutableMultimap</A><K,V><DT>implements <A HREF="../../../../com/google/common/collect/SetMultimap.html" title="interface in com.google.common.collect">SetMultimap</A><K,V></DL> 105 </PRE> 106 107 <P> 108 An immutable <A HREF="../../../../com/google/common/collect/SetMultimap.html" title="interface in com.google.common.collect"><CODE>SetMultimap</CODE></A> with reliable user-specified key and value 109 iteration order. Does not permit null keys or values. 110 111 <p>Unlike <A HREF="../../../../com/google/common/collect/Multimaps.html#unmodifiableSetMultimap(com.google.common.collect.SetMultimap)"><CODE>Multimaps.unmodifiableSetMultimap(SetMultimap)</CODE></A>, which is 112 a <i>view</i> of a separate multimap which can still change, an instance of 113 <code>ImmutableSetMultimap</code> contains its own data and will <i>never</i> 114 change. <code>ImmutableSetMultimap</code> is convenient for 115 <code>public static final</code> multimaps ("constant multimaps") and also lets 116 you easily make a "defensive copy" of a multimap provided to your class by 117 a caller. 118 119 <p><b>Note</b>: Although this class is not final, it cannot be subclassed as 120 it has no public or protected constructors. Thus, instances of this class 121 are guaranteed to be immutable. 122 <P> 123 124 <P> 125 <DL> 126 <DT><B>Since:</B></DT> 127 <DD>2010.01.04 <b>stable</b> (imported from Google Collections Library)</DD> 128 <DT><B>Author:</B></DT> 129 <DD>Mike Ward</DD> 130 <DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#com.google.common.collect.ImmutableSetMultimap">Serialized Form</A></DL> 131 <HR> 132 133 <P> 134 <!-- ======== NESTED CLASS SUMMARY ======== --> 135 136 <A NAME="nested_class_summary"><!-- --></A> 137 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 138 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 139 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 140 <B>Nested Class Summary</B></FONT></TH> 141 </TR> 142 <TR BGCOLOR="white" CLASS="TableRowColor"> 143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 144 <CODE>static class</CODE></FONT></TD> 145 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.Builder.html" title="class in com.google.common.collect">ImmutableSetMultimap.Builder</A><<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.Builder.html" title="type parameter in ImmutableSetMultimap.Builder">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.Builder.html" title="type parameter in ImmutableSetMultimap.Builder">V</A>></B></CODE> 146 147 <BR> 148 A builder for creating immutable <code>SetMultimap</code> instances, especially 149 <code>public static final</code> multimaps ("constant multimaps").</TD> 150 </TR> 151 </TABLE> 152 153 <!-- ========== METHOD SUMMARY =========== --> 154 155 <A NAME="method_summary"><!-- --></A> 156 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 157 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 158 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 159 <B>Method Summary</B></FONT></TH> 160 </TR> 161 <TR BGCOLOR="white" CLASS="TableRowColor"> 162 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 163 <CODE>static 164 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 165 <TR ALIGN="right" VALIGN=""> 166 <TD NOWRAP><FONT SIZE="-1"> 167 <CODE><K,V> <A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.Builder.html" title="class in com.google.common.collect">ImmutableSetMultimap.Builder</A><K,V></CODE></FONT></TD> 168 </TR> 169 </TABLE> 170 </CODE></FONT></TD> 171 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html#builder()">builder</A></B>()</CODE> 172 173 <BR> 174 Returns a new <A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.Builder.html" title="class in com.google.common.collect"><CODE>ImmutableSetMultimap.Builder</CODE></A>.</TD> 175 </TR> 176 <TR BGCOLOR="white" CLASS="TableRowColor"> 177 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 178 <CODE>static 179 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 180 <TR ALIGN="right" VALIGN=""> 181 <TD NOWRAP><FONT SIZE="-1"> 182 <CODE><K,V> <A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="class in com.google.common.collect">ImmutableSetMultimap</A><K,V></CODE></FONT></TD> 183 </TR> 184 </TABLE> 185 </CODE></FONT></TD> 186 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.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> 187 188 <BR> 189 Returns an immutable set multimap containing the same mappings as 190 <code>multimap</code>.</TD> 191 </TR> 192 <TR BGCOLOR="white" CLASS="TableRowColor"> 193 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 194 <CODE> <A HREF="../../../../com/google/common/collect/ImmutableSet.html" title="class in com.google.common.collect">ImmutableSet</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/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">V</A>>></CODE></FONT></TD> 195 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html#entries()">entries</A></B>()</CODE> 196 197 <BR> 198 Returns an immutable collection of all key-value pairs in the multimap.</TD> 199 </TR> 200 <TR BGCOLOR="white" CLASS="TableRowColor"> 201 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 202 <CODE> <A HREF="../../../../com/google/common/collect/ImmutableSet.html" title="class in com.google.common.collect">ImmutableSet</A><<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">V</A>></CODE></FONT></TD> 203 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html#get(K)">get</A></B>(<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">K</A> key)</CODE> 204 205 <BR> 206 Returns an immutable set of the values for the given key.</TD> 207 </TR> 208 <TR BGCOLOR="white" CLASS="TableRowColor"> 209 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 210 <CODE>static 211 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 212 <TR ALIGN="right" VALIGN=""> 213 <TD NOWRAP><FONT SIZE="-1"> 214 <CODE><K,V> <A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="class in com.google.common.collect">ImmutableSetMultimap</A><K,V></CODE></FONT></TD> 215 </TR> 216 </TABLE> 217 </CODE></FONT></TD> 218 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html#of()">of</A></B>()</CODE> 219 220 <BR> 221 Returns the empty multimap.</TD> 222 </TR> 223 <TR BGCOLOR="white" CLASS="TableRowColor"> 224 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 225 <CODE>static 226 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 227 <TR ALIGN="right" VALIGN=""> 228 <TD NOWRAP><FONT SIZE="-1"> 229 <CODE><K,V> <A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="class in com.google.common.collect">ImmutableSetMultimap</A><K,V></CODE></FONT></TD> 230 </TR> 231 </TABLE> 232 </CODE></FONT></TD> 233 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html#of(K, V)">of</A></B>(K k1, 234 V v1)</CODE> 235 236 <BR> 237 Returns an immutable multimap containing a single entry.</TD> 238 </TR> 239 <TR BGCOLOR="white" CLASS="TableRowColor"> 240 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 241 <CODE>static 242 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 243 <TR ALIGN="right" VALIGN=""> 244 <TD NOWRAP><FONT SIZE="-1"> 245 <CODE><K,V> <A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="class in com.google.common.collect">ImmutableSetMultimap</A><K,V></CODE></FONT></TD> 246 </TR> 247 </TABLE> 248 </CODE></FONT></TD> 249 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html#of(K, V, K, V)">of</A></B>(K k1, 250 V v1, 251 K k2, 252 V v2)</CODE> 253 254 <BR> 255 Returns an immutable multimap containing the given entries, in order.</TD> 256 </TR> 257 <TR BGCOLOR="white" CLASS="TableRowColor"> 258 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 259 <CODE>static 260 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 261 <TR ALIGN="right" VALIGN=""> 262 <TD NOWRAP><FONT SIZE="-1"> 263 <CODE><K,V> <A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="class in com.google.common.collect">ImmutableSetMultimap</A><K,V></CODE></FONT></TD> 264 </TR> 265 </TABLE> 266 </CODE></FONT></TD> 267 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html#of(K, V, K, V, K, V)">of</A></B>(K k1, 268 V v1, 269 K k2, 270 V v2, 271 K k3, 272 V v3)</CODE> 273 274 <BR> 275 Returns an immutable multimap containing the given entries, in order.</TD> 276 </TR> 277 <TR BGCOLOR="white" CLASS="TableRowColor"> 278 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 279 <CODE>static 280 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 281 <TR ALIGN="right" VALIGN=""> 282 <TD NOWRAP><FONT SIZE="-1"> 283 <CODE><K,V> <A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="class in com.google.common.collect">ImmutableSetMultimap</A><K,V></CODE></FONT></TD> 284 </TR> 285 </TABLE> 286 </CODE></FONT></TD> 287 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html#of(K, V, K, V, K, V, K, V)">of</A></B>(K k1, 288 V v1, 289 K k2, 290 V v2, 291 K k3, 292 V v3, 293 K k4, 294 V v4)</CODE> 295 296 <BR> 297 Returns an immutable multimap containing the given entries, in order.</TD> 298 </TR> 299 <TR BGCOLOR="white" CLASS="TableRowColor"> 300 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 301 <CODE>static 302 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 303 <TR ALIGN="right" VALIGN=""> 304 <TD NOWRAP><FONT SIZE="-1"> 305 <CODE><K,V> <A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="class in com.google.common.collect">ImmutableSetMultimap</A><K,V></CODE></FONT></TD> 306 </TR> 307 </TABLE> 308 </CODE></FONT></TD> 309 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html#of(K, V, K, V, K, V, K, V, K, V)">of</A></B>(K k1, 310 V v1, 311 K k2, 312 V v2, 313 K k3, 314 V v3, 315 K k4, 316 V v4, 317 K k5, 318 V v5)</CODE> 319 320 <BR> 321 Returns an immutable multimap containing the given entries, in order.</TD> 322 </TR> 323 <TR BGCOLOR="white" CLASS="TableRowColor"> 324 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 325 <CODE> <A HREF="../../../../com/google/common/collect/ImmutableSet.html" title="class in com.google.common.collect">ImmutableSet</A><<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">V</A>></CODE></FONT></TD> 326 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.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> 327 328 <BR> 329 Guaranteed to throw an exception and leave the multimap unmodified.</TD> 330 </TR> 331 <TR BGCOLOR="white" CLASS="TableRowColor"> 332 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 333 <CODE> <A HREF="../../../../com/google/common/collect/ImmutableSet.html" title="class in com.google.common.collect">ImmutableSet</A><<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">V</A>></CODE></FONT></TD> 334 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html#replaceValues(K, java.lang.Iterable)">replaceValues</A></B>(<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">K</A> key, 335 <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/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">V</A>> values)</CODE> 336 337 <BR> 338 Guaranteed to throw an exception and leave the multimap unmodified.</TD> 339 </TR> 340 </TABLE> 341 <A NAME="methods_inherited_from_class_com.google.common.collect.ImmutableMultimap"><!-- --></A> 342 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 343 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 344 <TH ALIGN="left"><B>Methods inherited from class com.google.common.collect.<A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="class in com.google.common.collect">ImmutableMultimap</A></B></TH> 345 </TR> 346 <TR BGCOLOR="white" CLASS="TableRowColor"> 347 <TD><CODE><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#asMap()">asMap</A>, <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#clear()">clear</A>, <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#containsEntry(java.lang.Object, java.lang.Object)">containsEntry</A>, <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#containsKey(java.lang.Object)">containsKey</A>, <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#containsValue(java.lang.Object)">containsValue</A>, <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#equals(java.lang.Object)">equals</A>, <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#hashCode()">hashCode</A>, <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#isEmpty()">isEmpty</A>, <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#keys()">keys</A>, <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#keySet()">keySet</A>, <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#put(K, V)">put</A>, <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#putAll(K, java.lang.Iterable)">putAll</A>, <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#putAll(com.google.common.collect.Multimap)">putAll</A>, <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#remove(java.lang.Object, java.lang.Object)">remove</A>, <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#size()">size</A>, <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#toString()">toString</A>, <A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#values()">values</A></CODE></TD> 348 </TR> 349 </TABLE> 350 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 351 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 352 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 353 <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> 354 </TR> 355 <TR BGCOLOR="white" CLASS="TableRowColor"> 356 <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> 357 </TR> 358 </TABLE> 359 <A NAME="methods_inherited_from_class_com.google.common.collect.SetMultimap"><!-- --></A> 360 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 361 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 362 <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> 363 </TR> 364 <TR BGCOLOR="white" CLASS="TableRowColor"> 365 <TD><CODE><A HREF="../../../../com/google/common/collect/SetMultimap.html#asMap()">asMap</A>, <A HREF="../../../../com/google/common/collect/SetMultimap.html#equals(java.lang.Object)">equals</A></CODE></TD> 366 </TR> 367 </TABLE> 368 <A NAME="methods_inherited_from_class_com.google.common.collect.Multimap"><!-- --></A> 369 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 370 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 371 <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> 372 </TR> 373 <TR BGCOLOR="white" CLASS="TableRowColor"> 374 <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#keySet()">keySet</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>, <A HREF="../../../../com/google/common/collect/Multimap.html#values()">values</A></CODE></TD> 375 </TR> 376 </TABLE> 377 378 <P> 379 380 <!-- ============ METHOD DETAIL ========== --> 381 382 <A NAME="method_detail"><!-- --></A> 383 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 384 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 385 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 386 <B>Method Detail</B></FONT></TH> 387 </TR> 388 </TABLE> 389 390 <A NAME="of()"><!-- --></A><H3> 391 of</H3> 392 <PRE> 393 public static <K,V> <A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="class in com.google.common.collect">ImmutableSetMultimap</A><K,V> <B>of</B>()</PRE> 394 <DL> 395 <DD>Returns the empty multimap. 396 <P> 397 <DD><DL> 398 </DL> 399 </DD> 400 <DD><DL> 401 </DL> 402 </DD> 403 </DL> 404 <HR> 405 406 <A NAME="of(java.lang.Object,java.lang.Object)"><!-- --></A><A NAME="of(K, V)"><!-- --></A><H3> 407 of</H3> 408 <PRE> 409 public static <K,V> <A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="class in com.google.common.collect">ImmutableSetMultimap</A><K,V> <B>of</B>(K k1, 410 V v1)</PRE> 411 <DL> 412 <DD>Returns an immutable multimap containing a single entry. 413 <P> 414 <DD><DL> 415 </DL> 416 </DD> 417 <DD><DL> 418 </DL> 419 </DD> 420 </DL> 421 <HR> 422 423 <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> 424 of</H3> 425 <PRE> 426 public static <K,V> <A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="class in com.google.common.collect">ImmutableSetMultimap</A><K,V> <B>of</B>(K k1, 427 V v1, 428 K k2, 429 V v2)</PRE> 430 <DL> 431 <DD>Returns an immutable multimap containing the given entries, in order. 432 Repeated occurrences of an entry (according to <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>) after 433 the first are ignored. 434 <P> 435 <DD><DL> 436 </DL> 437 </DD> 438 <DD><DL> 439 </DL> 440 </DD> 441 </DL> 442 <HR> 443 444 <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> 445 of</H3> 446 <PRE> 447 public static <K,V> <A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="class in com.google.common.collect">ImmutableSetMultimap</A><K,V> <B>of</B>(K k1, 448 V v1, 449 K k2, 450 V v2, 451 K k3, 452 V v3)</PRE> 453 <DL> 454 <DD>Returns an immutable multimap containing the given entries, in order. 455 Repeated occurrences of an entry (according to <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>) after 456 the first are ignored. 457 <P> 458 <DD><DL> 459 </DL> 460 </DD> 461 <DD><DL> 462 </DL> 463 </DD> 464 </DL> 465 <HR> 466 467 <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> 468 of</H3> 469 <PRE> 470 public static <K,V> <A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="class in com.google.common.collect">ImmutableSetMultimap</A><K,V> <B>of</B>(K k1, 471 V v1, 472 K k2, 473 V v2, 474 K k3, 475 V v3, 476 K k4, 477 V v4)</PRE> 478 <DL> 479 <DD>Returns an immutable multimap containing the given entries, in order. 480 Repeated occurrences of an entry (according to <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>) after 481 the first are ignored. 482 <P> 483 <DD><DL> 484 </DL> 485 </DD> 486 <DD><DL> 487 </DL> 488 </DD> 489 </DL> 490 <HR> 491 492 <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> 493 of</H3> 494 <PRE> 495 public static <K,V> <A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="class in com.google.common.collect">ImmutableSetMultimap</A><K,V> <B>of</B>(K k1, 496 V v1, 497 K k2, 498 V v2, 499 K k3, 500 V v3, 501 K k4, 502 V v4, 503 K k5, 504 V v5)</PRE> 505 <DL> 506 <DD>Returns an immutable multimap containing the given entries, in order. 507 Repeated occurrences of an entry (according to <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>) after 508 the first are ignored. 509 <P> 510 <DD><DL> 511 </DL> 512 </DD> 513 <DD><DL> 514 </DL> 515 </DD> 516 </DL> 517 <HR> 518 519 <A NAME="builder()"><!-- --></A><H3> 520 builder</H3> 521 <PRE> 522 public static <K,V> <A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.Builder.html" title="class in com.google.common.collect">ImmutableSetMultimap.Builder</A><K,V> <B>builder</B>()</PRE> 523 <DL> 524 <DD>Returns a new <A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.Builder.html" title="class in com.google.common.collect"><CODE>ImmutableSetMultimap.Builder</CODE></A>. 525 <P> 526 <DD><DL> 527 </DL> 528 </DD> 529 <DD><DL> 530 </DL> 531 </DD> 532 </DL> 533 <HR> 534 535 <A NAME="copyOf(com.google.common.collect.Multimap)"><!-- --></A><H3> 536 copyOf</H3> 537 <PRE> 538 public static <K,V> <A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="class in com.google.common.collect">ImmutableSetMultimap</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> 539 <DL> 540 <DD>Returns an immutable set multimap containing the same mappings as 541 <code>multimap</code>. The generated multimap's key and value orderings 542 correspond to the iteration ordering of the <code>multimap.asMap()</code> view. 543 Repeated occurrences of an entry in the multimap after the first are 544 ignored. 545 546 <p><b>Note:</b> Despite what the method name suggests, if 547 <code>multimap</code> is an <code>ImmutableSetMultimap</code>, no copy will actually 548 be performed, and the given multimap itself will be returned. 549 <P> 550 <DD><DL> 551 </DL> 552 </DD> 553 <DD><DL> 554 555 <DT><B>Throws:</B> 556 <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 557 null</DL> 558 </DD> 559 </DL> 560 <HR> 561 562 <A NAME="get(java.lang.Object)"><!-- --></A><A NAME="get(K)"><!-- --></A><H3> 563 get</H3> 564 <PRE> 565 public <A HREF="../../../../com/google/common/collect/ImmutableSet.html" title="class in com.google.common.collect">ImmutableSet</A><<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">V</A>> <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> 566 <A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">K</A> key)</PRE> 567 <DL> 568 <DD>Returns an immutable set of the values for the given key. If no mappings 569 in the multimap have the provided key, an empty immutable set is returned. 570 The values are in the same order as the parameters used to build this 571 multimap. 572 <P> 573 <DD><DL> 574 <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/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">V</A>></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><<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">V</A>></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#get(K)">get</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="class in com.google.common.collect">ImmutableMultimap</A><<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">V</A>></CODE></DL> 575 </DD> 576 <DD><DL> 577 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to search for in multimap 578 <DT><B>Returns:</B><DD>the collection of values that the key maps to</DL> 579 </DD> 580 </DL> 581 <HR> 582 583 <A NAME="removeAll(java.lang.Object)"><!-- --></A><H3> 584 removeAll</H3> 585 <PRE> 586 public <A HREF="../../../../com/google/common/collect/ImmutableSet.html" title="class in com.google.common.collect">ImmutableSet</A><<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">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> 587 <DL> 588 <DD>Guaranteed to throw an exception and leave the multimap unmodified. 589 <P> 590 <DD><DL> 591 <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/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">V</A>></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><<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">V</A>></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#removeAll(java.lang.Object)">removeAll</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="class in com.google.common.collect">ImmutableMultimap</A><<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">V</A>></CODE></DL> 592 </DD> 593 <DD><DL> 594 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key of entries to remove from the multimap 595 <DT><B>Returns:</B><DD>the collection of removed values, or an empty collection if no 596 values were associated with the provided key. The collection 597 <i>may</i> be modifiable, but updating it will have no effect on the 598 multimap. 599 <DT><B>Throws:</B> 600 <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> 601 </DD> 602 </DL> 603 <HR> 604 605 <A NAME="replaceValues(java.lang.Object,java.lang.Iterable)"><!-- --></A><A NAME="replaceValues(K, java.lang.Iterable)"><!-- --></A><H3> 606 replaceValues</H3> 607 <PRE> 608 public <A HREF="../../../../com/google/common/collect/ImmutableSet.html" title="class in com.google.common.collect">ImmutableSet</A><<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">V</A>> <B>replaceValues</B>(<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">K</A> key, 609 <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/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">V</A>> values)</PRE> 610 <DL> 611 <DD>Guaranteed to throw an exception and leave the multimap unmodified. 612 <P> 613 <DD><DL> 614 <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/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">V</A>></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><<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">V</A>></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#replaceValues(K, java.lang.Iterable)">replaceValues</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="class in com.google.common.collect">ImmutableMultimap</A><<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">V</A>></CODE></DL> 615 </DD> 616 <DD><DL> 617 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to store in the multimap<DD><CODE>values</CODE> - values to store in the multimap 618 <DT><B>Returns:</B><DD>the collection of replaced values, or an empty collection if no 619 values were previously associated with the key. The collection 620 <i>may</i> be modifiable, but updating it will have no effect on the 621 multimap. 622 <DT><B>Throws:</B> 623 <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> 624 </DD> 625 </DL> 626 <HR> 627 628 <A NAME="entries()"><!-- --></A><H3> 629 entries</H3> 630 <PRE> 631 public <A HREF="../../../../com/google/common/collect/ImmutableSet.html" title="class in com.google.common.collect">ImmutableSet</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/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">V</A>>> <B>entries</B>()</PRE> 632 <DL> 633 <DD>Returns an immutable collection of all key-value pairs in the multimap. 634 Its iterator traverses the values for the first key, the values for the 635 second key, and so on. 636 <P> 637 <DD><DL> 638 <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/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">V</A>></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><<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">V</A>></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html#entries()">entries</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ImmutableMultimap.html" title="class in com.google.common.collect">ImmutableMultimap</A><<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.html" title="type parameter in ImmutableSetMultimap">V</A>></CODE></DL> 639 </DD> 640 <DD><DL> 641 642 <DT><B>Returns:</B><DD>collection of map entries consisting of key-value pairs</DL> 643 </DD> 644 </DL> 645 <!-- ========= END OF CLASS DATA ========= --> 646 <HR> 647 648 649 <!-- ======= START OF BOTTOM NAVBAR ====== --> 650 <A NAME="navbar_bottom"><!-- --></A> 651 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 652 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 653 <TR> 654 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 655 <A NAME="navbar_bottom_firstrow"><!-- --></A> 656 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 657 <TR ALIGN="center" VALIGN="top"> 658 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 659 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 660 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 661 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ImmutableSetMultimap.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 662 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 663 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 664 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 665 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 666 </TR> 667 </TABLE> 668 </TD> 669 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 670 </EM> 671 </TD> 672 </TR> 673 674 <TR> 675 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 676 <A HREF="../../../../com/google/common/collect/ImmutableSet.Builder.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A> 677 <A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.Builder.html" title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD> 678 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 679 <A HREF="../../../../index.html?com/google/common/collect/ImmutableSetMultimap.html" target="_top"><B>FRAMES</B></A> 680 <A HREF="ImmutableSetMultimap.html" target="_top"><B>NO FRAMES</B></A> 681 <SCRIPT type="text/javascript"> 682 <!-- 683 if(window==top) { 684 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 685 } 686 //--> 687 </SCRIPT> 688 <NOSCRIPT> 689 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 690 </NOSCRIPT> 691 692 693 </FONT></TD> 694 </TR> 695 <TR> 696 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 697 SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 698 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 699 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 700 </TR> 701 </TABLE> 702 <A NAME="skip-navbar_bottom"></A> 703 <!-- ======== END OF BOTTOM NAVBAR ======= --> 704 705 <HR> 706 707 </BODY> 708 </HTML> 709
