• 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:58 PST 2010 -->
6<TITLE>
7ImmutableSortedMap (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="ImmutableSortedMap (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/ImmutableSortedMap.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/ImmutableSetMultimap.Builder.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.Builder.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/ImmutableSortedMap.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="ImmutableSortedMap.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;<A HREF="#nested_class_summary">NESTED</A>&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>
93Class ImmutableSortedMap&lt;K,V&gt;</H2>
94<PRE>
95<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
96  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../com/google/common/collect/ImmutableMap.html" title="class in com.google.common.collect">com.google.common.collect.ImmutableMap</A>&lt;K,V&gt;
97      <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.google.common.collect.ImmutableSortedMap&lt;K,V&gt;</B>
98</PRE>
99<DL>
100<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A>, <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;K,V&gt;, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</A>&lt;K,V&gt;</DD>
101</DL>
102<HR>
103<DL>
104<DT><PRE>public class <B>ImmutableSortedMap&lt;K,V&gt;</B><DT>extends <A HREF="../../../../com/google/common/collect/ImmutableMap.html" title="class in com.google.common.collect">ImmutableMap</A>&lt;K,V&gt;<DT>implements <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</A>&lt;K,V&gt;</DL>
105</PRE>
106
107<P>
108An immutable <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util"><CODE>SortedMap</CODE></A>. Does not permit null keys or values.
109
110 <p>Unlike <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collections.html?is-external=true#unmodifiableSortedMap(java.util.SortedMap)" title="class or interface in java.util"><CODE>Collections.unmodifiableSortedMap(java.util.SortedMap<K, ? extends V>)</CODE></A>, which is a <i>view</i>
111 of a separate map which can still change, an instance of <code>ImmutableSortedMap</code> contains its own data and will <i>never</i> change.
112 <code>ImmutableSortedMap</code> is convenient for <code>public static final</code> maps
113 ("constant maps") and also lets you easily make a "defensive copy" of a map
114 provided to your class by a caller.
115
116 <p><b>Note</b>: Although this class is not final, it cannot be subclassed as
117 it has no public or protected constructors. Thus, instances of this class are
118 guaranteed to be immutable.
119<P>
120
121<P>
122<DL>
123<DT><B>Since:</B></DT>
124  <DD>2010.01.04 <b>stable</b> (imported from Google Collections Library)</DD>
125<DT><B>Author:</B></DT>
126  <DD>Jared Levy</DD>
127<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#com.google.common.collect.ImmutableSortedMap">Serialized Form</A></DL>
128<HR>
129
130<P>
131<!-- ======== NESTED CLASS SUMMARY ======== -->
132
133<A NAME="nested_class_summary"><!-- --></A>
134<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
135<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
136<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
137<B>Nested Class Summary</B></FONT></TH>
138</TR>
139<TR BGCOLOR="white" CLASS="TableRowColor">
140<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
141<CODE>static&nbsp;class</CODE></FONT></TD>
142<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.Builder.html" title="class in com.google.common.collect">ImmutableSortedMap.Builder</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.Builder.html" title="type parameter in ImmutableSortedMap.Builder">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.Builder.html" title="type parameter in ImmutableSortedMap.Builder">V</A>&gt;</B></CODE>
143
144<BR>
145&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A builder for creating immutable sorted map instances, especially <code>public static final</code> maps ("constant maps").</TD>
146</TR>
147</TABLE>
148&nbsp;<A NAME="nested_classes_inherited_from_class_java.util.Map"><!-- --></A>
149<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
150<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
151<TH ALIGN="left"><B>Nested classes/interfaces inherited from interface java.util.<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></B></TH>
152</TR>
153<TR BGCOLOR="white" CLASS="TableRowColor">
154<TD><CODE><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="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util">K</A>,<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util">V</A>&gt;</CODE></TD>
155</TR>
156</TABLE>
157&nbsp;
158
159<!-- ========== METHOD SUMMARY =========== -->
160
161<A NAME="method_summary"><!-- --></A>
162<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
163<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
164<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
165<B>Method Summary</B></FONT></TH>
166</TR>
167<TR BGCOLOR="white" CLASS="TableRowColor">
168<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
169<CODE>static
170<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
171<TR ALIGN="right" VALIGN="">
172<TD NOWRAP><FONT SIZE="-1">
173<CODE>&lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.Builder.html" title="class in com.google.common.collect">ImmutableSortedMap.Builder</A>&lt;K,V&gt;</CODE></FONT></TD>
174</TR>
175</TABLE>
176</CODE></FONT></TD>
177<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#builder()">builder</A></B>()</CODE>
178
179<BR>
180&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Use <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#naturalOrder()"><CODE>naturalOrder()</CODE></A>, which offers
181     better type-safety.</I></TD>
182</TR>
183<TR BGCOLOR="white" CLASS="TableRowColor">
184<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
185<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/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>&gt;</CODE></FONT></TD>
186<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#comparator()">comparator</A></B>()</CODE>
187
188<BR>
189&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the comparator that orders the keys, which is
190 <A HREF="../../../../com/google/common/collect/Ordering.html#natural()"><CODE>Ordering.natural()</CODE></A> when the natural ordering of the keys is used.</TD>
191</TR>
192<TR BGCOLOR="white" CLASS="TableRowColor">
193<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
194<CODE>&nbsp;boolean</CODE></FONT></TD>
195<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.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>
196
197<BR>
198&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
199</TR>
200<TR BGCOLOR="white" CLASS="TableRowColor">
201<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
202<CODE>static
203<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
204<TR ALIGN="right" VALIGN="">
205<TD NOWRAP><FONT SIZE="-1">
206<CODE>&lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;K,V&gt;</CODE></FONT></TD>
207</TR>
208</TABLE>
209</CODE></FONT></TD>
210<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#copyOf(java.util.Map)">copyOf</A></B>(<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;? extends K,? extends V&gt;&nbsp;map)</CODE>
211
212<BR>
213&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an immutable map containing the same entries as <code>map</code>, sorted
214 by the natural ordering of the keys.</TD>
215</TR>
216<TR BGCOLOR="white" CLASS="TableRowColor">
217<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
218<CODE>static
219<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
220<TR ALIGN="right" VALIGN="">
221<TD NOWRAP><FONT SIZE="-1">
222<CODE>&lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;K,V&gt;</CODE></FONT></TD>
223</TR>
224</TABLE>
225</CODE></FONT></TD>
226<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#copyOf(java.util.Map, java.util.Comparator)">copyOf</A></B>(<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;? extends K,? extends V&gt;&nbsp;map,
227       <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 K&gt;&nbsp;comparator)</CODE>
228
229<BR>
230&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an immutable map containing the same entries as <code>map</code>, with
231 keys sorted by the provided comparator.</TD>
232</TR>
233<TR BGCOLOR="white" CLASS="TableRowColor">
234<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
235<CODE>static
236<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
237<TR ALIGN="right" VALIGN="">
238<TD NOWRAP><FONT SIZE="-1">
239<CODE>&lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;K,V&gt;</CODE></FONT></TD>
240</TR>
241</TABLE>
242</CODE></FONT></TD>
243<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#copyOfSorted(java.util.SortedMap)">copyOfSorted</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</A>&lt;K,? extends V&gt;&nbsp;map)</CODE>
244
245<BR>
246&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an immutable map containing the same entries as the provided sorted
247 map, with the same ordering.</TD>
248</TR>
249<TR BGCOLOR="white" CLASS="TableRowColor">
250<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
251<CODE>&nbsp;<A HREF="../../../../com/google/common/collect/ImmutableSet.html" title="class in com.google.common.collect">ImmutableSet</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/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;&gt;</CODE></FONT></TD>
252<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#entrySet()">entrySet</A></B>()</CODE>
253
254<BR>
255&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an immutable set of the mappings in this map, sorted by the key
256 ordering.</TD>
257</TR>
258<TR BGCOLOR="white" CLASS="TableRowColor">
259<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
260<CODE>&nbsp;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A></CODE></FONT></TD>
261<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#firstKey()">firstKey</A></B>()</CODE>
262
263<BR>
264&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
265</TR>
266<TR BGCOLOR="white" CLASS="TableRowColor">
267<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
268<CODE>&nbsp;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A></CODE></FONT></TD>
269<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#get(java.lang.Object)">get</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>
270
271<BR>
272&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
273</TR>
274<TR BGCOLOR="white" CLASS="TableRowColor">
275<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
276<CODE>&nbsp;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE></FONT></TD>
277<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#headMap(K)">headMap</A></B>(<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>&nbsp;toKey)</CODE>
278
279<BR>
280&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method returns a <code>ImmutableSortedMap</code>, consisting of the entries
281 whose keys are less than <code>toKey</code>.</TD>
282</TR>
283<TR BGCOLOR="white" CLASS="TableRowColor">
284<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
285<CODE>&nbsp;<A HREF="../../../../com/google/common/collect/ImmutableSortedSet.html" title="class in com.google.common.collect">ImmutableSortedSet</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>&gt;</CODE></FONT></TD>
286<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#keySet()">keySet</A></B>()</CODE>
287
288<BR>
289&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an immutable sorted set of the keys in this map.</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="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A></CODE></FONT></TD>
294<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#lastKey()">lastKey</A></B>()</CODE>
295
296<BR>
297&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
298</TR>
299<TR BGCOLOR="white" CLASS="TableRowColor">
300<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
301<CODE>static
302<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
303<TR ALIGN="right" VALIGN="">
304<TD NOWRAP><FONT SIZE="-1">
305<CODE>&lt;K extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>&lt;K&gt;,V&gt;
306<BR>
307<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.Builder.html" title="class in com.google.common.collect">ImmutableSortedMap.Builder</A>&lt;K,V&gt;</CODE></FONT></TD>
308</TR>
309</TABLE>
310</CODE></FONT></TD>
311<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#naturalOrder()">naturalOrder</A></B>()</CODE>
312
313<BR>
314&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a builder that creates immutable sorted maps whose keys are
315 ordered by their natural ordering.</TD>
316</TR>
317<TR BGCOLOR="white" CLASS="TableRowColor">
318<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
319<CODE>static
320<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
321<TR ALIGN="right" VALIGN="">
322<TD NOWRAP><FONT SIZE="-1">
323<CODE>&lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;K,V&gt;</CODE></FONT></TD>
324</TR>
325</TABLE>
326</CODE></FONT></TD>
327<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#of()">of</A></B>()</CODE>
328
329<BR>
330&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the empty sorted map.</TD>
331</TR>
332<TR BGCOLOR="white" CLASS="TableRowColor">
333<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
334<CODE>static
335<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
336<TR ALIGN="right" VALIGN="">
337<TD NOWRAP><FONT SIZE="-1">
338<CODE>&lt;K extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>&lt;? super K&gt;,V&gt;
339<BR>
340<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;K,V&gt;</CODE></FONT></TD>
341</TR>
342</TABLE>
343</CODE></FONT></TD>
344<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#of(K, V)">of</A></B>(K&nbsp;k1,
345   V&nbsp;v1)</CODE>
346
347<BR>
348&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an immutable map containing a single entry.</TD>
349</TR>
350<TR BGCOLOR="white" CLASS="TableRowColor">
351<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
352<CODE>static
353<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
354<TR ALIGN="right" VALIGN="">
355<TD NOWRAP><FONT SIZE="-1">
356<CODE>&lt;K extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>&lt;? super K&gt;,V&gt;
357<BR>
358<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;K,V&gt;</CODE></FONT></TD>
359</TR>
360</TABLE>
361</CODE></FONT></TD>
362<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#of(K, V, K, V)">of</A></B>(K&nbsp;k1,
363   V&nbsp;v1,
364   K&nbsp;k2,
365   V&nbsp;v2)</CODE>
366
367<BR>
368&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an immutable sorted map containing the given entries, sorted by the
369 natural ordering of their keys.</TD>
370</TR>
371<TR BGCOLOR="white" CLASS="TableRowColor">
372<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
373<CODE>static
374<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
375<TR ALIGN="right" VALIGN="">
376<TD NOWRAP><FONT SIZE="-1">
377<CODE>&lt;K extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>&lt;? super K&gt;,V&gt;
378<BR>
379<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;K,V&gt;</CODE></FONT></TD>
380</TR>
381</TABLE>
382</CODE></FONT></TD>
383<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#of(K, V, K, V, K, V)">of</A></B>(K&nbsp;k1,
384   V&nbsp;v1,
385   K&nbsp;k2,
386   V&nbsp;v2,
387   K&nbsp;k3,
388   V&nbsp;v3)</CODE>
389
390<BR>
391&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an immutable sorted map containing the given entries, sorted by the
392 natural ordering of their keys.</TD>
393</TR>
394<TR BGCOLOR="white" CLASS="TableRowColor">
395<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
396<CODE>static
397<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
398<TR ALIGN="right" VALIGN="">
399<TD NOWRAP><FONT SIZE="-1">
400<CODE>&lt;K extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>&lt;? super K&gt;,V&gt;
401<BR>
402<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;K,V&gt;</CODE></FONT></TD>
403</TR>
404</TABLE>
405</CODE></FONT></TD>
406<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#of(K, V, K, V, K, V, K, V)">of</A></B>(K&nbsp;k1,
407   V&nbsp;v1,
408   K&nbsp;k2,
409   V&nbsp;v2,
410   K&nbsp;k3,
411   V&nbsp;v3,
412   K&nbsp;k4,
413   V&nbsp;v4)</CODE>
414
415<BR>
416&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an immutable sorted map containing the given entries, sorted by the
417 natural ordering of their keys.</TD>
418</TR>
419<TR BGCOLOR="white" CLASS="TableRowColor">
420<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
421<CODE>static
422<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
423<TR ALIGN="right" VALIGN="">
424<TD NOWRAP><FONT SIZE="-1">
425<CODE>&lt;K extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>&lt;? super K&gt;,V&gt;
426<BR>
427<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;K,V&gt;</CODE></FONT></TD>
428</TR>
429</TABLE>
430</CODE></FONT></TD>
431<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#of(K, V, K, V, K, V, K, V, K, V)">of</A></B>(K&nbsp;k1,
432   V&nbsp;v1,
433   K&nbsp;k2,
434   V&nbsp;v2,
435   K&nbsp;k3,
436   V&nbsp;v3,
437   K&nbsp;k4,
438   V&nbsp;v4,
439   K&nbsp;k5,
440   V&nbsp;v5)</CODE>
441
442<BR>
443&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an immutable sorted map containing the given entries, sorted by the
444 natural ordering of their keys.</TD>
445</TR>
446<TR BGCOLOR="white" CLASS="TableRowColor">
447<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
448<CODE>static
449<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
450<TR ALIGN="right" VALIGN="">
451<TD NOWRAP><FONT SIZE="-1">
452<CODE>&lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.Builder.html" title="class in com.google.common.collect">ImmutableSortedMap.Builder</A>&lt;K,V&gt;</CODE></FONT></TD>
453</TR>
454</TABLE>
455</CODE></FONT></TD>
456<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#orderedBy(java.util.Comparator)">orderedBy</A></B>(<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;K&gt;&nbsp;comparator)</CODE>
457
458<BR>
459&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a builder that creates immutable sorted maps with an explicit
460 comparator.</TD>
461</TR>
462<TR BGCOLOR="white" CLASS="TableRowColor">
463<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
464<CODE>static
465<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
466<TR ALIGN="right" VALIGN="">
467<TD NOWRAP><FONT SIZE="-1">
468<CODE>&lt;K extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>&lt;K&gt;,V&gt;
469<BR>
470<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.Builder.html" title="class in com.google.common.collect">ImmutableSortedMap.Builder</A>&lt;K,V&gt;</CODE></FONT></TD>
471</TR>
472</TABLE>
473</CODE></FONT></TD>
474<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#reverseOrder()">reverseOrder</A></B>()</CODE>
475
476<BR>
477&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a builder that creates immutable sorted maps whose keys are
478 ordered by the reverse of their natural ordering.</TD>
479</TR>
480<TR BGCOLOR="white" CLASS="TableRowColor">
481<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
482<CODE>&nbsp;int</CODE></FONT></TD>
483<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#size()">size</A></B>()</CODE>
484
485<BR>
486&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
487</TR>
488<TR BGCOLOR="white" CLASS="TableRowColor">
489<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
490<CODE>&nbsp;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE></FONT></TD>
491<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#subMap(K, K)">subMap</A></B>(<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>&nbsp;fromKey,
492       <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>&nbsp;toKey)</CODE>
493
494<BR>
495&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method returns a <code>ImmutableSortedMap</code>, consisting of the entries
496 whose keys ranges from <code>fromKey</code>, inclusive, to <code>toKey</code>,
497 exclusive.</TD>
498</TR>
499<TR BGCOLOR="white" CLASS="TableRowColor">
500<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
501<CODE>&nbsp;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE></FONT></TD>
502<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#tailMap(K)">tailMap</A></B>(<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>&nbsp;fromKey)</CODE>
503
504<BR>
505&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method returns a <code>ImmutableSortedMap</code>, consisting of the entries
506 whose keys are greater than or equals to <code>fromKey</code>.</TD>
507</TR>
508<TR BGCOLOR="white" CLASS="TableRowColor">
509<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
510<CODE>&nbsp;<A HREF="../../../../com/google/common/collect/ImmutableCollection.html" title="class in com.google.common.collect">ImmutableCollection</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE></FONT></TD>
511<TD><CODE><B><A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#values()">values</A></B>()</CODE>
512
513<BR>
514&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an immutable collection of the values in this map, sorted by the
515 ordering of the corresponding keys.</TD>
516</TR>
517</TABLE>
518&nbsp;<A NAME="methods_inherited_from_class_com.google.common.collect.ImmutableMap"><!-- --></A>
519<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
520<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
521<TH ALIGN="left"><B>Methods inherited from class com.google.common.collect.<A HREF="../../../../com/google/common/collect/ImmutableMap.html" title="class in com.google.common.collect">ImmutableMap</A></B></TH>
522</TR>
523<TR BGCOLOR="white" CLASS="TableRowColor">
524<TD><CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html#clear()">clear</A>, <A HREF="../../../../com/google/common/collect/ImmutableMap.html#containsKey(java.lang.Object)">containsKey</A>, <A HREF="../../../../com/google/common/collect/ImmutableMap.html#equals(java.lang.Object)">equals</A>, <A HREF="../../../../com/google/common/collect/ImmutableMap.html#hashCode()">hashCode</A>, <A HREF="../../../../com/google/common/collect/ImmutableMap.html#isEmpty()">isEmpty</A>, <A HREF="../../../../com/google/common/collect/ImmutableMap.html#put(K, V)">put</A>, <A HREF="../../../../com/google/common/collect/ImmutableMap.html#putAll(java.util.Map)">putAll</A>, <A HREF="../../../../com/google/common/collect/ImmutableMap.html#remove(java.lang.Object)">remove</A>, <A HREF="../../../../com/google/common/collect/ImmutableMap.html#toString()">toString</A></CODE></TD>
525</TR>
526</TABLE>
527&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
528<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
529<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
530<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
531</TR>
532<TR BGCOLOR="white" CLASS="TableRowColor">
533<TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
534</TR>
535</TABLE>
536&nbsp;<A NAME="methods_inherited_from_class_java.util.Map"><!-- --></A>
537<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
538<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
539<TH ALIGN="left"><B>Methods inherited from interface java.util.<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></B></TH>
540</TR>
541<TR BGCOLOR="white" CLASS="TableRowColor">
542<TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#clear()" title="class or interface in java.util">clear</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#containsKey(java.lang.Object)" title="class or interface in java.util">containsKey</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.util">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#hashCode()" title="class or interface in java.util">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#isEmpty()" title="class or interface in java.util">isEmpty</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#put(K, V)" title="class or interface in java.util">put</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#putAll(java.util.Map)" title="class or interface in java.util">putAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#remove(java.lang.Object)" title="class or interface in java.util">remove</A></CODE></TD>
543</TR>
544</TABLE>
545&nbsp;
546<P>
547
548<!-- ============ METHOD DETAIL ========== -->
549
550<A NAME="method_detail"><!-- --></A>
551<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
552<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
553<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
554<B>Method Detail</B></FONT></TH>
555</TR>
556</TABLE>
557
558<A NAME="of()"><!-- --></A><H3>
559of</H3>
560<PRE>
561public static &lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;K,V&gt; <B>of</B>()</PRE>
562<DL>
563<DD>Returns the empty sorted map.
564<P>
565<DD><DL>
566</DL>
567</DD>
568<DD><DL>
569</DL>
570</DD>
571</DL>
572<HR>
573
574<A NAME="of(java.lang.Comparable,java.lang.Object)"><!-- --></A><A NAME="of(K, V)"><!-- --></A><H3>
575of</H3>
576<PRE>
577public static &lt;K extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>&lt;? super K&gt;,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;K,V&gt; <B>of</B>(K&nbsp;k1,
578                                                                             V&nbsp;v1)</PRE>
579<DL>
580<DD>Returns an immutable map containing a single entry.
581<P>
582<DD><DL>
583</DL>
584</DD>
585<DD><DL>
586</DL>
587</DD>
588</DL>
589<HR>
590
591<A NAME="of(java.lang.Comparable,java.lang.Object,java.lang.Comparable,java.lang.Object)"><!-- --></A><A NAME="of(K, V, K, V)"><!-- --></A><H3>
592of</H3>
593<PRE>
594public static &lt;K extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>&lt;? super K&gt;,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;K,V&gt; <B>of</B>(K&nbsp;k1,
595                                                                             V&nbsp;v1,
596                                                                             K&nbsp;k2,
597                                                                             V&nbsp;v2)</PRE>
598<DL>
599<DD>Returns an immutable sorted map containing the given entries, sorted by the
600 natural ordering of their keys.
601<P>
602<DD><DL>
603</DL>
604</DD>
605<DD><DL>
606
607<DT><B>Throws:</B>
608<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the two keys are equal according to
609     their natural ordering</DL>
610</DD>
611</DL>
612<HR>
613
614<A NAME="of(java.lang.Comparable,java.lang.Object,java.lang.Comparable,java.lang.Object,java.lang.Comparable,java.lang.Object)"><!-- --></A><A NAME="of(K, V, K, V, K, V)"><!-- --></A><H3>
615of</H3>
616<PRE>
617public static &lt;K extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>&lt;? super K&gt;,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;K,V&gt; <B>of</B>(K&nbsp;k1,
618                                                                             V&nbsp;v1,
619                                                                             K&nbsp;k2,
620                                                                             V&nbsp;v2,
621                                                                             K&nbsp;k3,
622                                                                             V&nbsp;v3)</PRE>
623<DL>
624<DD>Returns an immutable sorted map containing the given entries, sorted by the
625 natural ordering of their keys.
626<P>
627<DD><DL>
628</DL>
629</DD>
630<DD><DL>
631
632<DT><B>Throws:</B>
633<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if any two keys are equal according to
634     their natural ordering</DL>
635</DD>
636</DL>
637<HR>
638
639<A NAME="of(java.lang.Comparable,java.lang.Object,java.lang.Comparable,java.lang.Object,java.lang.Comparable,java.lang.Object,java.lang.Comparable,java.lang.Object)"><!-- --></A><A NAME="of(K, V, K, V, K, V, K, V)"><!-- --></A><H3>
640of</H3>
641<PRE>
642public static &lt;K extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>&lt;? super K&gt;,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;K,V&gt; <B>of</B>(K&nbsp;k1,
643                                                                             V&nbsp;v1,
644                                                                             K&nbsp;k2,
645                                                                             V&nbsp;v2,
646                                                                             K&nbsp;k3,
647                                                                             V&nbsp;v3,
648                                                                             K&nbsp;k4,
649                                                                             V&nbsp;v4)</PRE>
650<DL>
651<DD>Returns an immutable sorted map containing the given entries, sorted by the
652 natural ordering of their keys.
653<P>
654<DD><DL>
655</DL>
656</DD>
657<DD><DL>
658
659<DT><B>Throws:</B>
660<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if any two keys are equal according to
661     their natural ordering</DL>
662</DD>
663</DL>
664<HR>
665
666<A NAME="of(java.lang.Comparable,java.lang.Object,java.lang.Comparable,java.lang.Object,java.lang.Comparable,java.lang.Object,java.lang.Comparable,java.lang.Object,java.lang.Comparable,java.lang.Object)"><!-- --></A><A NAME="of(K, V, K, V, K, V, K, V, K, V)"><!-- --></A><H3>
667of</H3>
668<PRE>
669public static &lt;K extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>&lt;? super K&gt;,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;K,V&gt; <B>of</B>(K&nbsp;k1,
670                                                                             V&nbsp;v1,
671                                                                             K&nbsp;k2,
672                                                                             V&nbsp;v2,
673                                                                             K&nbsp;k3,
674                                                                             V&nbsp;v3,
675                                                                             K&nbsp;k4,
676                                                                             V&nbsp;v4,
677                                                                             K&nbsp;k5,
678                                                                             V&nbsp;v5)</PRE>
679<DL>
680<DD>Returns an immutable sorted map containing the given entries, sorted by the
681 natural ordering of their keys.
682<P>
683<DD><DL>
684</DL>
685</DD>
686<DD><DL>
687
688<DT><B>Throws:</B>
689<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if any two keys are equal according to
690     their natural ordering</DL>
691</DD>
692</DL>
693<HR>
694
695<A NAME="copyOf(java.util.Map)"><!-- --></A><H3>
696copyOf</H3>
697<PRE>
698public static &lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;K,V&gt; <B>copyOf</B>(<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;? extends K,? extends V&gt;&nbsp;map)</PRE>
699<DL>
700<DD>Returns an immutable map containing the same entries as <code>map</code>, sorted
701 by the natural ordering of the keys.
702
703 <p><b>Note:</b> Despite what the method name suggests, if <code>map</code> is an
704 <code>ImmutableSortedMap</code>, it may be returned instead of a copy.
705
706 <p>This method is not type-safe, as it may be called on a map with keys
707 that are not mutually comparable.
708<P>
709<DD><DL>
710</DL>
711</DD>
712<DD><DL>
713
714<DT><B>Throws:</B>
715<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang">ClassCastException</A></CODE> - if the keys in <code>map</code> are not mutually
716     comparable
717<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if any key or value in <code>map</code> is null
718<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if any two keys are equal according to
719     their natural ordering</DL>
720</DD>
721</DL>
722<HR>
723
724<A NAME="copyOf(java.util.Map, java.util.Comparator)"><!-- --></A><H3>
725copyOf</H3>
726<PRE>
727public static &lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;K,V&gt; <B>copyOf</B>(<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;? extends K,? extends V&gt;&nbsp;map,
728                                                   <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 K&gt;&nbsp;comparator)</PRE>
729<DL>
730<DD>Returns an immutable map containing the same entries as <code>map</code>, with
731 keys sorted by the provided comparator.
732
733 <p><b>Note:</b> Despite what the method name suggests, if <code>map</code> is an
734 <code>ImmutableSortedMap</code>, it may be returned instead of a copy.
735<P>
736<DD><DL>
737</DL>
738</DD>
739<DD><DL>
740
741<DT><B>Throws:</B>
742<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if any key or value in <code>map</code> is null
743<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if any two keys are equal according to
744     the comparator</DL>
745</DD>
746</DL>
747<HR>
748
749<A NAME="copyOfSorted(java.util.SortedMap)"><!-- --></A><H3>
750copyOfSorted</H3>
751<PRE>
752public static &lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;K,V&gt; <B>copyOfSorted</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</A>&lt;K,? extends V&gt;&nbsp;map)</PRE>
753<DL>
754<DD>Returns an immutable map containing the same entries as the provided sorted
755 map, with the same ordering.
756
757 <p><b>Note:</b> Despite what the method name suggests, if <code>map</code> is an
758 <code>ImmutableSortedMap</code>, it may be returned instead of a copy.
759<P>
760<DD><DL>
761</DL>
762</DD>
763<DD><DL>
764
765<DT><B>Throws:</B>
766<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if any key or value in <code>map</code> is null</DL>
767</DD>
768</DL>
769<HR>
770
771<A NAME="naturalOrder()"><!-- --></A><H3>
772naturalOrder</H3>
773<PRE>
774public static &lt;K extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>&lt;K&gt;,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.Builder.html" title="class in com.google.common.collect">ImmutableSortedMap.Builder</A>&lt;K,V&gt; <B>naturalOrder</B>()</PRE>
775<DL>
776<DD>Returns a builder that creates immutable sorted maps whose keys are
777 ordered by their natural ordering. The sorted maps use <A HREF="../../../../com/google/common/collect/Ordering.html#natural()"><CODE>Ordering.natural()</CODE></A> as the comparator.
778
779 <p>Note: the type parameter <code>K</code> extends <code>Comparable&lt;K&gt;</code> rather
780 than <code>Comparable&lt;? super K&gt;</code> as a workaround for javac <a
781 href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6468354">bug
782 6468354</a>.
783<P>
784<DD><DL>
785</DL>
786</DD>
787<DD><DL>
788</DL>
789</DD>
790</DL>
791<HR>
792
793<A NAME="orderedBy(java.util.Comparator)"><!-- --></A><H3>
794orderedBy</H3>
795<PRE>
796public static &lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.Builder.html" title="class in com.google.common.collect">ImmutableSortedMap.Builder</A>&lt;K,V&gt; <B>orderedBy</B>(<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;K&gt;&nbsp;comparator)</PRE>
797<DL>
798<DD>Returns a builder that creates immutable sorted maps with an explicit
799 comparator. If the comparator has a more general type than the map's keys,
800 such as creating a <code>SortedMap&lt;Integer, String&gt;</code> with a <code>Comparator&lt;Number&gt;</code>, use the <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.Builder.html" title="class in com.google.common.collect"><CODE>ImmutableSortedMap.Builder</CODE></A> constructor instead.
801<P>
802<DD><DL>
803</DL>
804</DD>
805<DD><DL>
806
807<DT><B>Throws:</B>
808<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if <code>comparator</code> is null</DL>
809</DD>
810</DL>
811<HR>
812
813<A NAME="reverseOrder()"><!-- --></A><H3>
814reverseOrder</H3>
815<PRE>
816public static &lt;K extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>&lt;K&gt;,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.Builder.html" title="class in com.google.common.collect">ImmutableSortedMap.Builder</A>&lt;K,V&gt; <B>reverseOrder</B>()</PRE>
817<DL>
818<DD>Returns a builder that creates immutable sorted maps whose keys are
819 ordered by the reverse of their natural ordering.
820
821 <p>Note: the type parameter <code>K</code> extends <code>Comparable&lt;K&gt;</code> rather
822 than <code>Comparable&lt;? super K&gt;</code> as a workaround for javac <a
823 href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6468354">bug
824 6468354</a>.
825<P>
826<DD><DL>
827</DL>
828</DD>
829<DD><DL>
830</DL>
831</DD>
832</DL>
833<HR>
834
835<A NAME="size()"><!-- --></A><H3>
836size</H3>
837<PRE>
838public int <B>size</B>()</PRE>
839<DL>
840<DD><DL>
841<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#size()" title="class or interface in java.util">size</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE></DL>
842</DD>
843<DD><DL>
844</DL>
845</DD>
846</DL>
847<HR>
848
849<A NAME="get(java.lang.Object)"><!-- --></A><H3>
850get</H3>
851<PRE>
852public <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A> <B>get</B>(<FONT SIZE="-1"><A HREF="http://jsr-305.googlecode.com/svn/trunk/javadoc/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</A></FONT>
853             <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>
854<DL>
855<DD><DL>
856<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#get(java.lang.Object)" title="class or interface in java.util">get</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html#get(java.lang.Object)">get</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html" title="class in com.google.common.collect">ImmutableMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE></DL>
857</DD>
858<DD><DL>
859</DL>
860</DD>
861</DL>
862<HR>
863
864<A NAME="containsValue(java.lang.Object)"><!-- --></A><H3>
865containsValue</H3>
866<PRE>
867public boolean <B>containsValue</B>(<FONT SIZE="-1"><A HREF="http://jsr-305.googlecode.com/svn/trunk/javadoc/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</A></FONT>
868                             <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)</PRE>
869<DL>
870<DD><DL>
871<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#containsValue(java.lang.Object)" title="class or interface in java.util">containsValue</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html#containsValue(java.lang.Object)">containsValue</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html" title="class in com.google.common.collect">ImmutableMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE></DL>
872</DD>
873<DD><DL>
874</DL>
875</DD>
876</DL>
877<HR>
878
879<A NAME="entrySet()"><!-- --></A><H3>
880entrySet</H3>
881<PRE>
882public <A HREF="../../../../com/google/common/collect/ImmutableSet.html" title="class in com.google.common.collect">ImmutableSet</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/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;&gt; <B>entrySet</B>()</PRE>
883<DL>
884<DD>Returns an immutable set of the mappings in this map, sorted by the key
885 ordering.
886<P>
887<DD><DL>
888<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#entrySet()" title="class or interface in java.util">entrySet</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true#entrySet()" title="class or interface in java.util">entrySet</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html#entrySet()">entrySet</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html" title="class in com.google.common.collect">ImmutableMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE></DL>
889</DD>
890<DD><DL>
891</DL>
892</DD>
893</DL>
894<HR>
895
896<A NAME="keySet()"><!-- --></A><H3>
897keySet</H3>
898<PRE>
899public <A HREF="../../../../com/google/common/collect/ImmutableSortedSet.html" title="class in com.google.common.collect">ImmutableSortedSet</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>&gt; <B>keySet</B>()</PRE>
900<DL>
901<DD>Returns an immutable sorted set of the keys in this map.
902<P>
903<DD><DL>
904<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#keySet()" title="class or interface in java.util">keySet</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true#keySet()" title="class or interface in java.util">keySet</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html#keySet()">keySet</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html" title="class in com.google.common.collect">ImmutableMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE></DL>
905</DD>
906<DD><DL>
907</DL>
908</DD>
909</DL>
910<HR>
911
912<A NAME="values()"><!-- --></A><H3>
913values</H3>
914<PRE>
915public <A HREF="../../../../com/google/common/collect/ImmutableCollection.html" title="class in com.google.common.collect">ImmutableCollection</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt; <B>values</B>()</PRE>
916<DL>
917<DD>Returns an immutable collection of the values in this map, sorted by the
918 ordering of the corresponding keys.
919<P>
920<DD><DL>
921<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#values()" title="class or interface in java.util">values</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true#values()" title="class or interface in java.util">values</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html#values()">values</A></CODE> in class <CODE><A HREF="../../../../com/google/common/collect/ImmutableMap.html" title="class in com.google.common.collect">ImmutableMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE></DL>
922</DD>
923<DD><DL>
924</DL>
925</DD>
926</DL>
927<HR>
928
929<A NAME="comparator()"><!-- --></A><H3>
930comparator</H3>
931<PRE>
932public <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/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>&gt; <B>comparator</B>()</PRE>
933<DL>
934<DD>Returns the comparator that orders the keys, which is
935 <A HREF="../../../../com/google/common/collect/Ordering.html#natural()"><CODE>Ordering.natural()</CODE></A> when the natural ordering of the keys is used.
936 Note that its behavior is not consistent with <A HREF="http://java.sun.com/javase/6/docs/api/java/util/TreeMap.html?is-external=true#comparator()" title="class or interface in java.util"><CODE>TreeMap.comparator()</CODE></A>,
937 which returns <code>null</code> to indicate natural ordering.
938<P>
939<DD><DL>
940<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true#comparator()" title="class or interface in java.util">comparator</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE></DL>
941</DD>
942<DD><DL>
943</DL>
944</DD>
945</DL>
946<HR>
947
948<A NAME="firstKey()"><!-- --></A><H3>
949firstKey</H3>
950<PRE>
951public <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A> <B>firstKey</B>()</PRE>
952<DL>
953<DD><DL>
954<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true#firstKey()" title="class or interface in java.util">firstKey</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE></DL>
955</DD>
956<DD><DL>
957</DL>
958</DD>
959</DL>
960<HR>
961
962<A NAME="lastKey()"><!-- --></A><H3>
963lastKey</H3>
964<PRE>
965public <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A> <B>lastKey</B>()</PRE>
966<DL>
967<DD><DL>
968<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true#lastKey()" title="class or interface in java.util">lastKey</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE></DL>
969</DD>
970<DD><DL>
971</DL>
972</DD>
973</DL>
974<HR>
975
976<A NAME="headMap(java.lang.Object)"><!-- --></A><A NAME="headMap(K)"><!-- --></A><H3>
977headMap</H3>
978<PRE>
979public <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt; <B>headMap</B>(<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>&nbsp;toKey)</PRE>
980<DL>
981<DD>This method returns a <code>ImmutableSortedMap</code>, consisting of the entries
982 whose keys are less than <code>toKey</code>.
983
984 <p>The <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true#headMap(K)" title="class or interface in java.util"><CODE>SortedMap.headMap(K)</CODE></A> documentation states that a submap of a
985 submap throws an <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><CODE>IllegalArgumentException</CODE></A> if passed a <code>toKey</code>
986 greater than an earlier <code>toKey</code>. However, this method doesn't throw
987 an exception in that situation, but instead keeps the original <code>toKey</code>.
988<P>
989<DD><DL>
990<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true#headMap(K)" title="class or interface in java.util">headMap</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE></DL>
991</DD>
992<DD><DL>
993</DL>
994</DD>
995</DL>
996<HR>
997
998<A NAME="subMap(java.lang.Object,java.lang.Object)"><!-- --></A><A NAME="subMap(K, K)"><!-- --></A><H3>
999subMap</H3>
1000<PRE>
1001public <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt; <B>subMap</B>(<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>&nbsp;fromKey,
1002                                      <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>&nbsp;toKey)</PRE>
1003<DL>
1004<DD>This method returns a <code>ImmutableSortedMap</code>, consisting of the entries
1005 whose keys ranges from <code>fromKey</code>, inclusive, to <code>toKey</code>,
1006 exclusive.
1007
1008 <p>The <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true#subMap(K, K)" title="class or interface in java.util"><CODE>SortedMap.subMap(K, K)</CODE></A> documentation states that a submap of a
1009 submap throws an <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><CODE>IllegalArgumentException</CODE></A> if passed a <code>fromKey</code> less than an earlier <code>fromKey</code>. However, this method doesn't
1010 throw an exception in that situation, but instead keeps the original <code>fromKey</code>. Similarly, this method keeps the original <code>toKey</code>, instead
1011 of throwing an exception, if passed a <code>toKey</code> greater than an earlier
1012 <code>toKey</code>.
1013<P>
1014<DD><DL>
1015<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true#subMap(K, K)" title="class or interface in java.util">subMap</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE></DL>
1016</DD>
1017<DD><DL>
1018</DL>
1019</DD>
1020</DL>
1021<HR>
1022
1023<A NAME="tailMap(java.lang.Object)"><!-- --></A><A NAME="tailMap(K)"><!-- --></A><H3>
1024tailMap</H3>
1025<PRE>
1026public <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="class in com.google.common.collect">ImmutableSortedMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt; <B>tailMap</B>(<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>&nbsp;fromKey)</PRE>
1027<DL>
1028<DD>This method returns a <code>ImmutableSortedMap</code>, consisting of the entries
1029 whose keys are greater than or equals to <code>fromKey</code>.
1030
1031 <p>The <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true#tailMap(K)" title="class or interface in java.util"><CODE>SortedMap.tailMap(K)</CODE></A> documentation states that a submap of a
1032 submap throws an <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><CODE>IllegalArgumentException</CODE></A> if passed a <code>fromKey</code> less than an earlier <code>fromKey</code>. However, this method doesn't
1033 throw an exception in that situation, but instead keeps the original <code>fromKey</code>.
1034<P>
1035<DD><DL>
1036<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true#tailMap(K)" title="class or interface in java.util">tailMap</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</A>&lt;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">K</A>,<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html" title="type parameter in ImmutableSortedMap">V</A>&gt;</CODE></DL>
1037</DD>
1038<DD><DL>
1039</DL>
1040</DD>
1041</DL>
1042<HR>
1043
1044<A NAME="builder()"><!-- --></A><H3>
1045builder</H3>
1046<PRE>
1047<FONT SIZE="-1"><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A>
1048</FONT>public static &lt;K,V&gt; <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.Builder.html" title="class in com.google.common.collect">ImmutableSortedMap.Builder</A>&lt;K,V&gt; <B>builder</B>()</PRE>
1049<DL>
1050<DD><B>Deprecated.</B>&nbsp;<I>Use <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#naturalOrder()"><CODE>naturalOrder()</CODE></A>, which offers
1051     better type-safety.</I>
1052<P>
1053<DD>Not supported. Use <A HREF="../../../../com/google/common/collect/ImmutableSortedMap.html#naturalOrder()"><CODE>naturalOrder()</CODE></A>, which offers
1054 better type-safety, instead. This method exists only to hide
1055 <A HREF="../../../../com/google/common/collect/ImmutableMap.html#builder()"><CODE>ImmutableMap.builder()</CODE></A> from consumers of <code>ImmutableSortedMap</code>.
1056<P>
1057<DD><DL>
1058
1059<DT><B>Throws:</B>
1060<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - always</DL>
1061</DD>
1062</DL>
1063<!-- ========= END OF CLASS DATA ========= -->
1064<HR>
1065
1066
1067<!-- ======= START OF BOTTOM NAVBAR ====== -->
1068<A NAME="navbar_bottom"><!-- --></A>
1069<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
1070<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
1071<TR>
1072<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
1073<A NAME="navbar_bottom_firstrow"><!-- --></A>
1074<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
1075  <TR ALIGN="center" VALIGN="top">
1076  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
1077  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
1078  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
1079  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ImmutableSortedMap.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
1080  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
1081  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
1082  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
1083  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
1084  </TR>
1085</TABLE>
1086</TD>
1087<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1088</EM>
1089</TD>
1090</TR>
1091
1092<TR>
1093<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1094&nbsp;<A HREF="../../../../com/google/common/collect/ImmutableSetMultimap.Builder.html" title="class in com.google.common.collect"><B>PREV CLASS</B></A>&nbsp;
1095&nbsp;<A HREF="../../../../com/google/common/collect/ImmutableSortedMap.Builder.html" title="class in com.google.common.collect"><B>NEXT CLASS</B></A></FONT></TD>
1096<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1097  <A HREF="../../../../index.html?com/google/common/collect/ImmutableSortedMap.html" target="_top"><B>FRAMES</B></A>  &nbsp;
1098&nbsp;<A HREF="ImmutableSortedMap.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
1099&nbsp;<SCRIPT type="text/javascript">
1100  <!--
1101  if(window==top) {
1102    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
1103  }
1104  //-->
1105</SCRIPT>
1106<NOSCRIPT>
1107  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
1108</NOSCRIPT>
1109
1110
1111</FONT></TD>
1112</TR>
1113<TR>
1114<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1115  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
1116<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1117DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
1118</TR>
1119</TABLE>
1120<A NAME="skip-navbar_bottom"></A>
1121<!-- ======== END OF BOTTOM NAVBAR ======= -->
1122
1123<HR>
1124
1125</BODY>
1126</HTML>
1127