• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0-google-internal) on Mon Jan 04 20:47:59 PST 2010 -->
6<TITLE>
7SortedSetMultimap (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">
15function windowTitle()
16{
17    if (location.href.indexOf('is-external=true') == -1) {
18        parent.document.title="SortedSetMultimap (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>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SortedSetMultimap.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</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&nbsp;<A HREF="../../../../com/google/common/collect/Sets.SetView.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../com/google/common/collect/TreeMultimap.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/SortedSetMultimap.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="SortedSetMultimap.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
63&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<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">
91com.google.common.collect</FONT>
92<BR>
93Interface SortedSetMultimap&lt;K,V&gt;</H2>
94<DL>
95<DT><B>All Superinterfaces:</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;</DD>
96</DL>
97<DL>
98<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="class in com.google.common.collect">TreeMultimap</A></DD>
99</DL>
100<HR>
101<DL>
102<DT><PRE>public interface <B>SortedSetMultimap&lt;K,V&gt;</B><DT>extends <A HREF="../../../../com/google/common/collect/SetMultimap.html" title="interface in com.google.common.collect">SetMultimap</A>&lt;K,V&gt;</DL>
103</PRE>
104
105<P>
106A <code>SetMultimap</code> whose set of values for a given key are kept sorted;
107 that is, they comprise a <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util"><CODE>SortedSet</CODE></A>. It cannot hold duplicate
108 key-value pairs; adding a key-value pair that's already in the multimap has
109 no effect. This interface does not specify the ordering of the multimap's
110 keys.
111
112 <p>The <A HREF="../../../../com/google/common/collect/SortedSetMultimap.html#get(K)"><CODE>get(K)</CODE></A>, <A HREF="../../../../com/google/common/collect/SortedSetMultimap.html#removeAll(java.lang.Object)"><CODE>removeAll(java.lang.Object)</CODE></A>, and <A HREF="../../../../com/google/common/collect/SortedSetMultimap.html#replaceValues(K, java.lang.Iterable)"><CODE>replaceValues(K, java.lang.Iterable<? extends V>)</CODE></A> methods
113 each return a <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util"><CODE>SortedSet</CODE></A> of values, while <A HREF="../../../../com/google/common/collect/Multimap.html#entries()"><CODE>Multimap.entries()</CODE></A>
114 returns a <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util"><CODE>Set</CODE></A> of map entries. Though the method signature doesn't say
115 so explicitly, the map returned by <A HREF="../../../../com/google/common/collect/SortedSetMultimap.html#asMap()"><CODE>asMap()</CODE></A> has <code>SortedSet</code>
116 values.
117<P>
118
119<P>
120<DL>
121<DT><B>Since:</B></DT>
122  <DD>2010.01.04 <b>stable</b> (imported from Google Collections Library)</DD>
123<DT><B>Author:</B></DT>
124  <DD>Jared Levy</DD>
125</DL>
126<HR>
127
128<P>
129
130<!-- ========== METHOD SUMMARY =========== -->
131
132<A NAME="method_summary"><!-- --></A>
133<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
134<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
135<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
136<B>Method Summary</B></FONT></TH>
137</TR>
138<TR BGCOLOR="white" CLASS="TableRowColor">
139<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
140<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/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">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/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">V</A>&gt;&gt;</CODE></FONT></TD>
141<TD><CODE><B><A HREF="../../../../com/google/common/collect/SortedSetMultimap.html#asMap()">asMap</A></B>()</CODE>
142
143<BR>
144&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a map view that associates each key with the corresponding values
145 in the multimap.</TD>
146</TR>
147<TR BGCOLOR="white" CLASS="TableRowColor">
148<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
149<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</A>&lt;<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">V</A>&gt;</CODE></FONT></TD>
150<TD><CODE><B><A HREF="../../../../com/google/common/collect/SortedSetMultimap.html#get(K)">get</A></B>(<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">K</A>&nbsp;key)</CODE>
151
152<BR>
153&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a collection view of all values associated with a key.</TD>
154</TR>
155<TR BGCOLOR="white" CLASS="TableRowColor">
156<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
157<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</A>&lt;<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">V</A>&gt;</CODE></FONT></TD>
158<TD><CODE><B><A HREF="../../../../com/google/common/collect/SortedSetMultimap.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>
159
160<BR>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes all values associated with a given key.</TD>
162</TR>
163<TR BGCOLOR="white" CLASS="TableRowColor">
164<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
165<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</A>&lt;<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">V</A>&gt;</CODE></FONT></TD>
166<TD><CODE><B><A HREF="../../../../com/google/common/collect/SortedSetMultimap.html#replaceValues(K, java.lang.Iterable)">replaceValues</A></B>(<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">K</A>&nbsp;key,
167              <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/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">V</A>&gt;&nbsp;values)</CODE>
168
169<BR>
170&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stores a collection of values with the same key, replacing any existing
171 values for that key.</TD>
172</TR>
173<TR BGCOLOR="white" CLASS="TableRowColor">
174<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
175<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A>&lt;? super <A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">V</A>&gt;</CODE></FONT></TD>
176<TD><CODE><B><A HREF="../../../../com/google/common/collect/SortedSetMultimap.html#valueComparator()">valueComparator</A></B>()</CODE>
177
178<BR>
179&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the comparator that orders the multimap values, with a <code>null</code>
180 indicating that natural ordering is used.</TD>
181</TR>
182</TABLE>
183&nbsp;<A NAME="methods_inherited_from_class_com.google.common.collect.SetMultimap"><!-- --></A>
184<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
185<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
186<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>
187</TR>
188<TR BGCOLOR="white" CLASS="TableRowColor">
189<TD><CODE><A HREF="../../../../com/google/common/collect/SetMultimap.html#entries()">entries</A>, <A HREF="../../../../com/google/common/collect/SetMultimap.html#equals(java.lang.Object)">equals</A></CODE></TD>
190</TR>
191</TABLE>
192&nbsp;<A NAME="methods_inherited_from_class_com.google.common.collect.Multimap"><!-- --></A>
193<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
194<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
195<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>
196</TR>
197<TR BGCOLOR="white" CLASS="TableRowColor">
198<TD><CODE><A HREF="../../../../com/google/common/collect/Multimap.html#clear()">clear</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#containsEntry(java.lang.Object, java.lang.Object)">containsEntry</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#containsKey(java.lang.Object)">containsKey</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#containsValue(java.lang.Object)">containsValue</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#hashCode()">hashCode</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#isEmpty()">isEmpty</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#keys()">keys</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#keySet()">keySet</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#put(K, V)">put</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#putAll(K, java.lang.Iterable)">putAll</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#putAll(com.google.common.collect.Multimap)">putAll</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#remove(java.lang.Object, java.lang.Object)">remove</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#size()">size</A>, <A HREF="../../../../com/google/common/collect/Multimap.html#values()">values</A></CODE></TD>
199</TR>
200</TABLE>
201&nbsp;
202<P>
203
204<!-- ============ METHOD DETAIL ========== -->
205
206<A NAME="method_detail"><!-- --></A>
207<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
208<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
209<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
210<B>Method Detail</B></FONT></TH>
211</TR>
212</TABLE>
213
214<A NAME="get(java.lang.Object)"><!-- --></A><A NAME="get(K)"><!-- --></A><H3>
215get</H3>
216<PRE>
217<A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</A>&lt;<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">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>
218                 <A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">K</A>&nbsp;key)</PRE>
219<DL>
220<DD>Returns a collection view of all values associated with a key. If no
221 mappings in the multimap have the provided key, an empty collection is
222 returned.
223
224 <p>Changes to the returned collection will update the underlying multimap,
225 and vice versa.
226
227 <p>Because a <code>SortedSetMultimap</code> has unique sorted values for a given
228 key, this method returns a <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util"><CODE>SortedSet</CODE></A>, instead of the
229 <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><CODE>Collection</CODE></A> specified in the <A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect"><CODE>Multimap</CODE></A> interface.
230<P>
231<DD><DL>
232<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;<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">K</A>,<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">V</A>&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;<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">K</A>,<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">V</A>&gt;</CODE></DL>
233</DD>
234<DD><DL>
235<DT><B>Parameters:</B><DD><CODE>key</CODE> - key to search for in multimap
236<DT><B>Returns:</B><DD>the collection of values that the key maps to</DL>
237</DD>
238</DL>
239<HR>
240
241<A NAME="removeAll(java.lang.Object)"><!-- --></A><H3>
242removeAll</H3>
243<PRE>
244<A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</A>&lt;<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">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>
245                       <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)</PRE>
246<DL>
247<DD>Removes all values associated with a given key.
248
249 <p>Because a <code>SortedSetMultimap</code> has unique sorted values for a given
250 key, this method returns a <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util"><CODE>SortedSet</CODE></A>, instead of the
251 <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><CODE>Collection</CODE></A> specified in the <A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect"><CODE>Multimap</CODE></A> interface.
252<P>
253<DD><DL>
254<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;<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">K</A>,<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">V</A>&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;<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">K</A>,<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">V</A>&gt;</CODE></DL>
255</DD>
256<DD><DL>
257<DT><B>Parameters:</B><DD><CODE>key</CODE> - key of entries to remove from the multimap
258<DT><B>Returns:</B><DD>the collection of removed values, or an empty collection if no
259     values were associated with the provided key. The collection
260     <i>may</i> be modifiable, but updating it will have no effect on the
261     multimap.</DL>
262</DD>
263</DL>
264<HR>
265
266<A NAME="replaceValues(java.lang.Object,java.lang.Iterable)"><!-- --></A><A NAME="replaceValues(K, java.lang.Iterable)"><!-- --></A><H3>
267replaceValues</H3>
268<PRE>
269<A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</A>&lt;<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">V</A>&gt; <B>replaceValues</B>(<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">K</A>&nbsp;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>&lt;? extends <A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">V</A>&gt;&nbsp;values)</PRE>
271<DL>
272<DD>Stores a collection of values with the same key, replacing any existing
273 values for that key.
274
275 <p>Because a <code>SortedSetMultimap</code> has unique sorted values for a given
276 key, this method returns a <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util"><CODE>SortedSet</CODE></A>, instead of the
277 <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><CODE>Collection</CODE></A> specified in the <A HREF="../../../../com/google/common/collect/Multimap.html" title="interface in com.google.common.collect"><CODE>Multimap</CODE></A> interface.
278
279 <p>Any duplicates in <code>values</code> will be stored in the multimap once.
280<P>
281<DD><DL>
282<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;<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">K</A>,<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">V</A>&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;<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">K</A>,<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">V</A>&gt;</CODE></DL>
283</DD>
284<DD><DL>
285<DT><B>Parameters:</B><DD><CODE>key</CODE> - key to store in the multimap<DD><CODE>values</CODE> - values to store in the multimap
286<DT><B>Returns:</B><DD>the collection of replaced values, or an empty collection if no
287     values were previously associated with the key. The collection
288     <i>may</i> be modifiable, but updating it will have no effect on the
289     multimap.</DL>
290</DD>
291</DL>
292<HR>
293
294<A NAME="asMap()"><!-- --></A><H3>
295asMap</H3>
296<PRE>
297<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/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">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/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">V</A>&gt;&gt; <B>asMap</B>()</PRE>
298<DL>
299<DD>Returns a map view that associates each key with the corresponding values
300 in the multimap. Changes to the returned map, such as element removal,
301 will update the underlying multimap. The map never supports
302 <code>setValue()</code> on the map entries, <code>put</code>, or <code>putAll</code>.
303
304 <p>The collections returned by <code>asMap().get(Object)</code> have the same
305 behavior as those returned by <A HREF="../../../../com/google/common/collect/SortedSetMultimap.html#get(K)"><CODE>get(K)</CODE></A>.
306
307 <p>Though the method signature doesn't say so explicitly, the returned map
308 has <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util"><CODE>SortedSet</CODE></A> values.
309<P>
310<DD><DL>
311<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;<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">K</A>,<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">V</A>&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/SetMultimap.html#asMap()">asMap</A></CODE> in interface <CODE><A HREF="../../../../com/google/common/collect/SetMultimap.html" title="interface in com.google.common.collect">SetMultimap</A>&lt;<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">K</A>,<A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">V</A>&gt;</CODE></DL>
312</DD>
313<DD><DL>
314
315<DT><B>Returns:</B><DD>a map view from a key to its collection of values</DL>
316</DD>
317</DL>
318<HR>
319
320<A NAME="valueComparator()"><!-- --></A><H3>
321valueComparator</H3>
322<PRE>
323<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A>&lt;? super <A HREF="../../../../com/google/common/collect/SortedSetMultimap.html" title="type parameter in SortedSetMultimap">V</A>&gt; <B>valueComparator</B>()</PRE>
324<DL>
325<DD>Returns the comparator that orders the multimap values, with a <code>null</code>
326 indicating that natural ordering is used.
327<P>
328<DD><DL>
329</DL>
330</DD>
331<DD><DL>
332</DL>
333</DD>
334</DL>
335<!-- ========= END OF CLASS DATA ========= -->
336<HR>
337
338
339<!-- ======= START OF BOTTOM NAVBAR ====== -->
340<A NAME="navbar_bottom"><!-- --></A>
341<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
342<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
343<TR>
344<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
345<A NAME="navbar_bottom_firstrow"><!-- --></A>
346<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
347  <TR ALIGN="center" VALIGN="top">
348  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
349  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
350  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
351  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SortedSetMultimap.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
352  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
353  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
354  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
355  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
356  </TR>
357</TABLE>
358</TD>
359<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
360</EM>
361</TD>
362</TR>
363
364<TR>
365<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
366&nbsp;<A HREF="../../../../com/google/common/collect/Sets.SetView.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A>&nbsp;
367&nbsp;<A HREF="../../../../com/google/common/collect/TreeMultimap.html" title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
368<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
369  <A HREF="../../../../index.html?com/google/common/collect/SortedSetMultimap.html" target="_top"><B>FRAMES</B></A>  &nbsp;
370&nbsp;<A HREF="SortedSetMultimap.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
371&nbsp;<SCRIPT type="text/javascript">
372  <!--
373  if(window==top) {
374    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
375  }
376  //-->
377</SCRIPT>
378<NOSCRIPT>
379  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
380</NOSCRIPT>
381
382
383</FONT></TD>
384</TR>
385<TR>
386<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
387  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
388<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
389DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
390</TR>
391</TABLE>
392<A NAME="skip-navbar_bottom"></A>
393<!-- ======== END OF BOTTOM NAVBAR ======= -->
394
395<HR>
396
397</BODY>
398</HTML>
399