/usr/share/doc/libbackport-util-concurrent-java/api/edu/emory/mathcs/backport/java/util/concurrent/ConcurrentNavigableMap.html is in libbackport-util-concurrent-java-doc 3.1-3build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Fri May 18 11:21:07 UTC 2012 -->
<title>ConcurrentNavigableMap</title>
<meta name="date" content="2012-05-18">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ConcurrentNavigableMap";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ConcurrentMap.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ConcurrentSkipListMap.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?edu/emory/mathcs/backport/java/util/concurrent/ConcurrentNavigableMap.html" target="_top">Frames</a></li>
<li><a href="ConcurrentNavigableMap.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">edu.emory.mathcs.backport.java.util.concurrent</div>
<h2 title="Interface ConcurrentNavigableMap" class="title">Interface ConcurrentNavigableMap</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ConcurrentMap.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">ConcurrentMap</a>, java.util.Map, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableMap</a>, java.util.SortedMap</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ConcurrentSkipListMap.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">ConcurrentSkipListMap</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ConcurrentNavigableMap</span>
extends <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ConcurrentMap.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">ConcurrentMap</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableMap</a></pre>
<div class="block">A <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ConcurrentMap.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent"><code>ConcurrentMap</code></a> supporting <a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html" title="interface in edu.emory.mathcs.backport.java.util"><code>NavigableMap</code></a> operations,
and recursively so for its navigable sub-maps.
<p>This interface is a member of the
<a href="../../../../../../../../technotes/guides/collections/index.html">
Java Collections Framework</a>.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.6</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Doug Lea</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_java.util.Map">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface java.util.Map</h3>
<code>java.util.Map.Entry</code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableSet.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableSet</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ConcurrentNavigableMap.html#descendingKeySet()">descendingKeySet</a></strong>()</code>
<div class="block">Returns a reverse order <a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableSet.html" title="interface in edu.emory.mathcs.backport.java.util"><code>NavigableSet</code></a> view of the keys contained in this map.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableMap</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ConcurrentNavigableMap.html#descendingMap()">descendingMap</a></strong>()</code>
<div class="block">Returns a reverse order view of the mappings contained in this map.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.SortedMap</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ConcurrentNavigableMap.html#headMap(java.lang.Object)">headMap</a></strong>(java.lang.Object toKey)</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableMap</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ConcurrentNavigableMap.html#headMap(java.lang.Object, boolean)">headMap</a></strong>(java.lang.Object toKey,
boolean inclusive)</code>
<div class="block">Returns a view of the portion of this map whose keys are less than (or
equal to, if <code>inclusive</code> is true) <code>toKey</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Set</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ConcurrentNavigableMap.html#keySet()">keySet</a></strong>()</code>
<div class="block">Returns a <a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableSet.html" title="interface in edu.emory.mathcs.backport.java.util"><code>NavigableSet</code></a> view of the keys contained in this map.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableSet.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableSet</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ConcurrentNavigableMap.html#navigableKeySet()">navigableKeySet</a></strong>()</code>
<div class="block">Returns a <a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableSet.html" title="interface in edu.emory.mathcs.backport.java.util"><code>NavigableSet</code></a> view of the keys contained in this map.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableMap</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ConcurrentNavigableMap.html#subMap(java.lang.Object, boolean, java.lang.Object, boolean)">subMap</a></strong>(java.lang.Object fromKey,
boolean fromInclusive,
java.lang.Object toKey,
boolean toInclusive)</code>
<div class="block">Returns a view of the portion of this map whose keys range from
<code>fromKey</code> to <code>toKey</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.SortedMap</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ConcurrentNavigableMap.html#subMap(java.lang.Object, java.lang.Object)">subMap</a></strong>(java.lang.Object fromKey,
java.lang.Object toKey)</code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.SortedMap</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ConcurrentNavigableMap.html#tailMap(java.lang.Object)">tailMap</a></strong>(java.lang.Object fromKey)</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableMap</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ConcurrentNavigableMap.html#tailMap(java.lang.Object, boolean)">tailMap</a></strong>(java.lang.Object fromKey,
boolean inclusive)</code>
<div class="block">Returns a view of the portion of this map whose keys are greater than (or
equal to, if <code>inclusive</code> is true) <code>fromKey</code>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_edu.emory.mathcs.backport.java.util.concurrent.ConcurrentMap">
<!-- -->
</a>
<h3>Methods inherited from interface edu.emory.mathcs.backport.java.util.concurrent.<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ConcurrentMap.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">ConcurrentMap</a></h3>
<code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ConcurrentMap.html#putIfAbsent(java.lang.Object, java.lang.Object)">putIfAbsent</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ConcurrentMap.html#remove(java.lang.Object, java.lang.Object)">remove</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ConcurrentMap.html#replace(java.lang.Object, java.lang.Object)">replace</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ConcurrentMap.html#replace(java.lang.Object, java.lang.Object, java.lang.Object)">replace</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_edu.emory.mathcs.backport.java.util.NavigableMap">
<!-- -->
</a>
<h3>Methods inherited from interface edu.emory.mathcs.backport.java.util.<a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableMap</a></h3>
<code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#ceilingEntry(java.lang.Object)">ceilingEntry</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#ceilingKey(java.lang.Object)">ceilingKey</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#firstEntry()">firstEntry</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#floorEntry(java.lang.Object)">floorEntry</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#floorKey(java.lang.Object)">floorKey</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#higherEntry(java.lang.Object)">higherEntry</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#higherKey(java.lang.Object)">higherKey</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#lastEntry()">lastEntry</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#lowerEntry(java.lang.Object)">lowerEntry</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#lowerKey(java.lang.Object)">lowerKey</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#pollFirstEntry()">pollFirstEntry</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#pollLastEntry()">pollLastEntry</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.util.SortedMap">
<!-- -->
</a>
<h3>Methods inherited from interface java.util.SortedMap</h3>
<code>comparator, entrySet, firstKey, lastKey, values</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.util.Map">
<!-- -->
</a>
<h3>Methods inherited from interface java.util.Map</h3>
<code>clear, containsKey, containsValue, equals, get, hashCode, isEmpty, put, putAll, remove, size</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="subMap(java.lang.Object, boolean, java.lang.Object, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subMap</h4>
<pre><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableMap</a> subMap(java.lang.Object fromKey,
boolean fromInclusive,
java.lang.Object toKey,
boolean toInclusive)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#subMap(java.lang.Object, boolean, java.lang.Object, boolean)">NavigableMap</a></code></strong></div>
<div class="block">Returns a view of the portion of this map whose keys range from
<code>fromKey</code> to <code>toKey</code>. If <code>fromKey</code> and
<code>toKey</code> are equal, the returned map is empty unless
<code>fromExclusive</code> and <code>toExclusive</code> are both true. The
returned map is backed by this map, so changes in the returned map are
reflected in this map, and vice-versa. The returned map supports all
optional map operations that this map supports.
<p>The returned map will throw an <code>IllegalArgumentException</code>
on an attempt to insert a key outside of its range, or to construct a
submap either of whose endpoints lie outside its range.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#subMap(java.lang.Object, boolean, java.lang.Object, boolean)">subMap</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableMap</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>fromKey</code> - low endpoint of the keys in the returned map</dd><dd><code>fromInclusive</code> - <code>true</code> if the low endpoint
is to be included in the returned view</dd><dd><code>toKey</code> - high endpoint of the keys in the returned map</dd><dd><code>toInclusive</code> - <code>true</code> if the high endpoint
is to be included in the returned view</dd>
<dt><span class="strong">Returns:</span></dt><dd>a view of the portion of this map whose keys range from
<code>fromKey</code> to <code>toKey</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ClassCastException</code> - if <code>fromKey</code> and <code>toKey</code>
cannot be compared to one another using this map's comparator
(or, if the map has no comparator, using natural ordering).
Implementations may, but are not required to, throw this
exception if <code>fromKey</code> or <code>toKey</code>
cannot be compared to keys currently in the map.</dd>
<dd><code>java.lang.NullPointerException</code> - if <code>fromKey</code> or <code>toKey</code>
is null and this map does not permit null keys</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>fromKey</code> is greater than
<code>toKey</code>; or if this map itself has a restricted
range, and <code>fromKey</code> or <code>toKey</code> lies
outside the bounds of the range</dd></dl>
</li>
</ul>
<a name="headMap(java.lang.Object, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>headMap</h4>
<pre><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableMap</a> headMap(java.lang.Object toKey,
boolean inclusive)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#headMap(java.lang.Object, boolean)">NavigableMap</a></code></strong></div>
<div class="block">Returns a view of the portion of this map whose keys are less than (or
equal to, if <code>inclusive</code> is true) <code>toKey</code>. The returned
map is backed by this map, so changes in the returned map are reflected
in this map, and vice-versa. The returned map supports all optional
map operations that this map supports.
<p>The returned map will throw an <code>IllegalArgumentException</code>
on an attempt to insert a key outside its range.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#headMap(java.lang.Object, boolean)">headMap</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableMap</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>toKey</code> - high endpoint of the keys in the returned map</dd><dd><code>inclusive</code> - <code>true</code> if the high endpoint
is to be included in the returned view</dd>
<dt><span class="strong">Returns:</span></dt><dd>a view of the portion of this map whose keys are less than
(or equal to, if <code>inclusive</code> is true) <code>toKey</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ClassCastException</code> - if <code>toKey</code> is not compatible
with this map's comparator (or, if the map has no comparator,
if <code>toKey</code> does not implement <code>Comparable</code>).
Implementations may, but are not required to, throw this
exception if <code>toKey</code> cannot be compared to keys
currently in the map.</dd>
<dd><code>java.lang.NullPointerException</code> - if <code>toKey</code> is null
and this map does not permit null keys</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if this map itself has a
restricted range, and <code>toKey</code> lies outside the
bounds of the range</dd></dl>
</li>
</ul>
<a name="tailMap(java.lang.Object, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tailMap</h4>
<pre><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableMap</a> tailMap(java.lang.Object fromKey,
boolean inclusive)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#tailMap(java.lang.Object, boolean)">NavigableMap</a></code></strong></div>
<div class="block">Returns a view of the portion of this map whose keys are greater than (or
equal to, if <code>inclusive</code> is true) <code>fromKey</code>. The returned
map is backed by this map, so changes in the returned map are reflected
in this map, and vice-versa. The returned map supports all optional
map operations that this map supports.
<p>The returned map will throw an <code>IllegalArgumentException</code>
on an attempt to insert a key outside its range.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#tailMap(java.lang.Object, boolean)">tailMap</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableMap</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>fromKey</code> - low endpoint of the keys in the returned map</dd><dd><code>inclusive</code> - <code>true</code> if the low endpoint
is to be included in the returned view</dd>
<dt><span class="strong">Returns:</span></dt><dd>a view of the portion of this map whose keys are greater than
(or equal to, if <code>inclusive</code> is true) <code>fromKey</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ClassCastException</code> - if <code>fromKey</code> is not compatible
with this map's comparator (or, if the map has no comparator,
if <code>fromKey</code> does not implement <code>Comparable</code>).
Implementations may, but are not required to, throw this
exception if <code>fromKey</code> cannot be compared to keys
currently in the map.</dd>
<dd><code>java.lang.NullPointerException</code> - if <code>fromKey</code> is null
and this map does not permit null keys</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if this map itself has a
restricted range, and <code>fromKey</code> lies outside the
bounds of the range</dd></dl>
</li>
</ul>
<a name="subMap(java.lang.Object, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subMap</h4>
<pre>java.util.SortedMap subMap(java.lang.Object fromKey,
java.lang.Object toKey)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#subMap(java.lang.Object, java.lang.Object)">NavigableMap</a></code></strong></div>
<div class="block">
<p>Equivalent to <code>subMap(fromKey, true, toKey, false)</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#subMap(java.lang.Object, java.lang.Object)">subMap</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableMap</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>subMap</code> in interface <code>java.util.SortedMap</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ClassCastException</code></dd>
<dd><code>java.lang.NullPointerException</code></dd>
<dd><code>java.lang.IllegalArgumentException</code></dd></dl>
</li>
</ul>
<a name="headMap(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>headMap</h4>
<pre>java.util.SortedMap headMap(java.lang.Object toKey)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#headMap(java.lang.Object)">NavigableMap</a></code></strong></div>
<div class="block">
<p>Equivalent to <code>headMap(toKey, false)</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#headMap(java.lang.Object)">headMap</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableMap</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>headMap</code> in interface <code>java.util.SortedMap</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ClassCastException</code></dd>
<dd><code>java.lang.NullPointerException</code></dd>
<dd><code>java.lang.IllegalArgumentException</code></dd></dl>
</li>
</ul>
<a name="tailMap(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tailMap</h4>
<pre>java.util.SortedMap tailMap(java.lang.Object fromKey)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#tailMap(java.lang.Object)">NavigableMap</a></code></strong></div>
<div class="block">
<p>Equivalent to <code>tailMap(fromKey, true)</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#tailMap(java.lang.Object)">tailMap</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableMap</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>tailMap</code> in interface <code>java.util.SortedMap</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.ClassCastException</code></dd>
<dd><code>java.lang.NullPointerException</code></dd>
<dd><code>java.lang.IllegalArgumentException</code></dd></dl>
</li>
</ul>
<a name="descendingMap()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>descendingMap</h4>
<pre><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableMap</a> descendingMap()</pre>
<div class="block">Returns a reverse order view of the mappings contained in this map.
The descending map is backed by this map, so changes to the map are
reflected in the descending map, and vice-versa.
<p>The returned map has an ordering equivalent to
<tt><a href="../../../../../../../edu/emory/mathcs/backport/java/util/Collections.html#reverseOrder(java.util.Comparator)"><code>Collections.reverseOrder</code></a>(comparator())</tt>.
The expression <code>m.descendingMap().descendingMap()</code> returns a
view of <code>m</code> essentially equivalent to <code>m</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#descendingMap()">descendingMap</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableMap</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a reverse order view of this map</dd></dl>
</li>
</ul>
<a name="navigableKeySet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>navigableKeySet</h4>
<pre><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableSet.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableSet</a> navigableKeySet()</pre>
<div class="block">Returns a <a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableSet.html" title="interface in edu.emory.mathcs.backport.java.util"><code>NavigableSet</code></a> view of the keys contained in this map.
The set's iterator returns the keys in ascending order.
The set is backed by the map, so changes to the map are
reflected in the set, and vice-versa. The set supports element
removal, which removes the corresponding mapping from the map,
via the <code>Iterator.remove</code>, <code>Set.remove</code>,
<code>removeAll</code>, <code>retainAll</code>, and <code>clear</code>
operations. It does not support the <code>add</code> or <code>addAll</code>
operations.
<p>The view's <code>iterator</code> is a "weakly consistent" iterator
that will never throw <code>ConcurrentModificationException</code>,
and guarantees to traverse elements as they existed upon
construction of the iterator, and may (but is not guaranteed to)
reflect any modifications subsequent to construction.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#navigableKeySet()">navigableKeySet</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableMap</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a navigable set view of the keys in this map</dd></dl>
</li>
</ul>
<a name="keySet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keySet</h4>
<pre>java.util.Set keySet()</pre>
<div class="block">Returns a <a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableSet.html" title="interface in edu.emory.mathcs.backport.java.util"><code>NavigableSet</code></a> view of the keys contained in this map.
The set's iterator returns the keys in ascending order.
The set is backed by the map, so changes to the map are
reflected in the set, and vice-versa. The set supports element
removal, which removes the corresponding mapping from the map,
via the <code>Iterator.remove</code>, <code>Set.remove</code>,
<code>removeAll</code>, <code>retainAll</code>, and <code>clear</code>
operations. It does not support the <code>add</code> or <code>addAll</code>
operations.
<p>The view's <code>iterator</code> is a "weakly consistent" iterator
that will never throw <code>ConcurrentModificationException</code>,
and guarantees to traverse elements as they existed upon
construction of the iterator, and may (but is not guaranteed to)
reflect any modifications subsequent to construction.
<p>This method is equivalent to method <code>navigableKeySet</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>keySet</code> in interface <code>java.util.Map</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>keySet</code> in interface <code>java.util.SortedMap</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a navigable set view of the keys in this map</dd></dl>
</li>
</ul>
<a name="descendingKeySet()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>descendingKeySet</h4>
<pre><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableSet.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableSet</a> descendingKeySet()</pre>
<div class="block">Returns a reverse order <a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableSet.html" title="interface in edu.emory.mathcs.backport.java.util"><code>NavigableSet</code></a> view of the keys contained in this map.
The set's iterator returns the keys in descending order.
The set is backed by the map, so changes to the map are
reflected in the set, and vice-versa. The set supports element
removal, which removes the corresponding mapping from the map,
via the <code>Iterator.remove</code>, <code>Set.remove</code>,
<code>removeAll</code>, <code>retainAll</code>, and <code>clear</code>
operations. It does not support the <code>add</code> or <code>addAll</code>
operations.
<p>The view's <code>iterator</code> is a "weakly consistent" iterator
that will never throw <code>ConcurrentModificationException</code>,
and guarantees to traverse elements as they existed upon
construction of the iterator, and may (but is not guaranteed to)
reflect any modifications subsequent to construction.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html#descendingKeySet()">descendingKeySet</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/NavigableMap.html" title="interface in edu.emory.mathcs.backport.java.util">NavigableMap</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a reverse order navigable set view of the keys in this map</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ConcurrentMap.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ConcurrentSkipListMap.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?edu/emory/mathcs/backport/java/util/concurrent/ConcurrentNavigableMap.html" target="_top">Frames</a></li>
<li><a href="ConcurrentNavigableMap.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|