a whole bunch of stuff
[ephemerata.git] / KezvhLib / lib / com.google.com.collect / javadoc / com / google / common / collect / HashMultimap.html
blob930a3f7493b6c6d7dbc773767dedd8fa40d0a786
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.5.0_06) on Wed Aug 20 17:16:45 PDT 2008 -->
6 <TITLE>
7 HashMultimap (Google Collections Library - snapshot-20080820 (ALPHA))
8 </TITLE>
10 <META NAME="keywords" CONTENT="com.google.common.collect.HashMultimap class">
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
14 <SCRIPT type="text/javascript">
15 function windowTitle()
17 parent.document.title="HashMultimap (Google Collections Library - snapshot-20080820 (ALPHA))";
19 </SCRIPT>
20 <NOSCRIPT>
21 </NOSCRIPT>
23 </HEAD>
25 <BODY BGCOLOR="white" onload="windowTitle();">
28 <!-- ========= START OF TOP NAVBAR ======= -->
29 <A NAME="navbar_top"><!-- --></A>
30 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
31 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
32 <TR>
33 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
34 <A NAME="navbar_top_firstrow"><!-- --></A>
35 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
36 <TR ALIGN="center" VALIGN="top">
37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
44 </TR>
45 </TABLE>
46 </TD>
47 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
48 </EM>
49 </TD>
50 </TR>
52 <TR>
53 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
54 &nbsp;<A HREF="../../../../com/google/common/collect/HashBiMap.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A>&nbsp;
55 &nbsp;<A HREF="../../../../com/google/common/collect/HashMultiset.html" title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57 <A HREF="../../../../index.html?com/google/common/collect/HashMultimap.html" target="_top"><B>FRAMES</B></A> &nbsp;
58 &nbsp;<A HREF="HashMultimap.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
59 &nbsp;<SCRIPT type="text/javascript">
60 <!--
61 if(window==top) {
62 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
64 //-->
65 </SCRIPT>
66 <NOSCRIPT>
67 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
68 </NOSCRIPT>
71 </FONT></TD>
72 </TR>
73 <TR>
74 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
75 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
76 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
77 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
78 </TR>
79 </TABLE>
80 <A NAME="skip-navbar_top"></A>
81 <!-- ========= END OF TOP NAVBAR ========= -->
83 <HR>
84 <!-- ======== START OF CLASS DATA ======== -->
85 <H2>
86 <FONT SIZE="-1">
87 com.google.common.collect</FONT>
88 <BR>
89 Class HashMultimap&lt;K,V&gt;</H2>
90 <PRE>
91 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
92 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.google.common.collect.HashMultimap&lt;K,V&gt;</B>
93 </PRE>
94 <DL>
95 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A>&lt;K,V&gt;, <A HREF="../../../../com/google/common/collect/SetMultimap.html" title="interface in com.google.common.collect">SetMultimap</A>&lt;K,V&gt;, <A HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html" title="class or interface in java.io">Serializable</A></DD>
96 </DL>
97 <HR>
98 <DL>
99 <DT><PRE>public final class <B>HashMultimap&lt;K,V&gt;</B><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></DL>
100 </PRE>
103 Implementation of <A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect"><CODE>Multimap</CODE></A> using hash tables.
105 <p>The multimap does not store duplicate key-value pairs. Adding a new
106 key-value pair equal to an existing key-value pair has no effect.
108 <p>Keys and values may be null. All optional multimap methods are supported,
109 and all returned views are modifiable.
111 <p>This class is not threadsafe when any concurrent operations update the
112 multimap. Concurrent read operations will work correctly. To allow concurrent
113 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>.
117 <DL>
118 <DT><B>Author:</B></DT>
119 <DD>Jared Levy</DD>
120 <DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#com.google.common.collect.HashMultimap">Serialized Form</A></DL>
121 <HR>
125 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
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/HashMultimap.html#HashMultimap()">HashMultimap</A></B>()</CODE>
136 <BR>
137 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs an empty <code>HashMultimap</code>.</TD>
138 </TR>
139 <TR BGCOLOR="white" CLASS="TableRowColor">
140 <TD><CODE><B><A HREF="../../../../com/google/common/collect/HashMultimap.html#HashMultimap(com.google.common.collect.Multimap)">HashMultimap</A></B>(<A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A>&lt;? extends <A HREF="../../../../com/google/common/collect/HashMultimap.html" title="type parameter in HashMultimap">K</A>,? extends <A HREF="../../../../com/google/common/collect/HashMultimap.html" title="type parameter in HashMultimap">V</A>&gt;&nbsp;multimap)</CODE>
142 <BR>
143 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a <code>HashMultimap</code> with the same mappings as the specified
144 <code>Multimap</code>.</TD>
145 </TR>
146 </TABLE>
147 &nbsp;
148 <!-- ========== METHOD SUMMARY =========== -->
150 <A NAME="method_summary"><!-- --></A>
151 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
152 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
153 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
154 <B>Method Summary</B></FONT></TH>
155 </TR>
156 <TR BGCOLOR="white" CLASS="TableRowColor">
157 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
158 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&lt;K,<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;V&gt;&gt;</CODE></FONT></TD>
159 <TD><CODE><B><A HREF="../../../../com/google/common/collect/HashMultimap.html#asMap()">asMap</A></B>()</CODE>
161 <BR>
162 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a map view that associates each key with the corresponding values
163 in the multimap.</TD>
164 </TR>
165 <TR BGCOLOR="white" CLASS="TableRowColor">
166 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
167 <CODE>&nbsp;void</CODE></FONT></TD>
168 <TD><CODE><B><A HREF="../../../../com/google/common/collect/HashMultimap.html#clear()">clear</A></B>()</CODE>
170 <BR>
171 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes all key-value pairs from the multimap.</TD>
172 </TR>
173 <TR BGCOLOR="white" CLASS="TableRowColor">
174 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
175 <CODE>&nbsp;boolean</CODE></FONT></TD>
176 <TD><CODE><B><A HREF="../../../../com/google/common/collect/HashMultimap.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" title="class or interface in java.lang">Object</A>&nbsp;key,
177 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;value)</CODE>
179 <BR>
180 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if the multimap contains the specified key-value pair.</TD>
181 </TR>
182 <TR BGCOLOR="white" CLASS="TableRowColor">
183 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
184 <CODE>&nbsp;boolean</CODE></FONT></TD>
185 <TD><CODE><B><A HREF="../../../../com/google/common/collect/HashMultimap.html#containsKey(java.lang.Object)">containsKey</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;key)</CODE>
187 <BR>
188 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if the multimap contains any values for the specified
189 key.</TD>
190 </TR>
191 <TR BGCOLOR="white" CLASS="TableRowColor">
192 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
193 <CODE>&nbsp;boolean</CODE></FONT></TD>
194 <TD><CODE><B><A HREF="../../../../com/google/common/collect/HashMultimap.html#containsValue(java.lang.Object)">containsValue</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;value)</CODE>
196 <BR>
197 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if the multimap contains the specified value for any
198 key.</TD>
199 </TR>
200 <TR BGCOLOR="white" CLASS="TableRowColor">
201 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
202 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A>&lt;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html" title="class or interface in java.util">Map.Entry</A>&lt;K,V&gt;&gt;</CODE></FONT></TD>
203 <TD><CODE><B><A HREF="../../../../com/google/common/collect/HashMultimap.html#entries()">entries</A></B>()</CODE>
205 <BR>
206 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a collection of all key-value pairs.</TD>
207 </TR>
208 <TR BGCOLOR="white" CLASS="TableRowColor">
209 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
210 <CODE>&nbsp;boolean</CODE></FONT></TD>
211 <TD><CODE><B><A HREF="../../../../com/google/common/collect/HashMultimap.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;obj)</CODE>
213 <BR>
214 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compares the specified object to this multimap for equality.</TD>
215 </TR>
216 <TR BGCOLOR="white" CLASS="TableRowColor">
217 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
218 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A>&lt;V&gt;</CODE></FONT></TD>
219 <TD><CODE><B><A HREF="../../../../com/google/common/collect/HashMultimap.html#get(K)">get</A></B>(K&nbsp;key)</CODE>
221 <BR>
222 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a collection view of all values associated with a key.</TD>
223 </TR>
224 <TR BGCOLOR="white" CLASS="TableRowColor">
225 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
226 <CODE>&nbsp;int</CODE></FONT></TD>
227 <TD><CODE><B><A HREF="../../../../com/google/common/collect/HashMultimap.html#hashCode()">hashCode</A></B>()</CODE>
229 <BR>
230 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the hash code for this multimap.</TD>
231 </TR>
232 <TR BGCOLOR="white" CLASS="TableRowColor">
233 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
234 <CODE>&nbsp;boolean</CODE></FONT></TD>
235 <TD><CODE><B><A HREF="../../../../com/google/common/collect/HashMultimap.html#isEmpty()">isEmpty</A></B>()</CODE>
237 <BR>
238 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if the multimap contains no key-value pairs.</TD>
239 </TR>
240 <TR BGCOLOR="white" CLASS="TableRowColor">
241 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
242 <CODE>&nbsp;<A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;K&gt;</CODE></FONT></TD>
243 <TD><CODE><B><A HREF="../../../../com/google/common/collect/HashMultimap.html#keys()">keys</A></B>()</CODE>
245 <BR>
246 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a collection, which may contain duplicates, of all keys.</TD>
247 </TR>
248 <TR BGCOLOR="white" CLASS="TableRowColor">
249 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
250 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A>&lt;K&gt;</CODE></FONT></TD>
251 <TD><CODE><B><A HREF="../../../../com/google/common/collect/HashMultimap.html#keySet()">keySet</A></B>()</CODE>
253 <BR>
254 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the set of all keys, each appearing once in the returned set.</TD>
255 </TR>
256 <TR BGCOLOR="white" CLASS="TableRowColor">
257 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
258 <CODE>&nbsp;boolean</CODE></FONT></TD>
259 <TD><CODE><B><A HREF="../../../../com/google/common/collect/HashMultimap.html#put(K, V)">put</A></B>(K&nbsp;key,
260 V&nbsp;value)</CODE>
262 <BR>
263 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stores a key-value pair in the multimap.</TD>
264 </TR>
265 <TR BGCOLOR="white" CLASS="TableRowColor">
266 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
267 <CODE>&nbsp;boolean</CODE></FONT></TD>
268 <TD><CODE><B><A HREF="../../../../com/google/common/collect/HashMultimap.html#putAll(K, java.lang.Iterable)">putAll</A></B>(K&nbsp;key,
269 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html" title="class or interface in java.lang">Iterable</A>&lt;? extends V&gt;&nbsp;values)</CODE>
271 <BR>
272 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stores a collection of values with the same key.</TD>
273 </TR>
274 <TR BGCOLOR="white" CLASS="TableRowColor">
275 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
276 <CODE>&nbsp;boolean</CODE></FONT></TD>
277 <TD><CODE><B><A HREF="../../../../com/google/common/collect/HashMultimap.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>&lt;? extends K,? extends V&gt;&nbsp;multimap)</CODE>
279 <BR>
280 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Copies all of another multimap's key-value pairs into this multimap.</TD>
281 </TR>
282 <TR BGCOLOR="white" CLASS="TableRowColor">
283 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
284 <CODE>&nbsp;boolean</CODE></FONT></TD>
285 <TD><CODE><B><A HREF="../../../../com/google/common/collect/HashMultimap.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" title="class or interface in java.lang">Object</A>&nbsp;key,
286 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;value)</CODE>
288 <BR>
289 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes a key-value pair from the multimap.</TD>
290 </TR>
291 <TR BGCOLOR="white" CLASS="TableRowColor">
292 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
293 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A>&lt;V&gt;</CODE></FONT></TD>
294 <TD><CODE><B><A HREF="../../../../com/google/common/collect/HashMultimap.html#removeAll(java.lang.Object)">removeAll</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;key)</CODE>
296 <BR>
297 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes all values associated with a given key.</TD>
298 </TR>
299 <TR BGCOLOR="white" CLASS="TableRowColor">
300 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
301 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A>&lt;V&gt;</CODE></FONT></TD>
302 <TD><CODE><B><A HREF="../../../../com/google/common/collect/HashMultimap.html#replaceValues(K, java.lang.Iterable)">replaceValues</A></B>(K&nbsp;key,
303 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html" title="class or interface in java.lang">Iterable</A>&lt;? extends V&gt;&nbsp;values)</CODE>
305 <BR>
306 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stores a collection of values with the same key, replacing any existing
307 values for that key.</TD>
308 </TR>
309 <TR BGCOLOR="white" CLASS="TableRowColor">
310 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
311 <CODE>protected &nbsp;void</CODE></FONT></TD>
312 <TD><CODE><B><A HREF="../../../../com/google/common/collect/HashMultimap.html#setMap(java.util.Map)">setMap</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&lt;K,<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;V&gt;&gt;&nbsp;map)</CODE>
314 <BR>
315 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used during deserialization only.</TD>
316 </TR>
317 <TR BGCOLOR="white" CLASS="TableRowColor">
318 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
319 <CODE>&nbsp;int</CODE></FONT></TD>
320 <TD><CODE><B><A HREF="../../../../com/google/common/collect/HashMultimap.html#size()">size</A></B>()</CODE>
322 <BR>
323 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of key-value pairs in the multimap.</TD>
324 </TR>
325 <TR BGCOLOR="white" CLASS="TableRowColor">
326 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
327 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
328 <TD><CODE><B><A HREF="../../../../com/google/common/collect/HashMultimap.html#toString()">toString</A></B>()</CODE>
330 <BR>
331 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a string representation of the multimap, generated by calling
332 <code>toString</code> on the map returned by <A HREF="../../../../com/google/common/collect/Multimap.html#asMap()"><CODE>Multimap.asMap()</CODE></A>.</TD>
333 </TR>
334 <TR BGCOLOR="white" CLASS="TableRowColor">
335 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
336 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;V&gt;</CODE></FONT></TD>
337 <TD><CODE><B><A HREF="../../../../com/google/common/collect/HashMultimap.html#values()">values</A></B>()</CODE>
339 <BR>
340 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a collection of all values in the multimap.</TD>
341 </TR>
342 </TABLE>
343 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
344 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
345 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
346 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH>
347 </TR>
348 <TR BGCOLOR="white" CLASS="TableRowColor">
349 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#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#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
350 </TR>
351 </TABLE>
352 &nbsp;<A NAME="methods_inherited_from_class_com.google.common.collect.SetMultimap"><!-- --></A>
353 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
354 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
355 <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>
356 </TR>
357 <TR BGCOLOR="white" CLASS="TableRowColor">
358 <TD><CODE><A HREF="../../../../com/google/common/collect/SetMultimap.html#asMap()">asMap</A></CODE></TD>
359 </TR>
360 </TABLE>
361 &nbsp;<A NAME="methods_inherited_from_class_com.google.common.collect.Multimap"><!-- --></A>
362 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
363 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
364 <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>
365 </TR>
366 <TR BGCOLOR="white" CLASS="TableRowColor">
367 <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>, <A HREF="../../../../com/google/common/collect/Multimap.html#values()">values</A></CODE></TD>
368 </TR>
369 </TABLE>
370 &nbsp;
373 <!-- ========= CONSTRUCTOR DETAIL ======== -->
375 <A NAME="constructor_detail"><!-- --></A>
376 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
377 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
378 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
379 <B>Constructor Detail</B></FONT></TH>
380 </TR>
381 </TABLE>
383 <A NAME="HashMultimap()"><!-- --></A><H3>
384 HashMultimap</H3>
385 <PRE>
386 public <B>HashMultimap</B>()</PRE>
387 <DL>
388 <DD>Constructs an empty <code>HashMultimap</code>.
390 </DL>
391 <HR>
393 <A NAME="HashMultimap(com.google.common.collect.Multimap)"><!-- --></A><H3>
394 HashMultimap</H3>
395 <PRE>
396 public <B>HashMultimap</B>(<A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A>&lt;? extends <A HREF="../../../../com/google/common/collect/HashMultimap.html" title="type parameter in HashMultimap">K</A>,? extends <A HREF="../../../../com/google/common/collect/HashMultimap.html" title="type parameter in HashMultimap">V</A>&gt;&nbsp;multimap)</PRE>
397 <DL>
398 <DD>Constructs a <code>HashMultimap</code> with the same mappings as the specified
399 <code>Multimap</code>. If a key-value mapping appears multiple times in the
400 input multimap, it only appears once in the constructed multimap.
402 <DL>
403 <DT><B>Parameters:</B><DD><CODE>multimap</CODE> - the multimap whose contents are copied to this multimap.<DT><B>See Also:</B><DD><A HREF="../../../../com/google/common/collect/HashMultimap.html#putAll(com.google.common.collect.Multimap)"><CODE>putAll(Multimap)</CODE></A></DL>
404 </DL>
406 <!-- ============ METHOD DETAIL ========== -->
408 <A NAME="method_detail"><!-- --></A>
409 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
410 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
411 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
412 <B>Method Detail</B></FONT></TH>
413 </TR>
414 </TABLE>
416 <A NAME="get(java.lang.Object)"><!-- --></A><A NAME="get(K)"><!-- --></A><H3>
417 get</H3>
418 <PRE>
419 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A>&lt;V&gt; <B>get</B>(<FONT SIZE="-1"><A HREF="../../../../com/google/common/base/Nullable.html" title="annotation in com.google.common.base">@Nullable</A></FONT>
420 K&nbsp;key)</PRE>
421 <DL>
422 <DD>Returns a collection view of all values associated with a key. If no
423 mappings in the multimap have the provided key, an empty collection is
424 returned.
426 <p>Changes to the returned collection will update the underlying multimap,
427 and vice versa.
429 <p>The returned collection is not serializable.
431 <DD><DL>
432 <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>&lt;K,V&gt;</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>&lt;K,V&gt;</CODE></DL>
433 </DD>
434 <DD><DL>
435 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to search for in multimap
436 <DT><B>Returns:</B><DD>the collection of values that the key maps to</DL>
437 </DD>
438 </DL>
439 <HR>
441 <A NAME="entries()"><!-- --></A><H3>
442 entries</H3>
443 <PRE>
444 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A>&lt;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html" title="class or interface in java.util">Map.Entry</A>&lt;K,V&gt;&gt; <B>entries</B>()</PRE>
445 <DL>
446 <DD>Returns a collection of all key-value pairs. Changes to the returned
447 collection will update the underlying multimap, and vice versa. The entries
448 collection does not support the <code>add</code> or <code>addAll</code> operations.
450 <p>The iterator generated by the returned collection traverses the values
451 for one key, followed by the values of a second key, and so on.
453 <DD><DL>
454 <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>&lt;K,V&gt;</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>&lt;K,V&gt;</CODE></DL>
455 </DD>
456 <DD><DL>
458 <DT><B>Returns:</B><DD>collection of map entries consisting of key-value pairs</DL>
459 </DD>
460 </DL>
461 <HR>
463 <A NAME="removeAll(java.lang.Object)"><!-- --></A><H3>
464 removeAll</H3>
465 <PRE>
466 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A>&lt;V&gt; <B>removeAll</B>(<FONT SIZE="-1"><A HREF="../../../../com/google/common/base/Nullable.html" title="annotation in com.google.common.base">@Nullable</A></FONT>
467 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;key)</PRE>
468 <DL>
469 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#removeAll(java.lang.Object)">Multimap</A></CODE></B></DD>
470 <DD>Removes all values associated with a given key.
472 <DD><DL>
473 <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>&lt;K,V&gt;</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>&lt;K,V&gt;</CODE></DL>
474 </DD>
475 <DD><DL>
476 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key of entries to remove from the multimap
477 <DT><B>Returns:</B><DD>the collection of removed values, or an empty collection if no
478 values were associated with the provided key. The collection
479 <i>may</i> be modifiable, but updating it will have no effect on the
480 multimap.</DL>
481 </DD>
482 </DL>
483 <HR>
485 <A NAME="replaceValues(java.lang.Object,java.lang.Iterable)"><!-- --></A><A NAME="replaceValues(K, java.lang.Iterable)"><!-- --></A><H3>
486 replaceValues</H3>
487 <PRE>
488 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A>&lt;V&gt; <B>replaceValues</B>(<FONT SIZE="-1"><A HREF="../../../../com/google/common/base/Nullable.html" title="annotation in com.google.common.base">@Nullable</A></FONT>
489 K&nbsp;key,
490 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html" title="class or interface in java.lang">Iterable</A>&lt;? extends V&gt;&nbsp;values)</PRE>
491 <DL>
492 <DD>Stores a collection of values with the same key, replacing any existing
493 values for that key.
495 <p>Any duplicates in <code>values</code> will be stored in the multimap once.
497 <DD><DL>
498 <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>&lt;K,V&gt;</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>&lt;K,V&gt;</CODE></DL>
499 </DD>
500 <DD><DL>
501 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to store in the multimap<DD><CODE>values</CODE> - values to store in the multimap
502 <DT><B>Returns:</B><DD>the collection of replaced values, or an empty collection if no
503 values were previously associated with the key. The collection
504 <i>may</i> be modifiable, but updating it will have no effect on the
505 multimap.</DL>
506 </DD>
507 </DL>
508 <HR>
510 <A NAME="put(java.lang.Object,java.lang.Object)"><!-- --></A><A NAME="put(K, V)"><!-- --></A><H3>
511 put</H3>
512 <PRE>
513 public boolean <B>put</B>(K&nbsp;key,
514 V&nbsp;value)</PRE>
515 <DL>
516 <DD>Stores a key-value pair in the multimap.
518 <DD><DL>
519 <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>&lt;K,V&gt;</CODE></DL>
520 </DD>
521 <DD><DL>
522 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to store in the multimap<DD><CODE>value</CODE> - value to store in the multimap
523 <DT><B>Returns:</B><DD><code>true</code> if the method increased the size of the multimap, or
524 <code>false</code> if the multimap already contained the key-value pair</DL>
525 </DD>
526 </DL>
527 <HR>
529 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>
530 equals</H3>
531 <PRE>
532 public boolean <B>equals</B>(<FONT SIZE="-1"><A HREF="../../../../com/google/common/base/Nullable.html" title="annotation in com.google.common.base">@Nullable</A></FONT>
533 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;obj)</PRE>
534 <DL>
535 <DD>Compares the specified object to this multimap for equality.
537 <p>Two <code>SetMultimap</code> instances are equal if, for each key, they
538 contain the same values. Equality does not depend on the ordering of keys
539 or values.
541 <DD><DL>
542 <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>&lt;K,V&gt;</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>&lt;K,V&gt;</CODE></DL>
543 </DD>
544 <DD><DL>
545 <DT><B>Parameters:</B><DD><CODE>obj</CODE> - the reference object with which to compare.
546 <DT><B>Returns:</B><DD><code>true</code> if this object is the same as the obj
547 argument; <code>false</code> otherwise.<DT><B>See Also:</B><DD><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang"><CODE>Object.hashCode()</CODE></A>,
548 <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Hashtable.html" title="class or interface in java.util"><CODE>Hashtable</CODE></A></DL>
549 </DD>
550 </DL>
551 <HR>
553 <A NAME="setMap(java.util.Map)"><!-- --></A><H3>
554 setMap</H3>
555 <PRE>
556 protected void <B>setMap</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&lt;K,<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;V&gt;&gt;&nbsp;map)</PRE>
557 <DL>
558 <DD>Used during deserialization only.
560 <DD><DL>
561 </DL>
562 </DD>
563 <DD><DL>
564 </DL>
565 </DD>
566 </DL>
567 <HR>
569 <A NAME="size()"><!-- --></A><H3>
570 size</H3>
571 <PRE>
572 public int <B>size</B>()</PRE>
573 <DL>
574 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#size()">Multimap</A></CODE></B></DD>
575 <DD>Returns the number of key-value pairs in the multimap.
577 <DD><DL>
578 <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>&lt;K,V&gt;</CODE></DL>
579 </DD>
580 <DD><DL>
581 </DL>
582 </DD>
583 </DL>
584 <HR>
586 <A NAME="isEmpty()"><!-- --></A><H3>
587 isEmpty</H3>
588 <PRE>
589 public boolean <B>isEmpty</B>()</PRE>
590 <DL>
591 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#isEmpty()">Multimap</A></CODE></B></DD>
592 <DD>Returns <code>true</code> if the multimap contains no key-value pairs.
594 <DD><DL>
595 <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>&lt;K,V&gt;</CODE></DL>
596 </DD>
597 <DD><DL>
598 </DL>
599 </DD>
600 </DL>
601 <HR>
603 <A NAME="containsKey(java.lang.Object)"><!-- --></A><H3>
604 containsKey</H3>
605 <PRE>
606 public boolean <B>containsKey</B>(<FONT SIZE="-1"><A HREF="../../../../com/google/common/base/Nullable.html" title="annotation in com.google.common.base">@Nullable</A></FONT>
607 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;key)</PRE>
608 <DL>
609 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#containsKey(java.lang.Object)">Multimap</A></CODE></B></DD>
610 <DD>Returns <code>true</code> if the multimap contains any values for the specified
611 key.
613 <DD><DL>
614 <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>&lt;K,V&gt;</CODE></DL>
615 </DD>
616 <DD><DL>
617 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to search for in multimap</DL>
618 </DD>
619 </DL>
620 <HR>
622 <A NAME="containsValue(java.lang.Object)"><!-- --></A><H3>
623 containsValue</H3>
624 <PRE>
625 public boolean <B>containsValue</B>(<FONT SIZE="-1"><A HREF="../../../../com/google/common/base/Nullable.html" title="annotation in com.google.common.base">@Nullable</A></FONT>
626 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;value)</PRE>
627 <DL>
628 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#containsValue(java.lang.Object)">Multimap</A></CODE></B></DD>
629 <DD>Returns <code>true</code> if the multimap contains the specified value for any
630 key.
632 <DD><DL>
633 <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>&lt;K,V&gt;</CODE></DL>
634 </DD>
635 <DD><DL>
636 <DT><B>Parameters:</B><DD><CODE>value</CODE> - value to search for in multimap</DL>
637 </DD>
638 </DL>
639 <HR>
641 <A NAME="containsEntry(java.lang.Object, java.lang.Object)"><!-- --></A><H3>
642 containsEntry</H3>
643 <PRE>
644 public boolean <B>containsEntry</B>(<FONT SIZE="-1"><A HREF="../../../../com/google/common/base/Nullable.html" title="annotation in com.google.common.base">@Nullable</A></FONT>
645 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;key,
646 <FONT SIZE="-1"><A HREF="../../../../com/google/common/base/Nullable.html" title="annotation in com.google.common.base">@Nullable</A></FONT>
647 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;value)</PRE>
648 <DL>
649 <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>
650 <DD>Returns <code>true</code> if the multimap contains the specified key-value pair.
652 <DD><DL>
653 <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>&lt;K,V&gt;</CODE></DL>
654 </DD>
655 <DD><DL>
656 <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>
657 </DD>
658 </DL>
659 <HR>
661 <A NAME="remove(java.lang.Object, java.lang.Object)"><!-- --></A><H3>
662 remove</H3>
663 <PRE>
664 public boolean <B>remove</B>(<FONT SIZE="-1"><A HREF="../../../../com/google/common/base/Nullable.html" title="annotation in com.google.common.base">@Nullable</A></FONT>
665 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;key,
666 <FONT SIZE="-1"><A HREF="../../../../com/google/common/base/Nullable.html" title="annotation in com.google.common.base">@Nullable</A></FONT>
667 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;value)</PRE>
668 <DL>
669 <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>
670 <DD>Removes a key-value pair from the multimap.
672 <DD><DL>
673 <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>&lt;K,V&gt;</CODE></DL>
674 </DD>
675 <DD><DL>
676 <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
677 <DT><B>Returns:</B><DD><code>true</code> if the multimap changed</DL>
678 </DD>
679 </DL>
680 <HR>
682 <A NAME="putAll(java.lang.Object,java.lang.Iterable)"><!-- --></A><A NAME="putAll(K, java.lang.Iterable)"><!-- --></A><H3>
683 putAll</H3>
684 <PRE>
685 public boolean <B>putAll</B>(<FONT SIZE="-1"><A HREF="../../../../com/google/common/base/Nullable.html" title="annotation in com.google.common.base">@Nullable</A></FONT>
686 K&nbsp;key,
687 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html" title="class or interface in java.lang">Iterable</A>&lt;? extends V&gt;&nbsp;values)</PRE>
688 <DL>
689 <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>
690 <DD>Stores a collection of values with the same key.
692 <DD><DL>
693 <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>&lt;K,V&gt;</CODE></DL>
694 </DD>
695 <DD><DL>
696 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to store in the multimap<DD><CODE>values</CODE> - values to store in the multimap
697 <DT><B>Returns:</B><DD><code>true</code> if the multimap changed</DL>
698 </DD>
699 </DL>
700 <HR>
702 <A NAME="putAll(com.google.common.collect.Multimap)"><!-- --></A><H3>
703 putAll</H3>
704 <PRE>
705 public boolean <B>putAll</B>(<A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect">Multimap</A>&lt;? extends K,? extends V&gt;&nbsp;multimap)</PRE>
706 <DL>
707 <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>
708 <DD>Copies all of another multimap's key-value pairs into this multimap. The
709 order in which the mappings are added is determined by
710 <code>multimap.entries()</code>.
712 <DD><DL>
713 <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>&lt;K,V&gt;</CODE></DL>
714 </DD>
715 <DD><DL>
716 <DT><B>Parameters:</B><DD><CODE>multimap</CODE> - mappings to store in this multimap
717 <DT><B>Returns:</B><DD><code>true</code> if the multimap changed</DL>
718 </DD>
719 </DL>
720 <HR>
722 <A NAME="clear()"><!-- --></A><H3>
723 clear</H3>
724 <PRE>
725 public void <B>clear</B>()</PRE>
726 <DL>
727 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#clear()">Multimap</A></CODE></B></DD>
728 <DD>Removes all key-value pairs from the multimap.
730 <DD><DL>
731 <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>&lt;K,V&gt;</CODE></DL>
732 </DD>
733 <DD><DL>
734 </DL>
735 </DD>
736 </DL>
737 <HR>
739 <A NAME="keySet()"><!-- --></A><H3>
740 keySet</H3>
741 <PRE>
742 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html" title="class or interface in java.util">Set</A>&lt;K&gt; <B>keySet</B>()</PRE>
743 <DL>
744 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#keySet()">Multimap</A></CODE></B></DD>
745 <DD>Returns the set of all keys, each appearing once in the returned set.
746 Changes to the returned set will update the underlying multimap, and vice
747 versa.
749 <DD><DL>
750 <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>&lt;K,V&gt;</CODE></DL>
751 </DD>
752 <DD><DL>
754 <DT><B>Returns:</B><DD>the collection of distinct keys</DL>
755 </DD>
756 </DL>
757 <HR>
759 <A NAME="keys()"><!-- --></A><H3>
760 keys</H3>
761 <PRE>
762 public <A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;K&gt; <B>keys</B>()</PRE>
763 <DL>
764 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#keys()">Multimap</A></CODE></B></DD>
765 <DD>Returns a collection, which may contain duplicates, of all keys. The number
766 of times of key appears in the returned multiset equals the number of
767 mappings the key has in the multimap. Changes to the returned multiset will
768 update the underlying multimap, and vice versa.
770 <DD><DL>
771 <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>&lt;K,V&gt;</CODE></DL>
772 </DD>
773 <DD><DL>
775 <DT><B>Returns:</B><DD>a multiset with keys corresponding to the distinct keys of the
776 multimap and frequencies corresponding to the number of values that
777 each key maps to</DL>
778 </DD>
779 </DL>
780 <HR>
782 <A NAME="values()"><!-- --></A><H3>
783 values</H3>
784 <PRE>
785 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;V&gt; <B>values</B>()</PRE>
786 <DL>
787 <DD>Returns a collection of all values in the multimap. Changes to the returned
788 collection will update the underlying multimap, and vice versa.
790 <p>The iterator generated by the returned collection traverses the values
791 for one key, followed by the values of a second key, and so on.
793 <DD><DL>
794 <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>&lt;K,V&gt;</CODE></DL>
795 </DD>
796 <DD><DL>
798 <DT><B>Returns:</B><DD>collection of values, which may include the same value multiple
799 times if it occurs in multiple mappings</DL>
800 </DD>
801 </DL>
802 <HR>
804 <A NAME="asMap()"><!-- --></A><H3>
805 asMap</H3>
806 <PRE>
807 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&lt;K,<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;V&gt;&gt; <B>asMap</B>()</PRE>
808 <DL>
809 <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/google/common/collect/Multimap.html#asMap()">Multimap</A></CODE></B></DD>
810 <DD>Returns a map view that associates each key with the corresponding values
811 in the multimap. Changes to the returned map, such as element removal,
812 will update the underlying multimap. The map does not support
813 <code>setValue()</code> on its entries, <code>put</code>, or <code>putAll</code>.
815 <p>The collections returned by <code>asMap().get(Object)</code> have the same
816 behavior as those returned by <A HREF="../../../../com/google/common/collect/Multimap.html#get(K)"><CODE>Multimap.get(K)</CODE></A>.
818 <DD><DL>
819 <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>&lt;K,V&gt;</CODE></DL>
820 </DD>
821 <DD><DL>
823 <DT><B>Returns:</B><DD>a map view from a key to its collection of values</DL>
824 </DD>
825 </DL>
826 <HR>
828 <A NAME="hashCode()"><!-- --></A><H3>
829 hashCode</H3>
830 <PRE>
831 public int <B>hashCode</B>()</PRE>
832 <DL>
833 <DD>Returns the hash code for this multimap.
835 <p>The hash code of a multimap is defined as the hash code of the map view,
836 as returned by <A HREF="../../../../com/google/common/collect/Multimap.html#asMap()"><CODE>Multimap.asMap()</CODE></A>.
838 <DD><DL>
839 <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>&lt;K,V&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#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" title="class or interface in java.lang">Object</A></CODE></DL>
840 </DD>
841 <DD><DL>
843 <DT><B>Returns:</B><DD>a hash code value for this object.<DT><B>See Also:</B><DD><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html#hashCode()" title="class or interface in java.util"><CODE>Map.hashCode()</CODE></A></DL>
844 </DD>
845 </DL>
846 <HR>
848 <A NAME="toString()"><!-- --></A><H3>
849 toString</H3>
850 <PRE>
851 public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE>
852 <DL>
853 <DD>Returns a string representation of the multimap, generated by calling
854 <code>toString</code> on the map returned by <A HREF="../../../../com/google/common/collect/Multimap.html#asMap()"><CODE>Multimap.asMap()</CODE></A>.
856 <DD><DL>
857 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#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" title="class or interface in java.lang">Object</A></CODE></DL>
858 </DD>
859 <DD><DL>
861 <DT><B>Returns:</B><DD>a string representation of the multimap</DL>
862 </DD>
863 </DL>
864 <!-- ========= END OF CLASS DATA ========= -->
865 <HR>
868 <!-- ======= START OF BOTTOM NAVBAR ====== -->
869 <A NAME="navbar_bottom"><!-- --></A>
870 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
871 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
872 <TR>
873 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
874 <A NAME="navbar_bottom_firstrow"><!-- --></A>
875 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
876 <TR ALIGN="center" VALIGN="top">
877 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
878 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
879 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
880 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
881 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
882 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
883 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
884 </TR>
885 </TABLE>
886 </TD>
887 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
888 </EM>
889 </TD>
890 </TR>
892 <TR>
893 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
894 &nbsp;<A HREF="../../../../com/google/common/collect/HashBiMap.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A>&nbsp;
895 &nbsp;<A HREF="../../../../com/google/common/collect/HashMultiset.html" title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
896 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
897 <A HREF="../../../../index.html?com/google/common/collect/HashMultimap.html" target="_top"><B>FRAMES</B></A> &nbsp;
898 &nbsp;<A HREF="HashMultimap.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
899 &nbsp;<SCRIPT type="text/javascript">
900 <!--
901 if(window==top) {
902 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
904 //-->
905 </SCRIPT>
906 <NOSCRIPT>
907 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
908 </NOSCRIPT>
911 </FONT></TD>
912 </TR>
913 <TR>
914 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
915 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
916 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
917 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
918 </TR>
919 </TABLE>
920 <A NAME="skip-navbar_bottom"></A>
921 <!-- ======== END OF BOTTOM NAVBAR ======= -->
923 <HR>
925 </BODY>
926 </HTML>