Home | History | Annotate | Download | only in collect

Lines Matching full:multimap

7 Multimap (Guava Libraries 2010.01.04)
18 parent.document.title="Multimap (Guava Libraries 2010.01.04)";
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Multimap.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
61 <A HREF="../../../../index.html?com/google/common/collect/Multimap.html" target="_top"><B>FRAMES</B></A> &nbsp;
62 &nbsp;<A HREF="Multimap.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
93 Interface Multimap&lt;K,V&gt;</H2>
95 <DT><DT><B>Type Parameters:</B><DD><CODE>K</CODE> - the type of keys maintained by this multimap<DD><CODE>V</CODE> - the type of mapped values</DL>
104 <DT><PRE>public interface <B>Multimap&lt;K,V&gt;</B></DL>
109 values with a single key. If you call <A HREF="../../../../com/google/common/collect/Multimap.html#put(K, V)"><CODE>put(K, V)</CODE></A> twice, with the same key
110 but different values, the multimap contains mappings from the key to both
113 <p>The methods <A HREF="../../../../com/google/common/collect/Multimap.html#get(K)"><CODE>get(K)</CODE></A>, <A HREF="../../../../com/google/common/collect/Multimap.html#keySet()"><CODE>keySet()</CODE></A>, <A HREF="../../../../com/google/common/collect/Multimap.html#keys()"><CODE>keys()</CODE></A>, <A HREF="../../../../com/google/common/collect/Multimap.html#values()"><CODE>values()</CODE></A>,
114 <A HREF="../../../../com/google/common/collect/Multimap.html#entries()"><CODE>entries()</CODE></A>, and <A HREF="../../../../com/google/common/collect/Multimap.html#asMap()"><CODE>asMap()</CODE></A> return collections that are views of the
115 multimap. If the multimap is modifiable, updating it can change the contents
116 of those collections, and updating the collections will change the multimap.
117 In contrast, <A HREF="../../../../com/google/common/collect/Multimap.html#replaceValues(K, java.lang.Iterable)"><CODE>replaceValues(K, java.lang.Iterable<? extends V>)</CODE></A> and <A HREF="../../../../com/google/common/collect/Multimap.html#removeAll(java.lang.Object)"><CODE>removeAll(java.lang.Object)</CODE></A> return collections
118 that are independent of subsequent multimap changes.
120 <p>Depending on the implementation, a multimap may or may not allow duplicate
121 key-value pairs. In other words, the multimap contents after adding the same
123 duplicates, the multimap will contain two mappings, and <code>get</code> will
125 supporting duplicates, the multimap will contain a single mapping from the
129 <p>All methods that alter the multimap are optional, and the views returned
130 by the multimap may or may not be modifiable. When modification isn't
155 <CODE>&nbsp;<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>&lt;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">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>&lt;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;&gt;</CODE></FONT></TD>
156 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#asMap()">asMap</A></B>()</CODE>
160 in the multimap.</TD>
165 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#clear()">clear</A></B>()</CODE>
168 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes all key-value pairs from the multimap.</TD>
173 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.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>&nbsp;key,
177 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if the multimap contains the specified key-value pair.</TD>
182 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.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>&nbsp;key)</CODE>
185 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if the multimap contains any values for the specified
191 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.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>&nbsp;value)</CODE>
194 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if the multimap contains the specified value for any
199 <CODE>&nbsp;<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>&lt;<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>&lt;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>,<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;&gt;</CODE></FONT></TD>
200 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#entries()">entries</A></B>()</CODE>
208 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.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>&nbsp;obj)</CODE>
211 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compares the specified object with this multimap for equality.</TD>
215 <CODE>&nbsp;<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>&lt;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;</CODE></FONT></TD>
216 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#get(K)">get</A></B>(<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>&nbsp;key)</CODE>
224 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#hashCode()">hashCode</A></B>()</CODE>
227 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the hash code for this multimap.</TD>
232 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#isEmpty()">isEmpty</A></B>()</CODE>
235 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if the multimap contains no key-value pairs.</TD>
239 <CODE>&nbsp;<A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>&gt;</CODE></FONT></TD>
240 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#keys()">keys</A></B>()</CODE>
247 <CODE>&nbsp;<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>&lt;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>&gt;</CODE></FONT></TD>
248 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#keySet()">keySet</A></B>()</CODE>
256 <TD><CODE><B><A HREF="../../../../com/google/common/collect/MultimapMultimap.html" title="type parameter in Multimap">K</A>&nbsp;key,
257 <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&nbsp;value)</CODE>
260 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stores a key-value pair in the multimap.</TD>
265 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#putAll(K, java.lang.Iterable)">putAll</A></B>(<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>&nbsp;key,
266 <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>&lt;? extends <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;&nbsp;values)</CODE>
274 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.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 <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>,? extends <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;&nbsp;multimap)</CODE>
277 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Copies all of another multimap's key-value pairs into this multimap.</TD>
282 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.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>&nbsp;key,
286 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes a key-value pair from the multimap.</TD>
290 <CODE>&nbsp;<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>&lt;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;</CODE></FONT></TD>
291 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.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>&nbsp;key)</CODE>
298 <CODE>&nbsp;<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>&lt;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;</CODE></FONT></TD>
299 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#replaceValues(K, java.lang.Iterable)">replaceValues</A></B>(<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>&nbsp;key,
300 <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>&lt;? extends <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;&nbsp;values)</CODE>
309 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#size()">size</A></B>()</CODE>
312 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of key-value pairs in the multimap.</TD>
316 <CODE>&nbsp;<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>&lt;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;</CODE></FONT></TD>
317 <TD><CODE><B><A HREF="../../../../com/google/common/collect/Multimap.html#values()">values</A></B>()</CODE>
320 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a collection of all values in the multimap.</TD>
341 <DD>Returns the number of key-value pairs in the multimap.
354 <DD>Returns <code>true</code> if the multimap contains no key-value pairs.
368 <DD>Returns <code>true</code> if the multimap contains any values for the specified
372 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to search for in multimap</DL>
383 <DD>Returns <code>true</code> if the multimap contains the specified value for any
387 <DT><B>Parameters:</B><DD><CODE>value</CODE> - value to search for in multimap</DL>
400 <DD>Returns <code>true</code> if the multimap contains the specified key-value pair.
403 <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>
412 <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>&nbsp;key,
414 <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&nbsp;value)</PRE>
416 <DD>Stores a key-value pair in the multimap.
418 <p>Some multimap implementations allow duplicate key-value pairs, in which
420 multimap size by 1. Other implementations prohibit duplicates, and storing
421 a key-value pair that's already in the multimap has no effect.
424 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to store in the multimap<DD><CODE>value</CODE> - value to store in the multimap
425 <DT><B>Returns:</B><DD><code>true</code> if the method increased the size of the multimap, or
426 <code>false</code> if the multimap already contained the key-value pair and
440 <DD>Removes a key-value pair from the multimap.
443 <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
444 <DT><B>Returns:</B><DD><code>true</code> if the multimap changed</DL>
453 <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>&nbsp;key,
454 <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>&lt;? extends <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;&nbsp;values)</PRE>
459 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to store in the multimap<DD><CODE>values</CODE> - values to store in the multimap
460 <DT><B>Returns:</B><DD><code>true</code> if the multimap changed</DL>
465 <A NAME="putAll(com.google.common.collect.Multimap)"><!-- --></A><H3>
468 boolean <B>putAll</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/Multimap.html" title="type parameter in Multimap">K</A>,? extends <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;&nbsp;multimap)</PRE>
470 <DD>Copies all of another multimap's key-value pairs into this multimap. The
472 <code>multimap.entries()</code>.
475 <DT><B>Parameters:</B><DD><CODE>multimap</CODE> - mappings to store in this multimap
476 <DT><B>Returns:</B><DD><code>true</code> if the multimap changed</DL>
484 <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>&lt;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt; <B>replaceValues</B>(<FONT SIZE="-1"><A HREF="http://jsr-305.googlecode.com/svn/trunk/javadoc/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</A></FONT>
485 <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>&nbsp;key,
486 <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>&lt;? extends <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;&nbsp;values)</PRE>
492 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to store in the multimap<DD><CODE>values</CODE> - values to store in the multimap
496 multimap.</DL>
504 <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>&lt;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt; <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>
510 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key of entries to remove from the multimap
514 multimap.</DL>
524 <DD>Removes all key-value pairs from the multimap.
535 Multimap.html" title="type parameter in Multimap">V</A>&gt; <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>
536 <A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>&nbsp;key)</PRE>
539 mappings in the multimap have the provided key, an empty collection is
542 <p>Changes to the returned collection will update the underlying multimap,
546 <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to search for in multimap
555 <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>&lt;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>&gt; <B>keySet</B>()</PRE>
558 Changes to the returned set will update the underlying multimap, and vice
571 <A HREF="../../../../com/google/common/collect/Multiset.html" title="interface in com.google.common.collect">Multiset</A>&lt;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>&gt; <B>keys</B>()</PRE>
575 mappings the key has in the multimap. Changes to the returned multiset will
576 update the underlying multimap, and vice versa.
581 multimap and frequencies corresponding to the number of values that
590 <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>&lt;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt; <B>values</B>()</PRE>
592 <DD>Returns a collection of all values in the multimap. Changes to the returned
593 collection will update the underlying multimap, and vice versa.
606 <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>&lt;<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>&lt;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">K</A>,<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;&gt; <B>entries</B>()</PRE>
609 collection will update the underlying multimap, and vice versa. The entries
622 <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>&lt;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">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>&lt;<A HREF="../../../../com/google/common/collect/Multimap.html" title="type parameter in Multimap">V</A>&gt;&gt; <B>asMap</B>()</PRE>
625 in the multimap. Changes to the returned map, such as element removal,
626 will update the underlying multimap. The map does not support
630 behavior as those returned by <A HREF="../../../../com/google/common/collect/Multimap.html#get(K)"><CODE>get(K)</CODE></A>.
645 <DD>Compares the specified object with this multimap for equality. Two
646 multimaps are equal when their map views, as returned by <A HREF="../../../../com/google/common/collect/Multimap.html#asMap()"><CODE>asMap()</CODE></A>,
656 <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>asMap()</CODE></A> views contain unequal
658 they both have empty <A HREF="../../../../com/google/common/collect/Multimap.html#asMap()"><CODE>asMap()</CODE></A> views.
674 <DD>Returns the hash code for this multimap.
676 <p>The hash code of a multimap is defined as the hash code of the map view,
677 as returned by <A HREF="../../../../com/google/common/collect/Multimap.html#asMap()"><CODE>asMap()</CODE></A>.
702 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Multimap.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
720 <A HREF="../../../../index.html?com/google/common/collect/Multimap.html" target="_top"><B>FRAMES</B></A> &nbsp;
721 &nbsp;<A HREF="Multimap.html" target="_top"><B>NO FRAMES</B></A> &nbsp;