PageRenderTime 60ms CodeModel.GetById 24ms RepoModel.GetById 0ms app.codeStats 1ms

/jdk-7u76-docs-all/docs/api/java/util/TreeMap.html

https://gitlab.com/PNNutkung/Java-API
HTML | 1713 lines | 1591 code | 19 blank | 103 comment | 0 complexity | 3fe722f2ee217972186416b5c7f86534 MD5 | raw file

Large files files are truncated, but you can click here to view the full file

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <!-- NewPage -->
    3. 

  3. <html lang="en">
    4. 

  4. <head>
    5. 

  5. <!-- Generated by javadoc (version 1.6.0_18) on Thu Dec 18 17:17:19 PST 2014 -->
    6. 

  6. <title>TreeMap (Java Platform SE 7 )</title>
    7. 

  7. <meta name="date" content="2014-12-18">
    8. 

  8. <meta name="keywords" content="java.util.TreeMap class">
    9. 

  9. <meta name="keywords" content="size()">
    10. 

  10. <meta name="keywords" content="containsKey()">
    11. 

  11. <meta name="keywords" content="containsValue()">
    12. 

  12. <meta name="keywords" content="get()">
    13. 

  13. <meta name="keywords" content="comparator()">
    14. 

  14. <meta name="keywords" content="firstKey()">
    15. 

  15. <meta name="keywords" content="lastKey()">
    16. 

  16. <meta name="keywords" content="putAll()">
    17. 

  17. <meta name="keywords" content="put()">
    18. 

  18. <meta name="keywords" content="remove()">
    19. 

  19. <meta name="keywords" content="clear()">
    20. 

  20. <meta name="keywords" content="clone()">
    21. 

  21. <meta name="keywords" content="firstEntry()">
    22. 

  22. <meta name="keywords" content="lastEntry()">
    23. 

  23. <meta name="keywords" content="pollFirstEntry()">
    24. 

  24. <meta name="keywords" content="pollLastEntry()">
    25. 

  25. <meta name="keywords" content="lowerEntry()">
    26. 

  26. <meta name="keywords" content="lowerKey()">
    27. 

  27. <meta name="keywords" content="floorEntry()">
    28. 

  28. <meta name="keywords" content="floorKey()">
    29. 

  29. <meta name="keywords" content="ceilingEntry()">
    30. 

  30. <meta name="keywords" content="ceilingKey()">
    31. 

  31. <meta name="keywords" content="higherEntry()">
    32. 

  32. <meta name="keywords" content="higherKey()">
    33. 

  33. <meta name="keywords" content="keySet()">
    34. 

  34. <meta name="keywords" content="navigableKeySet()">
    35. 

  35. <meta name="keywords" content="descendingKeySet()">
    36. 

  36. <meta name="keywords" content="values()">
    37. 

  37. <meta name="keywords" content="entrySet()">
    38. 

  38. <meta name="keywords" content="descendingMap()">
    39. 

  39. <meta name="keywords" content="subMap()">
    40. 

  40. <meta name="keywords" content="headMap()">
    41. 

  41. <meta name="keywords" content="tailMap()">
    42. 

  42. <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
    43. 

  43. </head>
    44. 

  44. <body>
    45. 

  45. <script type="text/javascript"><!--
    46. 

  46.     if (location.href.indexOf('is-external=true') == -1) {
    47. 

  47.         parent.document.title="TreeMap (Java Platform SE 7 )";
    48. 

  48.     }
    49. 

  49. //-->
    50. 

  50. </script>
    51. 

  51. <noscript>
    52. 

  52. <div>JavaScript is disabled on your browser.</div>
    53. 

  53. </noscript>
    54. 

  54. <!-- ========= START OF TOP NAVBAR ======= -->
    55. 

  55. <div class="topNav"><a name="navbar_top">
    56. 

  56. <!--   -->
    57. 

  57. </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
    58. 

  58. <!--   -->
    59. 

  59. </a>
    60. 

  60. <ul class="navList" title="Navigation">
    61. 

  61. <li><a href="../../overview-summary.html">Overview</a></li>
    62. 

  62. <li><a href="package-summary.html">Package</a></li>
    63. 

  63. <li class="navBarCell1Rev">Class</li>
    64. 

  64. <li><a href="class-use/TreeMap.html">Use</a></li>
    65. 

  65. <li><a href="package-tree.html">Tree</a></li>
    66. 

  66. <li><a href="../../deprecated-list.html">Deprecated</a></li>
    67. 

  67. <li><a href="../../index-files/index-1.html">Index</a></li>
    68. 

  68. <li><a href="../../help-doc.html">Help</a></li>
    69. 

  69. </ul>
    70. 

  70. <div class="aboutLanguage"><em><strong>Java&trade;&nbsp;Platform<br>Standard&nbsp;Ed.&nbsp;7</strong></em></div>
    71. 

  71. </div>
    72. 

  72. <div class="subNav">
    73. 

  73. <ul class="navList">
    74. 

  74. <li><a href="../../java/util/TooManyListenersException.html" title="class in java.util"><span class="strong">Prev Class</span></a></li>
    75. 

  75. <li><a href="../../java/util/TreeSet.html" title="class in java.util"><span class="strong">Next Class</span></a></li>
    76. 

  76. </ul>
    77. 

  77. <ul class="navList">
    78. 

  78. <li><a href="../../index.html?java/util/TreeMap.html" target="_top">Frames</a></li>
    79. 

  79. <li><a href="TreeMap.html" target="_top">No Frames</a></li>
    80. 

  80. </ul>
    81. 

  81. <ul class="navList" id="allclasses_navbar_top">
    82. 

  82. <li><a href="../../allclasses-noframe.html">All Classes</a></li>
    83. 

  83. </ul>
    84. 

  84. <div>
    85. 

  85. <script type="text/javascript"><!--
    86. 

  86.   allClassesLink = document.getElementById("allclasses_navbar_top");
    87. 

  87.   if(window==top) {
    88. 

  88.     allClassesLink.style.display = "block";
    89. 

  89.   }
    90. 

  90.   else {
    91. 

  91.     allClassesLink.style.display = "none";
    92. 

  92.   }
    93. 

  93.   //-->
    94. 

  94. </script>
    95. 

  95. </div>
    96. 

  96. <div>
    97. 

  97. <ul class="subNavList">
    98. 

  98. <li>Summary:&nbsp;</li>
    99. 

  99. <li><a href="#nested_classes_inherited_from_class_java.util.AbstractMap">Nested</a>&nbsp;|&nbsp;</li>
    100. 

  100. <li>Field&nbsp;|&nbsp;</li>
    101. 

  101. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
    102. 

  102. <li><a href="#method_summary">Method</a></li>
    103. 

  103. </ul>
    104. 

  104. <ul class="subNavList">
    105. 

  105. <li>Detail:&nbsp;</li>
    106. 

  106. <li>Field&nbsp;|&nbsp;</li>
    107. 

  107. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
    108. 

  108. <li><a href="#method_detail">Method</a></li>
    109. 

  109. </ul>
    110. 

  110. </div>
    111. 

  111. <a name="skip-navbar_top">
    112. 

  112. <!--   -->
    113. 

  113. </a></div>
    114. 

  114. <!-- ========= END OF TOP NAVBAR ========= -->
    115. 

  115. <!-- ======== START OF CLASS DATA ======== -->
    116. 

  116. <div class="header">
    117. 

  117. <div class="subTitle">java.util</div>
    118. 

  118. <h2 title="Class TreeMap" class="title">Class TreeMap&lt;K,V&gt;</h2>
    119. 

  119. </div>
    120. 

  120. <div class="contentContainer">
    121. 

  121. <ul class="inheritance">
    122. 

  122. <li><a href="../../java/lang/Object.html" title="class in java.lang">java.lang.Object</a></li>
    123. 

  123. <li>
    124. 

  124. <ul class="inheritance">
    125. 

  125. <li><a href="../../java/util/AbstractMap.html" title="class in java.util">java.util.AbstractMap</a>&lt;K,V&gt;</li>
    126. 

  126. <li>
    127. 

  127. <ul class="inheritance">
    128. 

  128. <li>java.util.TreeMap&lt;K,V&gt;</li>
    129. 

  129. </ul>
    130. 

  130. </li>
    131. 

  131. </ul>
    132. 

  132. </li>
    133. 

  133. </ul>
    134. 

  134. <div class="description">
    135. 

  135. <ul class="blockList">
    136. 

  136. <li class="blockList">
    137. 

  137. <dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>K</code> - the type of keys maintained by this map</dd><dd><code>V</code> - the type of mapped values</dd></dl>
    138. 

  138. <dl>
    139. 

  139. <dt>All Implemented Interfaces:</dt>
    140. 

  140. <dd><a href="../../java/io/Serializable.html" title="interface in java.io">Serializable</a>, <a href="../../java/lang/Cloneable.html" title="interface in java.lang">Cloneable</a>, <a href="../../java/util/Map.html" title="interface in java.util">Map</a>&lt;K,V&gt;, <a href="../../java/util/NavigableMap.html" title="interface in java.util">NavigableMap</a>&lt;K,V&gt;, <a href="../../java/util/SortedMap.html" title="interface in java.util">SortedMap</a>&lt;K,V&gt;</dd>
    141. 

  141. </dl>
    142. 

  142. <hr>
    143. 

  143. <br>
    144. 

  144. <pre>public class <span class="strong">TreeMap&lt;K,V&gt;</span>
    145. 

  145. extends <a href="../../java/util/AbstractMap.html" title="class in java.util">AbstractMap</a>&lt;K,V&gt;
    146. 

  146. implements <a href="../../java/util/NavigableMap.html" title="interface in java.util">NavigableMap</a>&lt;K,V&gt;, <a href="../../java/lang/Cloneable.html" title="interface in java.lang">Cloneable</a>, <a href="../../java/io/Serializable.html" title="interface in java.io">Serializable</a></pre>
    147. 

  147. <div class="block">A Red-Black tree based <a href="../../java/util/NavigableMap.html" title="interface in java.util"><code>NavigableMap</code></a> implementation.
    148. 

  148.  The map is sorted according to the <a href="../../java/lang/Comparable.html" title="interface in java.lang">natural
    149. 

  149.  ordering</a> of its keys, or by a <a href="../../java/util/Comparator.html" title="interface in java.util"><code>Comparator</code></a> provided at map
    150. 

  150.  creation time, depending on which constructor is used.
    151. 

  151. 

  152.  <p>This implementation provides guaranteed log(n) time cost for the
    153. 

  153.  <code>containsKey</code>, <code>get</code>, <code>put</code> and <code>remove</code>
    154. 

  154.  operations.  Algorithms are adaptations of those in Cormen, Leiserson, and
    155. 

  155.  Rivest's <em>Introduction to Algorithms</em>.
    156. 

    157. 

  157.  <p>Note that the ordering maintained by a tree map, like any sorted map, and
    158. 

  158.  whether or not an explicit comparator is provided, must be <em>consistent
    159. 

  159.  with <code>equals</code></em> if this sorted map is to correctly implement the
    160. 

  160.  <code>Map</code> interface.  (See <code>Comparable</code> or <code>Comparator</code> for a
    161. 

  161.  precise definition of <em>consistent with equals</em>.)  This is so because
    162. 

  162.  the <code>Map</code> interface is defined in terms of the <code>equals</code>
    163. 

  163.  operation, but a sorted map performs all key comparisons using its <code>compareTo</code> (or <code>compare</code>) method, so two keys that are deemed equal by
    164. 

  164.  this method are, from the standpoint of the sorted map, equal.  The behavior
    165. 

  165.  of a sorted map <em>is</em> well-defined even if its ordering is
    166. 

  166.  inconsistent with <code>equals</code>; it just fails to obey the general contract
    167. 

  167.  of the <code>Map</code> interface.
    168. 

  168. 

  169.  <p><strong>Note that this implementation is not synchronized.</strong>
    170. 

  170.  If multiple threads access a map concurrently, and at least one of the
    171. 

  171.  threads modifies the map structurally, it <em>must</em> be synchronized
    172. 

  172.  externally.  (A structural modification is any operation that adds or
    173. 

  173.  deletes one or more mappings; merely changing the value associated
    174. 

  174.  with an existing key is not a structural modification.)  This is
    175. 

  175.  typically accomplished by synchronizing on some object that naturally
    176. 

  176.  encapsulates the map.
    177. 

  177.  If no such object exists, the map should be "wrapped" using the
    178. 

  178.  <a href="../../java/util/Collections.html#synchronizedSortedMap(java.util.SortedMap)"><code>Collections.synchronizedSortedMap</code></a>
    179. 

  179.  method.  This is best done at creation time, to prevent accidental
    180. 

  180.  unsynchronized access to the map: <pre>
    181. 

  181.    SortedMap m = Collections.synchronizedSortedMap(new TreeMap(...));</pre>
    182. 

  182. 

  183.  <p>The iterators returned by the <code>iterator</code> method of the collections
    184. 

  184.  returned by all of this class's "collection view methods" are
    185. 

  185.  <em>fail-fast</em>: if the map is structurally modified at any time after
    186. 

  186.  the iterator is created, in any way except through the iterator's own
    187. 

  187.  <code>remove</code> method, the iterator will throw a <a href="../../java/util/ConcurrentModificationException.html" title="class in java.util"><code>ConcurrentModificationException</code></a>.  Thus, in the face of concurrent
    188. 

  188.  modification, the iterator fails quickly and cleanly, rather than risking
    189. 

  189.  arbitrary, non-deterministic behavior at an undetermined time in the future.
    190. 

  190. 

  191.  <p>Note that the fail-fast behavior of an iterator cannot be guaranteed
    192. 

  192.  as it is, generally speaking, impossible to make any hard guarantees in the
    193. 

  193.  presence of unsynchronized concurrent modification.  Fail-fast iterators
    194. 

  194.  throw <code>ConcurrentModificationException</code> on a best-effort basis.
    195. 

  195.  Therefore, it would be wrong to write a program that depended on this
    196. 

  196.  exception for its correctness:   <em>the fail-fast behavior of iterators
    197. 

  197.  should be used only to detect bugs.</em>
    198. 

  198. 

  199.  <p>All <code>Map.Entry</code> pairs returned by methods in this class
    200. 

  200.  and its views represent snapshots of mappings at the time they were
    201. 

  201.  produced. They do <strong>not</strong> support the <code>Entry.setValue</code>
    202. 

  202.  method. (Note however that it is possible to change mappings in the
    203. 

  203.  associated map using <code>put</code>.)
    204. 

  204. 

  205.  <p>This class is a member of the
    206. 

  206.  <a href="../../../technotes/guides/collections/index.html">
    207. 

  207.  Java Collections Framework</a>.</div>
    208. 

  208. <dl><dt><span class="strong">Since:</span></dt>
    209. 

  209.   <dd>1.2</dd>
    210. 

  210. <dt><span class="strong">See Also:</span></dt><dd><a href="../../java/util/Map.html" title="interface in java.util"><code>Map</code></a>, 
    211. 

  211. <a href="../../java/util/HashMap.html" title="class in java.util"><code>HashMap</code></a>, 
    212. 

  212. <a href="../../java/util/Hashtable.html" title="class in java.util"><code>Hashtable</code></a>, 
    213. 

  213. <a href="../../java/lang/Comparable.html" title="interface in java.lang"><code>Comparable</code></a>, 
    214. 

  214. <a href="../../java/util/Comparator.html" title="interface in java.util"><code>Comparator</code></a>, 
    215. 

  215. <a href="../../java/util/Collection.html" title="interface in java.util"><code>Collection</code></a>, 
    216. 

  216. <a href="../../serialized-form.html#java.util.TreeMap">Serialized Form</a></dd></dl>
    217. 

  217. </li>
    218. 

  218. </ul>
    219. 

  219. </div>
    220. 

  220. <div class="summary">
    221. 

  221. <ul class="blockList">
    222. 

  222. <li class="blockList">
    223. 

  223. <!-- ======== NESTED CLASS SUMMARY ======== -->
    224. 

  224. <ul class="blockList">
    225. 

  225. <li class="blockList"><a name="nested_class_summary">
    226. 

  226. <!--   -->
    227. 

  227. </a>
    228. 

  228. <h3>Nested Class Summary</h3>
    229. 

  229. <ul class="blockList">
    230. 

  230. <li class="blockList"><a name="nested_classes_inherited_from_class_java.util.AbstractMap">
    231. 

  231. <!--   -->
    232. 

  232. </a>
    233. 

  233. <h3>Nested classes/interfaces inherited from class&nbsp;java.util.<a href="../../java/util/AbstractMap.html" title="class in java.util">AbstractMap</a></h3>
    234. 

  234. <code><a href="../../java/util/AbstractMap.SimpleEntry.html" title="class in java.util">AbstractMap.SimpleEntry</a>&lt;<a href="../../java/util/AbstractMap.SimpleEntry.html" title="type parameter in AbstractMap.SimpleEntry">K</a>,<a href="../../java/util/AbstractMap.SimpleEntry.html" title="type parameter in AbstractMap.SimpleEntry">V</a>&gt;, <a href="../../java/util/AbstractMap.SimpleImmutableEntry.html" title="class in java.util">AbstractMap.SimpleImmutableEntry</a>&lt;<a href="../../java/util/AbstractMap.SimpleImmutableEntry.html" title="type parameter in AbstractMap.SimpleImmutableEntry">K</a>,<a href="../../java/util/AbstractMap.SimpleImmutableEntry.html" title="type parameter in AbstractMap.SimpleImmutableEntry">V</a>&gt;</code></li>
    235. 

  235. </ul>
    236. 

  236. </li>
    237. 

  237. </ul>
    238. 

  238. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
    239. 

  239. <ul class="blockList">
    240. 

  240. <li class="blockList"><a name="constructor_summary">
    241. 

  241. <!--   -->
    242. 

  242. </a>
    243. 

  243. <h3>Constructor Summary</h3>
    244. 

  244. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
    245. 

  245. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
    246. 

  246. <tr>
    247. 

  247. <th class="colOne" scope="col">Constructor and Description</th>
    248. 

  248. </tr>
    249. 

  249. <tr class="altColor">
    250. 

  250. <td class="colOne"><code><strong><a href="../../java/util/TreeMap.html#TreeMap()">TreeMap</a></strong>()</code>
    251. 

  251. <div class="block">Constructs a new, empty tree map, using the natural ordering of its
    252. 

  252.  keys.</div>
    253. 

  253. </td>
    254. 

  254. </tr>
    255. 

  255. <tr class="rowColor">
    256. 

  256. <td class="colOne"><code><strong><a href="../../java/util/TreeMap.html#TreeMap(java.util.Comparator)">TreeMap</a></strong>(<a href="../../java/util/Comparator.html" title="interface in java.util">Comparator</a>&lt;? super <a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>&gt;&nbsp;comparator)</code>
    257. 

  257. <div class="block">Constructs a new, empty tree map, ordered according to the given
    258. 

  258.  comparator.</div>
    259. 

  259. </td>
    260. 

  260. </tr>
    261. 

  261. <tr class="altColor">
    262. 

  262. <td class="colOne"><code><strong><a href="../../java/util/TreeMap.html#TreeMap(java.util.Map)">TreeMap</a></strong>(<a href="../../java/util/Map.html" title="interface in java.util">Map</a>&lt;? extends <a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,? extends <a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;&nbsp;m)</code>
    263. 

  263. <div class="block">Constructs a new tree map containing the same mappings as the given
    264. 

  264.  map, ordered according to the <em>natural ordering</em> of its keys.</div>
    265. 

  265. </td>
    266. 

  266. </tr>
    267. 

  267. <tr class="rowColor">
    268. 

  268. <td class="colOne"><code><strong><a href="../../java/util/TreeMap.html#TreeMap(java.util.SortedMap)">TreeMap</a></strong>(<a href="../../java/util/SortedMap.html" title="interface in java.util">SortedMap</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,? extends <a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;&nbsp;m)</code>
    269. 

  269. <div class="block">Constructs a new tree map containing the same mappings and
    270. 

  270.  using the same ordering as the specified sorted map.</div>
    271. 

  271. </td>
    272. 

  272. </tr>
    273. 

  273. </table>
    274. 

  274. </li>
    275. 

  275. </ul>
    276. 

  276. <!-- ========== METHOD SUMMARY =========== -->
    277. 

  277. <ul class="blockList">
    278. 

  278. <li class="blockList"><a name="method_summary">
    279. 

  279. <!--   -->
    280. 

  280. </a>
    281. 

  281. <h3>Method Summary</h3>
    282. 

  282. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
    283. 

  283. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
    284. 

  284. <tr>
    285. 

  285. <th class="colFirst" scope="col">Modifier and Type</th>
    286. 

  286. <th class="colLast" scope="col">Method and Description</th>
    287. 

  287. </tr>
    288. 

  288. <tr class="altColor">
    289. 

  289. <td class="colFirst"><code><a href="../../java/util/Map.Entry.html" title="interface in java.util">Map.Entry</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></td>
    290. 

  290. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#ceilingEntry(K)">ceilingEntry</a></strong>(<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>&nbsp;key)</code>
    291. 

  291. <div class="block">Returns a key-value mapping associated with the least key
    292. 

  292.  greater than or equal to the given key, or <code>null</code> if
    293. 

  293.  there is no such key.</div>
    294. 

  294. </td>
    295. 

  295. </tr>
    296. 

  296. <tr class="rowColor">
    297. 

  297. <td class="colFirst"><code><a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a></code></td>
    298. 

  298. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#ceilingKey(K)">ceilingKey</a></strong>(<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>&nbsp;key)</code>
    299. 

  299. <div class="block">Returns the least key greater than or equal to the given key,
    300. 

  300.  or <code>null</code> if there is no such key.</div>
    301. 

  301. </td>
    302. 

  302. </tr>
    303. 

  303. <tr class="altColor">
    304. 

  304. <td class="colFirst"><code>void</code></td>
    305. 

  305. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#clear()">clear</a></strong>()</code>
    306. 

  306. <div class="block">Removes all of the mappings from this map.</div>
    307. 

  307. </td>
    308. 

  308. </tr>
    309. 

  309. <tr class="rowColor">
    310. 

  310. <td class="colFirst"><code><a href="../../java/lang/Object.html" title="class in java.lang">Object</a></code></td>
    311. 

  311. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#clone()">clone</a></strong>()</code>
    312. 

  312. <div class="block">Returns a shallow copy of this <code>TreeMap</code> instance.</div>
    313. 

  313. </td>
    314. 

  314. </tr>
    315. 

  315. <tr class="altColor">
    316. 

  316. <td class="colFirst"><code><a href="../../java/util/Comparator.html" title="interface in java.util">Comparator</a>&lt;? super <a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>&gt;</code></td>
    317. 

  317. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#comparator()">comparator</a></strong>()</code>
    318. 

  318. <div class="block">Returns the comparator used to order the keys in this map, or
    319. 

  319.  <code>null</code> if this map uses the <a href="../../java/lang/Comparable.html" title="interface in java.lang">natural ordering</a> of its keys.</div>
    320. 

  320. </td>
    321. 

  321. </tr>
    322. 

  322. <tr class="rowColor">
    323. 

  323. <td class="colFirst"><code>boolean</code></td>
    324. 

  324. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#containsKey(java.lang.Object)">containsKey</a></strong>(<a href="../../java/lang/Object.html" title="class in java.lang">Object</a>&nbsp;key)</code>
    325. 

  325. <div class="block">Returns <code>true</code> if this map contains a mapping for the specified
    326. 

  326.  key.</div>
    327. 

  327. </td>
    328. 

  328. </tr>
    329. 

  329. <tr class="altColor">
    330. 

  330. <td class="colFirst"><code>boolean</code></td>
    331. 

  331. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#containsValue(java.lang.Object)">containsValue</a></strong>(<a href="../../java/lang/Object.html" title="class in java.lang">Object</a>&nbsp;value)</code>
    332. 

  332. <div class="block">Returns <code>true</code> if this map maps one or more keys to the
    333. 

  333.  specified value.</div>
    334. 

  334. </td>
    335. 

  335. </tr>
    336. 

  336. <tr class="rowColor">
    337. 

  337. <td class="colFirst"><code><a href="../../java/util/NavigableSet.html" title="interface in java.util">NavigableSet</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>&gt;</code></td>
    338. 

  338. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#descendingKeySet()">descendingKeySet</a></strong>()</code>
    339. 

  339. <div class="block">Returns a reverse order <a href="../../java/util/NavigableSet.html" title="interface in java.util"><code>NavigableSet</code></a> view of the keys contained in this map.</div>
    340. 

  340. </td>
    341. 

  341. </tr>
    342. 

  342. <tr class="altColor">
    343. 

  343. <td class="colFirst"><code><a href="../../java/util/NavigableMap.html" title="interface in java.util">NavigableMap</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></td>
    344. 

  344. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#descendingMap()">descendingMap</a></strong>()</code>
    345. 

  345. <div class="block">Returns a reverse order view of the mappings contained in this map.</div>
    346. 

  346. </td>
    347. 

  347. </tr>
    348. 

  348. <tr class="rowColor">
    349. 

  349. <td class="colFirst"><code><a href="../../java/util/Set.html" title="interface in java.util">Set</a>&lt;<a href="../../java/util/Map.Entry.html" title="interface in java.util">Map.Entry</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;&gt;</code></td>
    350. 

  350. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#entrySet()">entrySet</a></strong>()</code>
    351. 

  351. <div class="block">Returns a <a href="../../java/util/Set.html" title="interface in java.util"><code>Set</code></a> view of the mappings contained in this map.</div>
    352. 

  352. </td>
    353. 

  353. </tr>
    354. 

  354. <tr class="altColor">
    355. 

  355. <td class="colFirst"><code><a href="../../java/util/Map.Entry.html" title="interface in java.util">Map.Entry</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></td>
    356. 

  356. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#firstEntry()">firstEntry</a></strong>()</code>
    357. 

  357. <div class="block">Returns a key-value mapping associated with the least
    358. 

  358.  key in this map, or <code>null</code> if the map is empty.</div>
    359. 

  359. </td>
    360. 

  360. </tr>
    361. 

  361. <tr class="rowColor">
    362. 

  362. <td class="colFirst"><code><a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a></code></td>
    363. 

  363. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#firstKey()">firstKey</a></strong>()</code>
    364. 

  364. <div class="block">Returns the first (lowest) key currently in this map.</div>
    365. 

  365. </td>
    366. 

  366. </tr>
    367. 

  367. <tr class="altColor">
    368. 

  368. <td class="colFirst"><code><a href="../../java/util/Map.Entry.html" title="interface in java.util">Map.Entry</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></td>
    369. 

  369. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#floorEntry(K)">floorEntry</a></strong>(<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>&nbsp;key)</code>
    370. 

  370. <div class="block">Returns a key-value mapping associated with the greatest key
    371. 

  371.  less than or equal to the given key, or <code>null</code> if there
    372. 

  372.  is no such key.</div>
    373. 

  373. </td>
    374. 

  374. </tr>
    375. 

  375. <tr class="rowColor">
    376. 

  376. <td class="colFirst"><code><a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a></code></td>
    377. 

  377. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#floorKey(K)">floorKey</a></strong>(<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>&nbsp;key)</code>
    378. 

  378. <div class="block">Returns the greatest key less than or equal to the given key,
    379. 

  379.  or <code>null</code> if there is no such key.</div>
    380. 

  380. </td>
    381. 

  381. </tr>
    382. 

  382. <tr class="altColor">
    383. 

  383. <td class="colFirst"><code><a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a></code></td>
    384. 

  384. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#get(java.lang.Object)">get</a></strong>(<a href="../../java/lang/Object.html" title="class in java.lang">Object</a>&nbsp;key)</code>
    385. 

  385. <div class="block">Returns the value to which the specified key is mapped,
    386. 

  386.  or <code>null</code> if this map contains no mapping for the key.</div>
    387. 

  387. </td>
    388. 

  388. </tr>
    389. 

  389. <tr class="rowColor">
    390. 

  390. <td class="colFirst"><code><a href="../../java/util/SortedMap.html" title="interface in java.util">SortedMap</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></td>
    391. 

  391. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#headMap(K)">headMap</a></strong>(<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>&nbsp;toKey)</code>
    392. 

  392. <div class="block">Returns a view of the portion of this map whose keys are
    393. 

  393.  strictly less than <code>toKey</code>.</div>
    394. 

  394. </td>
    395. 

  395. </tr>
    396. 

  396. <tr class="altColor">
    397. 

  397. <td class="colFirst"><code><a href="../../java/util/NavigableMap.html" title="interface in java.util">NavigableMap</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></td>
    398. 

  398. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#headMap(K,%20boolean)">headMap</a></strong>(<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>&nbsp;toKey,
    399. 

  399.        boolean&nbsp;inclusive)</code>
    400. 

  400. <div class="block">Returns a view of the portion of this map whose keys are less than (or
    401. 

  401.  equal to, if <code>inclusive</code> is true) <code>toKey</code>.</div>
    402. 

  402. </td>
    403. 

  403. </tr>
    404. 

  404. <tr class="rowColor">
    405. 

  405. <td class="colFirst"><code><a href="../../java/util/Map.Entry.html" title="interface in java.util">Map.Entry</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></td>
    406. 

  406. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#higherEntry(K)">higherEntry</a></strong>(<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>&nbsp;key)</code>
    407. 

  407. <div class="block">Returns a key-value mapping associated with the least key
    408. 

  408.  strictly greater than the given key, or <code>null</code> if there
    409. 

  409.  is no such key.</div>
    410. 

  410. </td>
    411. 

  411. </tr>
    412. 

  412. <tr class="altColor">
    413. 

  413. <td class="colFirst"><code><a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a></code></td>
    414. 

  414. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#higherKey(K)">higherKey</a></strong>(<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>&nbsp;key)</code>
    415. 

  415. <div class="block">Returns the least key strictly greater than the given key, or
    416. 

  416.  <code>null</code> if there is no such key.</div>
    417. 

  417. </td>
    418. 

  418. </tr>
    419. 

  419. <tr class="rowColor">
    420. 

  420. <td class="colFirst"><code><a href="../../java/util/Set.html" title="interface in java.util">Set</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>&gt;</code></td>
    421. 

  421. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#keySet()">keySet</a></strong>()</code>
    422. 

  422. <div class="block">Returns a <a href="../../java/util/Set.html" title="interface in java.util"><code>Set</code></a> view of the keys contained in this map.</div>
    423. 

  423. </td>
    424. 

  424. </tr>
    425. 

  425. <tr class="altColor">
    426. 

  426. <td class="colFirst"><code><a href="../../java/util/Map.Entry.html" title="interface in java.util">Map.Entry</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></td>
    427. 

  427. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#lastEntry()">lastEntry</a></strong>()</code>
    428. 

  428. <div class="block">Returns a key-value mapping associated with the greatest
    429. 

  429.  key in this map, or <code>null</code> if the map is empty.</div>
    430. 

  430. </td>
    431. 

  431. </tr>
    432. 

  432. <tr class="rowColor">
    433. 

  433. <td class="colFirst"><code><a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a></code></td>
    434. 

  434. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#lastKey()">lastKey</a></strong>()</code>
    435. 

  435. <div class="block">Returns the last (highest) key currently in this map.</div>
    436. 

  436. </td>
    437. 

  437. </tr>
    438. 

  438. <tr class="altColor">
    439. 

  439. <td class="colFirst"><code><a href="../../java/util/Map.Entry.html" title="interface in java.util">Map.Entry</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></td>
    440. 

  440. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#lowerEntry(K)">lowerEntry</a></strong>(<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>&nbsp;key)</code>
    441. 

  441. <div class="block">Returns a key-value mapping associated with the greatest key
    442. 

  442.  strictly less than the given key, or <code>null</code> if there is
    443. 

  443.  no such key.</div>
    444. 

  444. </td>
    445. 

  445. </tr>
    446. 

  446. <tr class="rowColor">
    447. 

  447. <td class="colFirst"><code><a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a></code></td>
    448. 

  448. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#lowerKey(K)">lowerKey</a></strong>(<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>&nbsp;key)</code>
    449. 

  449. <div class="block">Returns the greatest key strictly less than the given key, or
    450. 

  450.  <code>null</code> if there is no such key.</div>
    451. 

  451. </td>
    452. 

  452. </tr>
    453. 

  453. <tr class="altColor">
    454. 

  454. <td class="colFirst"><code><a href="../../java/util/NavigableSet.html" title="interface in java.util">NavigableSet</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>&gt;</code></td>
    455. 

  455. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#navigableKeySet()">navigableKeySet</a></strong>()</code>
    456. 

  456. <div class="block">Returns a <a href="../../java/util/NavigableSet.html" title="interface in java.util"><code>NavigableSet</code></a> view of the keys contained in this map.</div>
    457. 

  457. </td>
    458. 

  458. </tr>
    459. 

  459. <tr class="rowColor">
    460. 

  460. <td class="colFirst"><code><a href="../../java/util/Map.Entry.html" title="interface in java.util">Map.Entry</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></td>
    461. 

  461. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#pollFirstEntry()">pollFirstEntry</a></strong>()</code>
    462. 

  462. <div class="block">Removes and returns a key-value mapping associated with
    463. 

  463.  the least key in this map, or <code>null</code> if the map is empty.</div>
    464. 

  464. </td>
    465. 

  465. </tr>
    466. 

  466. <tr class="altColor">
    467. 

  467. <td class="colFirst"><code><a href="../../java/util/Map.Entry.html" title="interface in java.util">Map.Entry</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></td>
    468. 

  468. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#pollLastEntry()">pollLastEntry</a></strong>()</code>
    469. 

  469. <div class="block">Removes and returns a key-value mapping associated with
    470. 

  470.  the greatest key in this map, or <code>null</code> if the map is empty.</div>
    471. 

  471. </td>
    472. 

  472. </tr>
    473. 

  473. <tr class="rowColor">
    474. 

  474. <td class="colFirst"><code><a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a></code></td>
    475. 

  475. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#put(K,%20V)">put</a></strong>(<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>&nbsp;key,
    476. 

  476.    <a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&nbsp;value)</code>
    477. 

  477. <div class="block">Associates the specified value with the specified key in this map.</div>
    478. 

  478. </td>
    479. 

  479. </tr>
    480. 

  480. <tr class="altColor">
    481. 

  481. <td class="colFirst"><code>void</code></td>
    482. 

  482. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#putAll(java.util.Map)">putAll</a></strong>(<a href="../../java/util/Map.html" title="interface in java.util">Map</a>&lt;? extends <a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,? extends <a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;&nbsp;map)</code>
    483. 

  483. <div class="block">Copies all of the mappings from the specified map to this map.</div>
    484. 

  484. </td>
    485. 

  485. </tr>
    486. 

  486. <tr class="rowColor">
    487. 

  487. <td class="colFirst"><code><a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a></code></td>
    488. 

  488. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#remove(java.lang.Object)">remove</a></strong>(<a href="../../java/lang/Object.html" title="class in java.lang">Object</a>&nbsp;key)</code>
    489. 

  489. <div class="block">Removes the mapping for this key from this TreeMap if present.</div>
    490. 

  490. </td>
    491. 

  491. </tr>
    492. 

  492. <tr class="altColor">
    493. 

  493. <td class="colFirst"><code>int</code></td>
    494. 

  494. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#size()">size</a></strong>()</code>
    495. 

  495. <div class="block">Returns the number of key-value mappings in this map.</div>
    496. 

  496. </td>
    497. 

  497. </tr>
    498. 

  498. <tr class="rowColor">
    499. 

  499. <td class="colFirst"><code><a href="../../java/util/NavigableMap.html" title="interface in java.util">NavigableMap</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></td>
    500. 

  500. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#subMap(K,%20boolean,%20K,%20boolean)">subMap</a></strong>(<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>&nbsp;fromKey,
    501. 

  501.       boolean&nbsp;fromInclusive,
    502. 

  502.       <a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>&nbsp;toKey,
    503. 

  503.       boolean&nbsp;toInclusive)</code>
    504. 

  504. <div class="block">Returns a view of the portion of this map whose keys range from
    505. 

  505.  <code>fromKey</code> to <code>toKey</code>.</div>
    506. 

  506. </td>
    507. 

  507. </tr>
    508. 

  508. <tr class="altColor">
    509. 

  509. <td class="colFirst"><code><a href="../../java/util/SortedMap.html" title="interface in java.util">SortedMap</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></td>
    510. 

  510. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#subMap(K,%20K)">subMap</a></strong>(<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>&nbsp;fromKey,
    511. 

  511.       <a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>&nbsp;toKey)</code>
    512. 

  512. <div class="block">Returns a view of the portion of this map whose keys range from
    513. 

  513.  <code>fromKey</code>, inclusive, to <code>toKey</code>, exclusive.</div>
    514. 

  514. </td>
    515. 

  515. </tr>
    516. 

  516. <tr class="rowColor">
    517. 

  517. <td class="colFirst"><code><a href="../../java/util/SortedMap.html" title="interface in java.util">SortedMap</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></td>
    518. 

  518. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#tailMap(K)">tailMap</a></strong>(<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>&nbsp;fromKey)</code>
    519. 

  519. <div class="block">Returns a view of the portion of this map whose keys are
    520. 

  520.  greater than or equal to <code>fromKey</code>.</div>
    521. 

  521. </td>
    522. 

  522. </tr>
    523. 

  523. <tr class="altColor">
    524. 

  524. <td class="colFirst"><code><a href="../../java/util/NavigableMap.html" title="interface in java.util">NavigableMap</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></td>
    525. 

  525. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#tailMap(K,%20boolean)">tailMap</a></strong>(<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>&nbsp;fromKey,
    526. 

  526.        boolean&nbsp;inclusive)</code>
    527. 

  527. <div class="block">Returns a view of the portion of this map whose keys are greater than (or
    528. 

  528.  equal to, if <code>inclusive</code> is true) <code>fromKey</code>.</div>
    529. 

  529. </td>
    530. 

  530. </tr>
    531. 

  531. <tr class="rowColor">
    532. 

  532. <td class="colFirst"><code><a href="../../java/util/Collection.html" title="interface in java.util">Collection</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></td>
    533. 

  533. <td class="colLast"><code><strong><a href="../../java/util/TreeMap.html#values()">values</a></strong>()</code>
    534. 

  534. <div class="block">Returns a <a href="../../java/util/Collection.html" title="interface in java.util"><code>Collection</code></a> view of the values contained in this map.</div>
    535. 

  535. </td>
    536. 

  536. </tr>
    537. 

  537. </table>
    538. 

  538. <ul class="blockList">
    539. 

  539. <li class="blockList"><a name="methods_inherited_from_class_java.util.AbstractMap">
    540. 

  540. <!--   -->
    541. 

  541. </a>
    542. 

  542. <h3>Methods inherited from class&nbsp;java.util.<a href="../../java/util/AbstractMap.html" title="class in java.util">AbstractMap</a></h3>
    543. 

  543. <code><a href="../../java/util/AbstractMap.html#equals(java.lang.Object)">equals</a>, <a href="../../java/util/AbstractMap.html#hashCode()">hashCode</a>, <a href="../../java/util/AbstractMap.html#isEmpty()">isEmpty</a>, <a href="../../java/util/AbstractMap.html#toString()">toString</a></code></li>
    544. 

  544. </ul>
    545. 

  545. <ul class="blockList">
    546. 

  546. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
    547. 

  547. <!--   -->
    548. 

  548. </a>
    549. 

  549. <h3>Methods inherited from class&nbsp;java.lang.<a href="../../java/lang/Object.html" title="class in java.lang">Object</a></h3>
    550. 

  550. <code><a href="../../java/lang/Object.html#finalize()">finalize</a>, <a href="../../java/lang/Object.html#getClass()">getClass</a>, <a href="../../java/lang/Object.html#notify()">notify</a>, <a href="../../java/lang/Object.html#notifyAll()">notifyAll</a>, <a href="../../java/lang/Object.html#wait()">wait</a>, <a href="../../java/lang/Object.html#wait(long)">wait</a>, <a href="../../java/lang/Object.html#wait(long,%20int)">wait</a></code></li>
    551. 

  551. </ul>
    552. 

  552. <ul class="blockList">
    553. 

  553. <li class="blockList"><a name="methods_inherited_from_class_java.util.Map">
    554. 

  554. <!--   -->
    555. 

  555. </a>
    556. 

  556. <h3>Methods inherited from interface&nbsp;java.util.<a href="../../java/util/Map.html" title="interface in java.util">Map</a></h3>
    557. 

  557. <code><a href="../../java/util/Map.html#equals(java.lang.Object)">equals</a>, <a href="../../java/util/Map.html#hashCode()">hashCode</a>, <a href="../../java/util/Map.html#isEmpty()">isEmpty</a></code></li>
    558. 

  558. </ul>
    559. 

  559. </li>
    560. 

  560. </ul>
    561. 

  561. </li>
    562. 

  562. </ul>
    563. 

  563. </div>
    564. 

  564. <div class="details">
    565. 

  565. <ul class="blockList">
    566. 

  566. <li class="blockList">
    567. 

  567. <!-- ========= CONSTRUCTOR DETAIL ======== -->
    568. 

  568. <ul class="blockList">
    569. 

  569. <li class="blockList"><a name="constructor_detail">
    570. 

  570. <!--   -->
    571. 

  571. </a>
    572. 

  572. <h3>Constructor Detail</h3>
    573. 

  573. <a name="TreeMap()">
    574. 

  574. <!--   -->
    575. 

  575. </a>
    576. 

  576. <ul class="blockList">
    577. 

  577. <li class="blockList">
    578. 

  578. <h4>TreeMap</h4>
    579. 

  579. <pre>public&nbsp;TreeMap()</pre>
    580. 

  580. <div class="block">Constructs a new, empty tree map, using the natural ordering of its
    581. 

  581.  keys.  All keys inserted into the map must implement the <a href="../../java/lang/Comparable.html" title="interface in java.lang"><code>Comparable</code></a> interface.  Furthermore, all such keys must be
    582. 

  582.  <em>mutually comparable</em>: <code>k1.compareTo(k2)</code> must not throw
    583. 

  583.  a <code>ClassCastException</code> for any keys <code>k1</code> and
    584. 

  584.  <code>k2</code> in the map.  If the user attempts to put a key into the
    585. 

  585.  map that violates this constraint (for example, the user attempts to
    586. 

  586.  put a string key into a map whose keys are integers), the
    587. 

  587.  <code>put(Object key, Object value)</code> call will throw a
    588. 

  588.  <code>ClassCastException</code>.</div>
    589. 

  589. </li>
    590. 

  590. </ul>
    591. 

  591. <a name="TreeMap(java.util.Comparator)">
    592. 

  592. <!--   -->
    593. 

  593. </a>
    594. 

  594. <ul class="blockList">
    595. 

  595. <li class="blockList">
    596. 

  596. <h4>TreeMap</h4>
    597. 

  597. <pre>public&nbsp;TreeMap(<a href="../../java/util/Comparator.html" title="interface in java.util">Comparator</a>&lt;? super <a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>&gt;&nbsp;comparator)</pre>
    598. 

  598. <div class="block">Constructs a new, empty tree map, ordered according to the given
    599. 

  599.  comparator.  All keys inserted into the map must be <em>mutually
    600. 

  600.  comparable</em> by the given comparator: <code>comparator.compare(k1,
    601. 

  601.  k2)</code> must not throw a <code>ClassCastException</code> for any keys
    602. 

  602.  <code>k1</code> and <code>k2</code> in the map.  If the user attempts to put
    603. 

  603.  a key into the map that violates this constraint, the <code>put(Object
    604. 

  604.  key, Object value)</code> call will throw a
    605. 

  605.  <code>ClassCastException</code>.</div>
    606. 

  606. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>comparator</code> - the comparator that will be used to order this map.
    607. 

  607.         If <code>null</code>, the <a href="../../java/lang/Comparable.html" title="interface in java.lang">natural
    608. 

  608.         ordering</a> of the keys will be used.</dd></dl>
    609. 

  609. </li>
    610. 

  610. </ul>
    611. 

  611. <a name="TreeMap(java.util.Map)">
    612. 

  612. <!--   -->
    613. 

  613. </a>
    614. 

  614. <ul class="blockList">
    615. 

  615. <li class="blockList">
    616. 

  616. <h4>TreeMap</h4>
    617. 

  617. <pre>public&nbsp;TreeMap(<a href="../../java/util/Map.html" title="interface in java.util">Map</a>&lt;? extends <a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,? extends <a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;&nbsp;m)</pre>
    618. 

  618. <div class="block">Constructs a new tree map containing the same mappings as the given
    619. 

  619.  map, ordered according to the <em>natural ordering</em> of its keys.
    620. 

  620.  All keys inserted into the new map must implement the <a href="../../java/lang/Comparable.html" title="interface in java.lang"><code>Comparable</code></a> interface.  Furthermore, all such keys must be
    621. 

  621.  <em>mutually comparable</em>: <code>k1.compareTo(k2)</code> must not throw
    622. 

  622.  a <code>ClassCastException</code> for any keys <code>k1</code> and
    623. 

  623.  <code>k2</code> in the map.  This method runs in n*log(n) time.</div>
    624. 

  624. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>m</code> - the map whose mappings are to be placed in this map</dd>
    625. 

  625. <dt><span class="strong">Throws:</span></dt>
    626. 

  626. <dd><code><a href="../../java/lang/ClassCastException.html" title="class in java.lang">ClassCastException</a></code> - if the keys in m are not <a href="../../java/lang/Comparable.html" title="interface in java.lang"><code>Comparable</code></a>,
    627. 

  627.          or are not mutually comparable</dd>
    628. 

  628. <dd><code><a href="../../java/lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - if the specified map is null</dd></dl>
    629. 

  629. </li>
    630. 

  630. </ul>
    631. 

  631. <a name="TreeMap(java.util.SortedMap)">
    632. 

  632. <!--   -->
    633. 

  633. </a>
    634. 

  634. <ul class="blockListLast">
    635. 

  635. <li class="blockList">
    636. 

  636. <h4>TreeMap</h4>
    637. 

  637. <pre>public&nbsp;TreeMap(<a href="../../java/util/SortedMap.html" title="interface in java.util">SortedMap</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,? extends <a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;&nbsp;m)</pre>
    638. 

  638. <div class="block">Constructs a new tree map containing the same mappings and
    639. 

  639.  using the same ordering as the specified sorted map.  This
    640. 

  640.  method runs in linear time.</div>
    641. 

  641. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>m</code> - the sorted map whose mappings are to be placed in this map,
    642. 

  642.          and whose comparator is to be used to sort this map</dd>
    643. 

  643. <dt><span class="strong">Throws:</span></dt>
    644. 

  644. <dd><code><a href="../../java/lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - if the specified map is null</dd></dl>
    645. 

  645. </li>
    646. 

  646. </ul>
    647. 

  647. </li>
    648. 

  648. </ul>
    649. 

  649. <!-- ============ METHOD DETAIL ========== -->
    650. 

  650. <ul class="blockList">
    651. 

  651. <li class="blockList"><a name="method_detail">
    652. 

  652. <!--   -->
    653. 

  653. </a>
    654. 

  654. <h3>Method Detail</h3>
    655. 

  655. <a name="size()">
    656. 

  656. <!--   -->
    657. 

  657. </a>
    658. 

  658. <ul class="blockList">
    659. 

  659. <li class="blockList">
    660. 

  660. <h4>size</h4>
    661. 

  661. <pre>public&nbsp;int&nbsp;size()</pre>
    662. 

  662. <div class="block">Returns the number of key-value mappings in this map.</div>
    663. 

  663. <dl>
    664. 

  664. <dt><strong>Specified by:</strong></dt>
    665. 

  665. <dd><code><a href="../../java/util/Map.html#size()">size</a></code>&nbsp;in interface&nbsp;<code><a href="../../java/util/Map.html" title="interface in java.util">Map</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></dd>
    666. 

  666. <dt><strong>Overrides:</strong></dt>
    667. 

  667. <dd><code><a href="../../java/util/AbstractMap.html#size()">size</a></code>&nbsp;in class&nbsp;<code><a href="../../java/util/AbstractMap.html" title="class in java.util">AbstractMap</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></dd>
    668. 

  668. <dt><span class="strong">Returns:</span></dt><dd>the number of key-value mappings in this map</dd></dl>
    669. 

  669. </li>
    670. 

  670. </ul>
    671. 

  671. <a name="containsKey(java.lang.Object)">
    672. 

  672. <!--   -->
    673. 

  673. </a>
    674. 

  674. <ul class="blockList">
    675. 

  675. <li class="blockList">
    676. 

  676. <h4>containsKey</h4>
    677. 

  677. <pre>public&nbsp;boolean&nbsp;containsKey(<a href="../../java/lang/Object.html" title="class in java.lang">Object</a>&nbsp;key)</pre>
    678. 

  678. <div class="block">Returns <code>true</code> if this map contains a mapping for the specified
    679. 

  679.  key.</div>
    680. 

  680. <dl>
    681. 

  681. <dt><strong>Specified by:</strong></dt>
    682. 

  682. <dd><code><a href="../../java/util/Map.html#containsKey(java.lang.Object)">containsKey</a></code>&nbsp;in interface&nbsp;<code><a href="../../java/util/Map.html" title="interface in java.util">Map</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></dd>
    683. 

  683. <dt><strong>Overrides:</strong></dt>
    684. 

  684. <dd><code><a href="../../java/util/AbstractMap.html#containsKey(java.lang.Object)">containsKey</a></code>&nbsp;in class&nbsp;<code><a href="../../java/util/AbstractMap.html" title="class in java.util">AbstractMap</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></dd>
    685. 

  685. <dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - key whose presence in this map is to be tested</dd>
    686. 

  686. <dt><span class="strong">Returns:</span></dt><dd><code>true</code> if this map contains a mapping for the
    687. 

  687.          specified key</dd>
    688. 

  688. <dt><span class="strong">Throws:</span></dt>
    689. 

  689. <dd><code><a href="../../java/lang/ClassCastException.html" title="class in java.lang">ClassCastException</a></code> - if the specified key cannot be compared
    690. 

  690.          with the keys currently in the map</dd>
    691. 

  691. <dd><code><a href="../../java/lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - if the specified key is null
    692. 

  692.          and this map uses natural ordering, or its comparator
    693. 

  693.          does not permit null keys</dd></dl>
    694. 

  694. </li>
    695. 

  695. </ul>
    696. 

  696. <a name="containsValue(java.lang.Object)">
    697. 

  697. <!--   -->
    698. 

  698. </a>
    699. 

  699. <ul class="blockList">
    700. 

  700. <li class="blockList">
    701. 

  701. <h4>containsValue</h4>
    702. 

  702. <pre>public&nbsp;boolean&nbsp;containsValue(<a href="../../java/lang/Object.html" title="class in java.lang">Object</a>&nbsp;value)</pre>
    703. 

  703. <div class="block">Returns <code>true</code> if this map maps one or more keys to the
    704. 

  704.  specified value.  More formally, returns <code>true</code> if and only if
    705. 

  705.  this map contains at least one mapping to a value <code>v</code> such
    706. 

  706.  that <code>(value==null ? v==null : value.equals(v))</code>.  This
    707. 

  707.  operation will probably require time linear in the map size for
    708. 

  708.  most implementations.</div>
    709. 

  709. <dl>
    710. 

  710. <dt><strong>Specified by:</strong></dt>
    711. 

  711. <dd><code><a href="../../java/util/Map.html#containsValue(java.lang.Object)">containsValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../java/util/Map.html" title="interface in java.util">Map</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></dd>
    712. 

  712. <dt><strong>Overrides:</strong></dt>
    713. 

  713. <dd><code><a href="../../java/util/AbstractMap.html#containsValue(java.lang.Object)">containsValue</a></code>&nbsp;in class&nbsp;<code><a href="../../java/util/AbstractMap.html" title="class in java.util">AbstractMap</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></dd>
    714. 

  714. <dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - value whose presence in this map is to be tested</dd>
    715. 

  715. <dt><span class="strong">Returns:</span></dt><dd><code>true</code> if a mapping to <code>value</code> exists;
    716. 

  716.          <code>false</code> otherwise</dd><dt><span class="strong">Since:</span></dt>
    717. 

  717.   <dd>1.2</dd></dl>
    718. 

  718. </li>
    719. 

  719. </ul>
    720. 

  720. <a name="get(java.lang.Object)">
    721. 

  721. <!--   -->
    722. 

  722. </a>
    723. 

  723. <ul class="blockList">
    724. 

  724. <li class="blockList">
    725. 

  725. <h4>get</h4>
    726. 

  726. <pre>public&nbsp;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&nbsp;get(<a href="../../java/lang/Object.html" title="class in java.lang">Object</a>&nbsp;key)</pre>
    727. 

  727. <div class="block">Returns the value to which the specified key is mapped,
    728. 

  728.  or <code>null</code> if this map contains no mapping for the key.
    729. 

  729. 

  730.  <p>More formally, if this map contains a mapping from a key
    731. 

  731.  <code>k</code> to a value <code>v</code> such that <code>key</code> compares
    732. 

  732.  equal to <code>k</code> according to the map's ordering, then this
    733. 

  733.  method returns <code>v</code>; otherwise it returns <code>null</code>.
    734. 

  734.  (There can be at most one such mapping.)
    735. 

  735. 

  736.  <p>A return value of <code>null</code> does not <em>necessarily</em>
    737. 

  737.  indicate that the map contains no mapping for the key; it's also
    738. 

  738.  possible that the map explicitly maps the key to <code>null</code>.
    739. 

  739.  The <a href="../../java/util/TreeMap.html#containsKey(java.lang.Object)"><code>containsKey</code></a> operation may be used to
    740. 

  740.  distinguish these two cases.</div>
    741. 

  741. <dl>
    742. 

  742. <dt><strong>Specified by:</strong></dt>
    743. 

  743. <dd><code><a href="../../java/util/Map.html#get(java.lang.Object)">get</a></code>&nbsp;in interface&nbsp;<code><a href="../../java/util/Map.html" title="interface in java.util">Map</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></dd>
    744. 

  744. <dt><strong>Overrides:</strong></dt>
    745. 

  745. <dd><code><a href="../../java/util/AbstractMap.html#get(java.lang.Object)">get</a></code>&nbsp;in class&nbsp;<code><a href="../../java/util/AbstractMap.html" title="class in java.util">AbstractMap</a>&lt;<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">K</a>,<a href="../../java/util/TreeMap.html" title="type parameter in TreeMap">V</a>&gt;</code></dd>
    746. 

  746. <dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key whose associated value is to be returned</dd>
    747. 

  747. <dt><span class="strong">Returns:</span></dt><dd>the value to which the specified key is mapped, or
    748. 

  748.          <code>null</code> if this map contains no mapping for the key</dd>
    749. 

  749. <dt><span class="strong">Throws:</span></dt>
    750. 

  750. <dd><code><a href="../../java/lang/ClassCastException.html" title="class in java.lang">ClassCastException</a></code> - if the specified key cannot be compared
    751. 

  751.          with the keys currently in the map</dd>
    752. 

  752. <dd><code><a href="../../java/lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - if the specified key is nul…
    753.

Large files files are truncated, but you can click here to view the full file