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:57 PST 2010 --> 6 <TITLE> 7 ForwardingMultimap (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="ForwardingMultimap (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/ForwardingMultimap.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/ForwardingMapEntry.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A> 59 <A HREF="../../../../com/google/common/collect/ForwardingMultiset.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/ForwardingMultimap.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="ForwardingMultimap.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 81 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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 ForwardingMultimap<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/ForwardingObject.html" title="class in com.google.common.collect">com.google.common.collect.ForwardingObject</A> 97 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.google.common.collect.ForwardingMultimap<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></DD> 101 </DL> 102 <HR> 103 <DL> 104 <DT><PRE>public abstract class <B>ForwardingMultimap<K,V></B><DT>extends <A HREF="../../../../com/google/common/collect/ForwardingObject.html" title="class in com.google.common.collect">ForwardingObject</A><DT>implements <A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><K,V></DL> 105 </PRE> 106 107 <P> 108 A multimap which forwards all its method calls to another multimap. 109 Subclasses should override one or more methods to modify the behavior of 110 the backing multimap as desired per the <a 111 href="http://en.wikipedia.org/wiki/Decorator_pattern">decorator pattern</a>. 112 <P> 113 114 <P> 115 <DL> 116 <DT><B>Since:</B></DT> 117 <DD>2010.01.04 <b>stable</b> (imported from Google Collections Library)</DD> 118 <DT><B>Author:</B></DT> 119 <DD>Robert Konigsberg</DD> 120 <DT><B>See Also:</B><DD><A HREF="../../../../com/google/common/collect/ForwardingObject.html" title="class in com.google.common.collect"><CODE>ForwardingObject</CODE></A></DL> 121 <HR> 122 123 <P> 124 125 <!-- ======== CONSTRUCTOR SUMMARY ======== --> 126 127 <A NAME="constructor_summary"><!-- --></A> 128 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 129 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 130 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 131 <B>Constructor Summary</B></FONT></TH> 132 </TR> 133 <TR BGCOLOR="white" CLASS="TableRowColor"> 134 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultimap.html#ForwardingMultimap()">ForwardingMultimap</A></B>()</CODE> 135 136 <BR> 137 </TD> 138 </TR> 139 </TABLE> 140 141 <!-- ========== METHOD SUMMARY =========== --> 142 143 <A NAME="method_summary"><!-- --></A> 144 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 145 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 146 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 147 <B>Method Summary</B></FONT></TH> 148 </TR> 149 <TR BGCOLOR="white" CLASS="TableRowColor"> 150 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 151 <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><<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>>></CODE></FONT></TD> 152 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultimap.html#asMap()">asMap</A></B>()</CODE> 153 154 <BR> 155 Returns a map view that associates each key with the corresponding values 156 in the multimap.</TD> 157 </TR> 158 <TR BGCOLOR="white" CLASS="TableRowColor"> 159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 160 <CODE> void</CODE></FONT></TD> 161 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultimap.html#clear()">clear</A></B>()</CODE> 162 163 <BR> 164 Removes all key-value pairs from the multimap.</TD> 165 </TR> 166 <TR BGCOLOR="white" CLASS="TableRowColor"> 167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 168 <CODE> boolean</CODE></FONT></TD> 169 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultimap.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, 170 <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> 171 172 <BR> 173 Returns <code>true</code> if the multimap contains the specified key-value pair.</TD> 174 </TR> 175 <TR BGCOLOR="white" CLASS="TableRowColor"> 176 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 177 <CODE> boolean</CODE></FONT></TD> 178 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultimap.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> 179 180 <BR> 181 Returns <code>true</code> if the multimap contains any values for the specified 182 key.</TD> 183 </TR> 184 <TR BGCOLOR="white" CLASS="TableRowColor"> 185 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 186 <CODE> boolean</CODE></FONT></TD> 187 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultimap.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> 188 189 <BR> 190 Returns <code>true</code> if the multimap contains the specified value for any 191 key.</TD> 192 </TR> 193 <TR BGCOLOR="white" CLASS="TableRowColor"> 194 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 195 <CODE>protected abstract <A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE></FONT></TD> 196 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultimap.html#delegate()">delegate</A></B>()</CODE> 197 198 <BR> 199 Returns the backing delegate instance that methods are forwarded to.</TD> 200 </TR> 201 <TR BGCOLOR="white" CLASS="TableRowColor"> 202 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 203 <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="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/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>>></CODE></FONT></TD> 204 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultimap.html#entries()">entries</A></B>()</CODE> 205 206 <BR> 207 Returns a collection of all key-value pairs.</TD> 208 </TR> 209 <TR BGCOLOR="white" CLASS="TableRowColor"> 210 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 211 <CODE> boolean</CODE></FONT></TD> 212 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultimap.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> 213 214 <BR> 215 Compares the specified object with this multimap for equality.</TD> 216 </TR> 217 <TR BGCOLOR="white" CLASS="TableRowColor"> 218 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 219 <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/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE></FONT></TD> 220 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultimap.html#get(K)">get</A></B>(<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A> key)</CODE> 221 222 <BR> 223 Returns a collection view of all values associated with a key.</TD> 224 </TR> 225 <TR BGCOLOR="white" CLASS="TableRowColor"> 226 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 227 <CODE> int</CODE></FONT></TD> 228 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultimap.html#hashCode()">hashCode</A></B>()</CODE> 229 230 <BR> 231 Returns the hash code for this multimap.</TD> 232 </TR> 233 <TR BGCOLOR="white" CLASS="TableRowColor"> 234 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 235 <CODE> boolean</CODE></FONT></TD> 236 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultimap.html#isEmpty()">isEmpty</A></B>()</CODE> 237 238 <BR> 239 Returns <code>true</code> if the multimap contains no key-value pairs.</TD> 240 </TR> 241 <TR BGCOLOR="white" CLASS="TableRowColor"> 242 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 243 <CODE> <A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A><<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>></CODE></FONT></TD> 244 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultimap.html#keys()">keys</A></B>()</CODE> 245 246 <BR> 247 Returns a collection, which may contain duplicates, of all keys.</TD> 248 </TR> 249 <TR BGCOLOR="white" CLASS="TableRowColor"> 250 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 251 <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/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>></CODE></FONT></TD> 252 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultimap.html#keySet()">keySet</A></B>()</CODE> 253 254 <BR> 255 Returns the set of all keys, each appearing once in the returned set.</TD> 256 </TR> 257 <TR BGCOLOR="white" CLASS="TableRowColor"> 258 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 259 <CODE> boolean</CODE></FONT></TD> 260 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultimap.html#put(K, V)">put</A></B>(<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A> key, 261 <A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A> value)</CODE> 262 263 <BR> 264 Stores a key-value pair in the multimap.</TD> 265 </TR> 266 <TR BGCOLOR="white" CLASS="TableRowColor"> 267 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 268 <CODE> boolean</CODE></FONT></TD> 269 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultimap.html#putAll(K, java.lang.Iterable)">putAll</A></B>(<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A> key, 270 <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/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>> values)</CODE> 271 272 <BR> 273 Stores a collection of values with the same key.</TD> 274 </TR> 275 <TR BGCOLOR="white" CLASS="TableRowColor"> 276 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 277 <CODE> boolean</CODE></FONT></TD> 278 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultimap.html#putAll(com.google.common.collect.Multimap)">putAll</A></B>(<A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><? extends <A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,? extends <A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>> multimap)</CODE> 279 280 <BR> 281 Copies all of another multimap's key-value pairs into this multimap.</TD> 282 </TR> 283 <TR BGCOLOR="white" CLASS="TableRowColor"> 284 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 285 <CODE> boolean</CODE></FONT></TD> 286 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultimap.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, 287 <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> 288 289 <BR> 290 Removes a key-value pair from the multimap.</TD> 291 </TR> 292 <TR BGCOLOR="white" CLASS="TableRowColor"> 293 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 294 <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/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE></FONT></TD> 295 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultimap.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> 296 297 <BR> 298 Removes all values associated with a given key.</TD> 299 </TR> 300 <TR BGCOLOR="white" CLASS="TableRowColor"> 301 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 302 <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/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE></FONT></TD> 303 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultimap.html#replaceValues(K, java.lang.Iterable)">replaceValues</A></B>(<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A> key, 304 <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/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>> values)</CODE> 305 306 <BR> 307 Stores a collection of values with the same key, replacing any existing 308 values for that key.</TD> 309 </TR> 310 <TR BGCOLOR="white" CLASS="TableRowColor"> 311 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 312 <CODE> int</CODE></FONT></TD> 313 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultimap.html#size()">size</A></B>()</CODE> 314 315 <BR> 316 Returns the number of key-value pairs in the multimap.</TD> 317 </TR> 318 <TR BGCOLOR="white" CLASS="TableRowColor"> 319 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 320 <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/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE></FONT></TD> 321 <TD><CODE><B><A HREF="../../../../com/google/common/collect/ForwardingMultimap.html#values()">values</A></B>()</CODE> 322 323 <BR> 324 Returns a collection of all values in the multimap.</TD> 325 </TR> 326 </TABLE> 327 <A NAME="methods_inherited_from_class_com.google.common.collect.ForwardingObject"><!-- --></A> 328 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 329 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 330 <TH ALIGN="left"><B>Methods inherited from class com.google.common.collect.<A HREF="../../../../com/google/common/collect/ForwardingObject.html" title="class in com.google.common.collect">ForwardingObject</A></B></TH> 331 </TR> 332 <TR BGCOLOR="white" CLASS="TableRowColor"> 333 <TD><CODE><A HREF="../../../../com/google/common/collect/ForwardingObject.html#toString()">toString</A></CODE></TD> 334 </TR> 335 </TABLE> 336 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 337 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 338 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 339 <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> 340 </TR> 341 <TR BGCOLOR="white" CLASS="TableRowColor"> 342 <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> 343 </TR> 344 </TABLE> 345 346 <P> 347 348 <!-- ========= CONSTRUCTOR DETAIL ======== --> 349 350 <A NAME="constructor_detail"><!-- --></A> 351 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 352 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 353 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 354 <B>Constructor Detail</B></FONT></TH> 355 </TR> 356 </TABLE> 357 358 <A NAME="ForwardingMultimap()"><!-- --></A><H3> 359 ForwardingMultimap</H3> 360 <PRE> 361 public <B>ForwardingMultimap</B>()</PRE> 362 <DL> 363 </DL> 364 365 <!-- ============ METHOD DETAIL ========== --> 366 367 <A NAME="method_detail"><!-- --></A> 368 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 369 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 370 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 371 <B>Method Detail</B></FONT></TH> 372 </TR> 373 </TABLE> 374 375 <A NAME="delegate()"><!-- --></A><H3> 376 delegate</H3> 377 <PRE> 378 protected abstract <A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>> <B>delegate</B>()</PRE> 379 <DL> 380 <DD><B>Description copied from class: <CODE><A HREF="../../../../com/google/common/collect/ForwardingObject.html#delegate()">ForwardingObject</A></CODE></B></DD> 381 <DD>Returns the backing delegate instance that methods are forwarded to. 382 Abstract subclasses generally override this method with an abstract method 383 that has a more specific return type, such as <A HREF="../../../../com/google/common/collect/ForwardingSet.html#delegate()"><CODE>ForwardingSet.delegate()</CODE></A>. Concrete subclasses override this method to supply 384 the instance being decorated. 385 <P> 386 <DD><DL> 387 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ForwardingObject.html#delegate()">delegate</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ForwardingObject.html" title="class in com.google.common.collect">ForwardingObject</A></CODE></DL> 388 </DD> 389 <DD><DL> 390 </DL> 391 </DD> 392 </DL> 393 <HR> 394 395 <A NAME="asMap()"><!-- --></A><H3> 396 asMap</H3> 397 <PRE> 398 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><<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>>> <B>asMap</B>()</PRE> 399 <DL> 400 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#asMap()">Multimap</A></CODE></B></DD> 401 <DD>Returns a map view that associates each key with the corresponding values 402 in the multimap. Changes to the returned map, such as element removal, 403 will update the underlying multimap. The map does not support 404 <code>setValue()</code> on its entries, <code>put</code>, or <code>putAll</code>. 405 406 <p>The collections returned by <code>asMap().get(Object)</code> have the same 407 behavior as those returned by <A HREF="../../../../com/google/common/collect/Multimap.html#get(K)"><CODE>Multimap.get(K)</CODE></A>. 408 <P> 409 <DD><DL> 410 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#asMap()">asMap</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE></DL> 411 </DD> 412 <DD><DL> 413 414 <DT><B>Returns:</B><DD>a map view from a key to its collection of values</DL> 415 </DD> 416 </DL> 417 <HR> 418 419 <A NAME="clear()"><!-- --></A><H3> 420 clear</H3> 421 <PRE> 422 public void <B>clear</B>()</PRE> 423 <DL> 424 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#clear()">Multimap</A></CODE></B></DD> 425 <DD>Removes all key-value pairs from the multimap. 426 <P> 427 <DD><DL> 428 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#clear()">clear</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE></DL> 429 </DD> 430 <DD><DL> 431 </DL> 432 </DD> 433 </DL> 434 <HR> 435 436 <A NAME="containsEntry(java.lang.Object, java.lang.Object)"><!-- --></A><H3> 437 containsEntry</H3> 438 <PRE> 439 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> 440 <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, 441 <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> 442 <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> 443 <DL> 444 <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> 445 <DD>Returns <code>true</code> if the multimap contains the specified key-value pair. 446 <P> 447 <DD><DL> 448 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#containsEntry(java.lang.Object, java.lang.Object)">containsEntry</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE></DL> 449 </DD> 450 <DD><DL> 451 <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> 452 </DD> 453 </DL> 454 <HR> 455 456 <A NAME="containsKey(java.lang.Object)"><!-- --></A><H3> 457 containsKey</H3> 458 <PRE> 459 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> 460 <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> 461 <DL> 462 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#containsKey(java.lang.Object)">Multimap</A></CODE></B></DD> 463 <DD>Returns <code>true</code> if the multimap contains any values for the specified 464 key. 465 <P> 466 <DD><DL> 467 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#containsKey(java.lang.Object)">containsKey</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE></DL> 468 </DD> 469 <DD><DL> 470 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to search for in multimap</DL> 471 </DD> 472 </DL> 473 <HR> 474 475 <A NAME="containsValue(java.lang.Object)"><!-- --></A><H3> 476 containsValue</H3> 477 <PRE> 478 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> 479 <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> 480 <DL> 481 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#containsValue(java.lang.Object)">Multimap</A></CODE></B></DD> 482 <DD>Returns <code>true</code> if the multimap contains the specified value for any 483 key. 484 <P> 485 <DD><DL> 486 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#containsValue(java.lang.Object)">containsValue</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE></DL> 487 </DD> 488 <DD><DL> 489 <DT><B>Parameters:</B><DD><CODE>value</CODE> - value to search for in multimap</DL> 490 </DD> 491 </DL> 492 <HR> 493 494 <A NAME="entries()"><!-- --></A><H3> 495 entries</H3> 496 <PRE> 497 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="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/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>>> <B>entries</B>()</PRE> 498 <DL> 499 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#entries()">Multimap</A></CODE></B></DD> 500 <DD>Returns a collection of all key-value pairs. Changes to the returned 501 collection will update the underlying multimap, and vice versa. The entries 502 collection does not support the <code>add</code> or <code>addAll</code> operations. 503 <P> 504 <DD><DL> 505 <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/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE></DL> 506 </DD> 507 <DD><DL> 508 509 <DT><B>Returns:</B><DD>collection of map entries consisting of key-value pairs</DL> 510 </DD> 511 </DL> 512 <HR> 513 514 <A NAME="get(java.lang.Object)"><!-- --></A><A NAME="get(K)"><!-- --></A><H3> 515 get</H3> 516 <PRE> 517 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/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">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> 518 <A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A> key)</PRE> 519 <DL> 520 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#get(K)">Multimap</A></CODE></B></DD> 521 <DD>Returns a collection view of all values associated with a key. If no 522 mappings in the multimap have the provided key, an empty collection is 523 returned. 524 525 <p>Changes to the returned collection will update the underlying multimap, 526 and vice versa. 527 <P> 528 <DD><DL> 529 <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/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE></DL> 530 </DD> 531 <DD><DL> 532 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to search for in multimap 533 <DT><B>Returns:</B><DD>the collection of values that the key maps to</DL> 534 </DD> 535 </DL> 536 <HR> 537 538 <A NAME="isEmpty()"><!-- --></A><H3> 539 isEmpty</H3> 540 <PRE> 541 public boolean <B>isEmpty</B>()</PRE> 542 <DL> 543 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#isEmpty()">Multimap</A></CODE></B></DD> 544 <DD>Returns <code>true</code> if the multimap contains no key-value pairs. 545 <P> 546 <DD><DL> 547 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#isEmpty()">isEmpty</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE></DL> 548 </DD> 549 <DD><DL> 550 </DL> 551 </DD> 552 </DL> 553 <HR> 554 555 <A NAME="keys()"><!-- --></A><H3> 556 keys</H3> 557 <PRE> 558 public <A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A><<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>> <B>keys</B>()</PRE> 559 <DL> 560 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#keys()">Multimap</A></CODE></B></DD> 561 <DD>Returns a collection, which may contain duplicates, of all keys. The number 562 of times of key appears in the returned multiset equals the number of 563 mappings the key has in the multimap. Changes to the returned multiset will 564 update the underlying multimap, and vice versa. 565 <P> 566 <DD><DL> 567 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#keys()">keys</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE></DL> 568 </DD> 569 <DD><DL> 570 571 <DT><B>Returns:</B><DD>a multiset with keys corresponding to the distinct keys of the 572 multimap and frequencies corresponding to the number of values that 573 each key maps to</DL> 574 </DD> 575 </DL> 576 <HR> 577 578 <A NAME="keySet()"><!-- --></A><H3> 579 keySet</H3> 580 <PRE> 581 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/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>> <B>keySet</B>()</PRE> 582 <DL> 583 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#keySet()">Multimap</A></CODE></B></DD> 584 <DD>Returns the set of all keys, each appearing once in the returned set. 585 Changes to the returned set will update the underlying multimap, and vice 586 versa. 587 <P> 588 <DD><DL> 589 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#keySet()">keySet</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE></DL> 590 </DD> 591 <DD><DL> 592 593 <DT><B>Returns:</B><DD>the collection of distinct keys</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>(<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A> key, 602 <A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A> value)</PRE> 603 <DL> 604 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#put(K, V)">Multimap</A></CODE></B></DD> 605 <DD>Stores a key-value pair in the multimap. 606 607 <p>Some multimap implementations allow duplicate key-value pairs, in which 608 case <code>put</code> always adds a new key-value pair and increases the 609 multimap size by 1. Other implementations prohibit duplicates, and storing 610 a key-value pair that's already in the multimap has no effect. 611 <P> 612 <DD><DL> 613 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#put(K, V)">put</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE></DL> 614 </DD> 615 <DD><DL> 616 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to store in the multimap<DD><CODE>value</CODE> - value to store in the multimap 617 <DT><B>Returns:</B><DD><code>true</code> if the method increased the size of the multimap, or 618 <code>false</code> if the multimap already contained the key-value pair and 619 doesn't allow duplicates</DL> 620 </DD> 621 </DL> 622 <HR> 623 624 <A NAME="putAll(java.lang.Object,java.lang.Iterable)"><!-- --></A><A NAME="putAll(K, java.lang.Iterable)"><!-- --></A><H3> 625 putAll</H3> 626 <PRE> 627 public boolean <B>putAll</B>(<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A> key, 628 <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/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>> values)</PRE> 629 <DL> 630 <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> 631 <DD>Stores a collection of values with the same key. 632 <P> 633 <DD><DL> 634 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#putAll(K, java.lang.Iterable)">putAll</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE></DL> 635 </DD> 636 <DD><DL> 637 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to store in the multimap<DD><CODE>values</CODE> - values to store in the multimap 638 <DT><B>Returns:</B><DD><code>true</code> if the multimap changed</DL> 639 </DD> 640 </DL> 641 <HR> 642 643 <A NAME="putAll(com.google.common.collect.Multimap)"><!-- --></A><H3> 644 putAll</H3> 645 <PRE> 646 public boolean <B>putAll</B>(<A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><? extends <A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,? extends <A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>> multimap)</PRE> 647 <DL> 648 <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> 649 <DD>Copies all of another multimap's key-value pairs into this multimap. The 650 order in which the mappings are added is determined by 651 <code>multimap.entries()</code>. 652 <P> 653 <DD><DL> 654 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#putAll(com.google.common.collect.Multimap)">putAll</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE></DL> 655 </DD> 656 <DD><DL> 657 <DT><B>Parameters:</B><DD><CODE>multimap</CODE> - mappings to store in this multimap 658 <DT><B>Returns:</B><DD><code>true</code> if the multimap changed</DL> 659 </DD> 660 </DL> 661 <HR> 662 663 <A NAME="remove(java.lang.Object, java.lang.Object)"><!-- --></A><H3> 664 remove</H3> 665 <PRE> 666 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> 667 <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, 668 <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> 669 <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> 670 <DL> 671 <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> 672 <DD>Removes a key-value pair from the multimap. 673 <P> 674 <DD><DL> 675 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#remove(java.lang.Object, java.lang.Object)">remove</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE></DL> 676 </DD> 677 <DD><DL> 678 <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 679 <DT><B>Returns:</B><DD><code>true</code> if the multimap changed</DL> 680 </DD> 681 </DL> 682 <HR> 683 684 <A NAME="removeAll(java.lang.Object)"><!-- --></A><H3> 685 removeAll</H3> 686 <PRE> 687 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/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>> <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> 688 <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> 689 <DL> 690 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#removeAll(java.lang.Object)">Multimap</A></CODE></B></DD> 691 <DD>Removes all values associated with a given key. 692 <P> 693 <DD><DL> 694 <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/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE></DL> 695 </DD> 696 <DD><DL> 697 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key of entries to remove from the multimap 698 <DT><B>Returns:</B><DD>the collection of removed values, or an empty collection if no 699 values were associated with the provided key. The collection 700 <i>may</i> be modifiable, but updating it will have no effect on the 701 multimap.</DL> 702 </DD> 703 </DL> 704 <HR> 705 706 <A NAME="replaceValues(java.lang.Object,java.lang.Iterable)"><!-- --></A><A NAME="replaceValues(K, java.lang.Iterable)"><!-- --></A><H3> 707 replaceValues</H3> 708 <PRE> 709 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/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>> <B>replaceValues</B>(<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A> key, 710 <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/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>> values)</PRE> 711 <DL> 712 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#replaceValues(K, java.lang.Iterable)">Multimap</A></CODE></B></DD> 713 <DD>Stores a collection of values with the same key, replacing any existing 714 values for that key. 715 <P> 716 <DD><DL> 717 <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/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE></DL> 718 </DD> 719 <DD><DL> 720 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to store in the multimap<DD><CODE>values</CODE> - values to store in the multimap 721 <DT><B>Returns:</B><DD>the collection of replaced values, or an empty collection if no 722 values were previously associated with the key. The collection 723 <i>may</i> be modifiable, but updating it will have no effect on the 724 multimap.</DL> 725 </DD> 726 </DL> 727 <HR> 728 729 <A NAME="size()"><!-- --></A><H3> 730 size</H3> 731 <PRE> 732 public int <B>size</B>()</PRE> 733 <DL> 734 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#size()">Multimap</A></CODE></B></DD> 735 <DD>Returns the number of key-value pairs in the multimap. 736 <P> 737 <DD><DL> 738 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#size()">size</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE></DL> 739 </DD> 740 <DD><DL> 741 </DL> 742 </DD> 743 </DL> 744 <HR> 745 746 <A NAME="values()"><!-- --></A><H3> 747 values</H3> 748 <PRE> 749 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/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>> <B>values</B>()</PRE> 750 <DL> 751 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#values()">Multimap</A></CODE></B></DD> 752 <DD>Returns a collection of all values in the multimap. Changes to the returned 753 collection will update the underlying multimap, and vice versa. 754 <P> 755 <DD><DL> 756 <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/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE></DL> 757 </DD> 758 <DD><DL> 759 760 <DT><B>Returns:</B><DD>collection of values, which may include the same value multiple 761 times if it occurs in multiple mappings</DL> 762 </DD> 763 </DL> 764 <HR> 765 766 <A NAME="equals(java.lang.Object)"><!-- --></A><H3> 767 equals</H3> 768 <PRE> 769 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> 770 <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> 771 <DL> 772 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#equals(java.lang.Object)">Multimap</A></CODE></B></DD> 773 <DD>Compares the specified object with this multimap for equality. Two 774 multimaps are equal when their map views, as returned by <A HREF="../../../../com/google/common/collect/Multimap.html#asMap()"><CODE>Multimap.asMap()</CODE></A>, 775 are also equal. 776 777 <p>In general, two multimaps with identical key-value mappings may or may 778 not be equal, depending on the implementation. For example, two 779 <A HREF="../../../../com/google/common/collect/SetMultimap.html" title="interface in com.google.common.collect"><CODE>SetMultimap</CODE></A> instances with the same key-value mappings are equal, 780 but equality of two <A HREF="../../../../com/google/common/collect/ListMultimap.html" title="interface in com.google.common.collect"><CODE>ListMultimap</CODE></A> instances depends on the ordering 781 of the values for each key. 782 783 <p>A non-empty <A HREF="../../../../com/google/common/collect/SetMultimap.html" title="interface in com.google.common.collect"><CODE>SetMultimap</CODE></A> cannot be equal to a non-empty 784 <A HREF="../../../../com/google/common/collect/ListMultimap.html" title="interface in com.google.common.collect"><CODE>ListMultimap</CODE></A>, since their <A HREF="../../../../com/google/common/collect/Multimap.html#asMap()"><CODE>Multimap.asMap()</CODE></A> views contain unequal 785 collections as values. However, any two empty multimaps are equal, because 786 they both have empty <A HREF="../../../../com/google/common/collect/Multimap.html#asMap()"><CODE>Multimap.asMap()</CODE></A> views. 787 <P> 788 <DD><DL> 789 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#equals(java.lang.Object)">equals</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> 790 </DD> 791 <DD><DL> 792 </DL> 793 </DD> 794 </DL> 795 <HR> 796 797 <A NAME="hashCode()"><!-- --></A><H3> 798 hashCode</H3> 799 <PRE> 800 public int <B>hashCode</B>()</PRE> 801 <DL> 802 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#hashCode()">Multimap</A></CODE></B></DD> 803 <DD>Returns the hash code for this multimap. 804 805 <p>The hash code of a multimap is defined as the hash code of the map view, 806 as returned by <A HREF="../../../../com/google/common/collect/Multimap.html#asMap()"><CODE>Multimap.asMap()</CODE></A>. 807 <P> 808 <DD><DL> 809 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#hashCode()">hashCode</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A><<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">K</A>,<A HREF="../../../../com/google/common/collect/ForwardingMultimap.html" title="type parameter in ForwardingMultimap">V</A>></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> 810 </DD> 811 <DD><DL> 812 </DL> 813 </DD> 814 </DL> 815 <!-- ========= END OF CLASS DATA ========= --> 816 <HR> 817 818 819 <!-- ======= START OF BOTTOM NAVBAR ====== --> 820 <A NAME="navbar_bottom"><!-- --></A> 821 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 822 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 823 <TR> 824 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 825 <A NAME="navbar_bottom_firstrow"><!-- --></A> 826 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 827 <TR ALIGN="center" VALIGN="top"> 828 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 829 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 830 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 831 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ForwardingMultimap.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 832 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 833 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 834 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 835 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 836 </TR> 837 </TABLE> 838 </TD> 839 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 840 </EM> 841 </TD> 842 </TR> 843 844 <TR> 845 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 846 <A HREF="../../../../com/google/common/collect/ForwardingMapEntry.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A> 847 <A HREF="../../../../com/google/common/collect/ForwardingMultiset.html" title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD> 848 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 849 <A HREF="../../../../index.html?com/google/common/collect/ForwardingMultimap.html" target="_top"><B>FRAMES</B></A> 850 <A HREF="ForwardingMultimap.html" target="_top"><B>NO FRAMES</B></A> 851 <SCRIPT type="text/javascript"> 852 <!-- 853 if(window==top) { 854 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 855 } 856 //--> 857 </SCRIPT> 858 <NOSCRIPT> 859 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 860 </NOSCRIPT> 861 862 863 </FONT></TD> 864 </TR> 865 <TR> 866 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 867 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 868 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 869 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 870 </TR> 871 </TABLE> 872 <A NAME="skip-navbar_bottom"></A> 873 <!-- ======== END OF BOTTOM NAVBAR ======= --> 874 875 <HR> 876 877 </BODY> 878 </HTML> 879
