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