/usr/share/doc/libplexus-utils-java/api/org/codehaus/plexus/util/CachedMap.html is in libplexus-utils-java-doc 1:1.5.15-5.
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 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<title>CachedMap (plexus-utils API)</title>
<meta name="date" content="2018-01-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CachedMap (plexus-utils API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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="../../../../org/codehaus/plexus/util/Base64.html" title="class in org.codehaus.plexus.util"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/codehaus/plexus/util/CollectionUtils.html" title="class in org.codehaus.plexus.util"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/codehaus/plexus/util/CachedMap.html" target="_top">Frames</a></li>
<li><a href="CachedMap.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><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </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">org.codehaus.plexus.util</div>
<h2 title="Class CachedMap" class="title">Class CachedMap</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.codehaus.plexus.util.CachedMap</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.util.Map</dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">CachedMap</span>
extends java.lang.Object
implements java.util.Map</pre>
<div class="block"><p> This class provides cache access to <code>Map</code> collections.</p>
<p> Instance of this class can be used as "proxy" for any collection
implementing the <code>java.util.Map</code> interface.</p>
<p> Typically, <a href="../../../../org/codehaus/plexus/util/CachedMap.html" title="class in org.codehaus.plexus.util"><code>CachedMap</code></a> are used to accelerate access to
large collections when the access to the collection is not evenly
distributed (associative cache). The performance gain is about
50% for the fastest hash map collections (e.g. <a href="../../../../org/codehaus/plexus/util/FastMap.html" title="class in org.codehaus.plexus.util"><code>FastMap</code></a>).
For slower collections such as <code>java.util.TreeMap</code>,
non-resizable <a href="../../../../org/codehaus/plexus/util/FastMap.html" title="class in org.codehaus.plexus.util"><code>FastMap</code></a> (real-time) or database access,
performance can be of several orders of magnitude.</p>
<p> <b>Note:</b> The keys used to access elements of a <a href="../../../../org/codehaus/plexus/util/CachedMap.html" title="class in org.codehaus.plexus.util"><code>CachedMap</code></a> do
not need to be immutable as they are not stored in the cache
(only keys specified by the <a href="../../../../org/codehaus/plexus/util/CachedMap.html#put-java.lang.Object-java.lang.Object-"><code>put(java.lang.Object, java.lang.Object)</code></a> method are).
In other words, access can be performed using mutable keys as long
as these keys can be compared for equality with the real map's keys
(e.g. same <code>hashCode</code> values).</p>
<p> This implementation is not synchronized. Multiple threads accessing
or modifying the collection must be synchronized externally.</p>
<p><i> This class is <b>public domain</b> (not copyrighted).</i></p></div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>5.3, October 30, 2003</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd><a href="mailto:jean-marie@dautelle.com">Jean-Marie Dautelle</a></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<K,V></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/util/CachedMap.html#CachedMap--">CachedMap</a></span>()</code>
<div class="block">Creates a cached map backed by a <a href="../../../../org/codehaus/plexus/util/FastMap.html" title="class in org.codehaus.plexus.util"><code>FastMap</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/util/CachedMap.html#CachedMap-int-">CachedMap</a></span>(int cacheSize)</code>
<div class="block">Creates a cached map backed by a <a href="../../../../org/codehaus/plexus/util/FastMap.html" title="class in org.codehaus.plexus.util"><code>FastMap</code></a> and having the
specified cache size.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/util/CachedMap.html#CachedMap-int-java.util.Map-">CachedMap</a></span>(int cacheSize,
java.util.Map backingMap)</code>
<div class="block">Creates a cached map backed by the specified map and having the specified
cache size.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/util/CachedMap.html#clear--">clear</a></span>()</code>
<div class="block">Removes all mappings from this map (optional operation).</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/util/CachedMap.html#containsKey-java.lang.Object-">containsKey</a></span>(java.lang.Object key)</code>
<div class="block">Indicates if this map contains a mapping for the specified key.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/util/CachedMap.html#containsValue-java.lang.Object-">containsValue</a></span>(java.lang.Object value)</code>
<div class="block">Returns <code>true</code> if this map maps one or more keys to the
specified value.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.Set</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/util/CachedMap.html#entrySet--">entrySet</a></span>()</code>
<div class="block">Returns an <b>unmodifiable</b> view of the mappings contained in this
map.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/util/CachedMap.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code>
<div class="block">Compares the specified object with this map for equality.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/util/CachedMap.html#flush--">flush</a></span>()</code>
<div class="block">Flushes the key/value pairs being cached.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/util/CachedMap.html#get-java.lang.Object-">get</a></span>(java.lang.Object key)</code>
<div class="block">Returns the value to which this map maps the specified key.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.util.Map</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/util/CachedMap.html#getBackingMap--">getBackingMap</a></span>()</code>
<div class="block">Returns the backing map.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/util/CachedMap.html#getCacheSize--">getCacheSize</a></span>()</code>
<div class="block">Returns the actual cache size.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/util/CachedMap.html#hashCode--">hashCode</a></span>()</code>
<div class="block">Returns the hash code value for this map.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/util/CachedMap.html#isEmpty--">isEmpty</a></span>()</code>
<div class="block">Returns <code>true</code> if this map contains no key-value mappings.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.util.Set</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/util/CachedMap.html#keySet--">keySet</a></span>()</code>
<div class="block">Returns an <b>unmodifiable</b> view of the keys contained in this
map.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/util/CachedMap.html#put-java.lang.Object-java.lang.Object-">put</a></span>(java.lang.Object key,
java.lang.Object value)</code>
<div class="block">Associates the specified value with the specified key in this map.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/util/CachedMap.html#putAll-java.util.Map-">putAll</a></span>(java.util.Map map)</code>
<div class="block">Copies all of the mappings from the specified map to this map
(optional operation).</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/util/CachedMap.html#remove-java.lang.Object-">remove</a></span>(java.lang.Object key)</code>
<div class="block">Removes the mapping for this key from this map if it is present.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/util/CachedMap.html#size--">size</a></span>()</code>
<div class="block">Returns the number of key-value mappings in this map.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.util.Collection</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/util/CachedMap.html#values--">values</a></span>()</code>
<div class="block">Returns an <b>unmodifiable</b> view of the values contained in this map.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</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>compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CachedMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CachedMap</h4>
<pre>public CachedMap()</pre>
<div class="block">Creates a cached map backed by a <a href="../../../../org/codehaus/plexus/util/FastMap.html" title="class in org.codehaus.plexus.util"><code>FastMap</code></a>.
The default cache size and map capacity is set to <code>256</code>
entries.</div>
</li>
</ul>
<a name="CachedMap-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CachedMap</h4>
<pre>public CachedMap(int cacheSize)</pre>
<div class="block">Creates a cached map backed by a <a href="../../../../org/codehaus/plexus/util/FastMap.html" title="class in org.codehaus.plexus.util"><code>FastMap</code></a> and having the
specified cache size.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cacheSize</code> - the cache size, the actual cache size is the
first power of 2 greater or equal to <code>cacheSize</code>.
This is also the initial capacity of the backing map.</dd>
</dl>
</li>
</ul>
<a name="CachedMap-int-java.util.Map-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CachedMap</h4>
<pre>public CachedMap(int cacheSize,
java.util.Map backingMap)</pre>
<div class="block">Creates a cached map backed by the specified map and having the specified
cache size. In order to maitain cache veracity, it is critical
that <b>all</b> update to the backing map is accomplished through the
<a href="../../../../org/codehaus/plexus/util/CachedMap.html" title="class in org.codehaus.plexus.util"><code>CachedMap</code></a> instance; otherwise <a href="../../../../org/codehaus/plexus/util/CachedMap.html#flush--"><code>flush()</code></a> has to be called.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cacheSize</code> - the cache size, the actual cache size is the
first power of 2 greater or equal to <code>cacheSize</code>.</dd>
<dd><code>backingMap</code> - the backing map to be "wrapped" in a cached map.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getCacheSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheSize</h4>
<pre>public int getCacheSize()</pre>
<div class="block">Returns the actual cache size.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the cache size (power of 2).</dd>
</dl>
</li>
</ul>
<a name="getBackingMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBackingMap</h4>
<pre>public java.util.Map getBackingMap()</pre>
<div class="block">Returns the backing map. If the backing map is modified directly,
this <a href="../../../../org/codehaus/plexus/util/CachedMap.html" title="class in org.codehaus.plexus.util"><code>CachedMap</code></a> has to be flushed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the backing map.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/codehaus/plexus/util/CachedMap.html#flush--"><code>flush()</code></a></dd>
</dl>
</li>
</ul>
<a name="flush--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flush</h4>
<pre>public void flush()</pre>
<div class="block">Flushes the key/value pairs being cached. This method should be called
if the backing map is externally modified.</div>
</li>
</ul>
<a name="get-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public java.lang.Object get(java.lang.Object key)</pre>
<div class="block">Returns the value to which this map maps the specified key.
First, the cache is being checked, then if the cache does not contains
the specified key, the backing map is accessed and the key/value
pair is stored in the cache.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>get</code> in interface <code>java.util.Map</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key whose associated value is to be returned.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value to which this map maps the specified key, or
<code>null</code> if the map contains no mapping for this key.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.ClassCastException</code> - if the key is of an inappropriate type for
the backing map (optional).</dd>
<dd><code>java.lang.NullPointerException</code> - if the key is <code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="put-java.lang.Object-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>public java.lang.Object put(java.lang.Object key,
java.lang.Object value)</pre>
<div class="block">Associates the specified value with the specified key in this map.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>put</code> in interface <code>java.util.Map</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key with which the specified value is to be associated.</dd>
<dd><code>value</code> - the value to be associated with the specified key.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the previous value associated with specified key, or
<code>null</code> if there was no mapping for the key.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.UnsupportedOperationException</code> - if the <code>put</code> operation
is not supported by the backing map.</dd>
<dd><code>java.lang.ClassCastException</code> - if the class of the specified key or value
prevents it from being stored in this map.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if some aspect of this key or value
prevents it from being stored in this map.</dd>
<dd><code>java.lang.NullPointerException</code> - if the key is <code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="remove-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>public java.lang.Object remove(java.lang.Object key)</pre>
<div class="block">Removes the mapping for this key from this map if it is present.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>remove</code> in interface <code>java.util.Map</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - key whose mapping is to be removed from the map.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>previous value associated with specified key,
or <code>null</code> if there was no mapping for key.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.ClassCastException</code> - if the key is of an inappropriate type for
the backing map (optional).</dd>
<dd><code>java.lang.NullPointerException</code> - if the key is <code>null</code>.</dd>
<dd><code>java.lang.UnsupportedOperationException</code> - if the <code>remove</code> method
is not supported by the backing map.</dd>
</dl>
</li>
</ul>
<a name="containsKey-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containsKey</h4>
<pre>public boolean containsKey(java.lang.Object key)</pre>
<div class="block">Indicates if this map contains a mapping for the specified key.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>containsKey</code> in interface <code>java.util.Map</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key whose presence in this map is to be tested.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this map contains a mapping for the
specified key; <code>false</code> otherwise.</dd>
</dl>
</li>
</ul>
<a name="size--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>public int size()</pre>
<div class="block">Returns the number of key-value mappings in this map. If the
map contains more than <code>Integer.MAX_VALUE</code> elements,
returns <code>Integer.MAX_VALUE</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>size</code> in interface <code>java.util.Map</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of key-value mappings in this map.</dd>
</dl>
</li>
</ul>
<a name="isEmpty--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmpty</h4>
<pre>public boolean isEmpty()</pre>
<div class="block">Returns <code>true</code> if this map contains no key-value mappings.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>isEmpty</code> in interface <code>java.util.Map</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this map contains no key-value mappings.</dd>
</dl>
</li>
</ul>
<a name="containsValue-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containsValue</h4>
<pre>public boolean containsValue(java.lang.Object value)</pre>
<div class="block">Returns <code>true</code> if this map maps one or more keys to the
specified value.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>containsValue</code> in interface <code>java.util.Map</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - value whose presence in this map is to be tested.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this map maps one or more keys to the
specified value.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.ClassCastException</code> - if the value is of an inappropriate type for
the backing map (optional).</dd>
<dd><code>java.lang.NullPointerException</code> - if the value is <code>null</code> and the
backing map does not not permit <code>null</code> values.</dd>
</dl>
</li>
</ul>
<a name="putAll-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putAll</h4>
<pre>public void putAll(java.util.Map map)</pre>
<div class="block">Copies all of the mappings from the specified map to this map
(optional operation). This method automatically flushes the cache.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>putAll</code> in interface <code>java.util.Map</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>map</code> - the mappings to be stored in this map.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.UnsupportedOperationException</code> - if the <code>putAll</code> method
is not supported by the backing map.</dd>
<dd><code>java.lang.ClassCastException</code> - if the class of a key or value in the
specified map prevents it from being stored in this map.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - some aspect of a key or value in the
specified map prevents it from being stored in this map.</dd>
<dd><code>java.lang.NullPointerException</code> - the specified map is <code>null</code>, or
if the backing map does not permit <code>null</code> keys or
values, and the specified map contains <code>null</code> keys or
values.</dd>
</dl>
</li>
</ul>
<a name="clear--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>public void clear()</pre>
<div class="block">Removes all mappings from this map (optional operation). This method
automatically flushes the cache.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>clear</code> in interface <code>java.util.Map</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.UnsupportedOperationException</code> - if clear is not supported by the
backing map.</dd>
</dl>
</li>
</ul>
<a name="keySet--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keySet</h4>
<pre>public java.util.Set keySet()</pre>
<div class="block">Returns an <b>unmodifiable</b> view of the keys contained in this
map.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>keySet</code> in interface <code>java.util.Map</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an unmodifiable view of the keys contained in this map.</dd>
</dl>
</li>
</ul>
<a name="values--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</h4>
<pre>public java.util.Collection values()</pre>
<div class="block">Returns an <b>unmodifiable</b> view of the values contained in this map.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>values</code> in interface <code>java.util.Map</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an unmodifiable view of the values contained in this map.</dd>
</dl>
</li>
</ul>
<a name="entrySet--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>entrySet</h4>
<pre>public java.util.Set entrySet()</pre>
<div class="block">Returns an <b>unmodifiable</b> view of the mappings contained in this
map. Each element in the returned set is a <code>Map.Entry</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>entrySet</code> in interface <code>java.util.Map</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an unmodifiable view of the mappings contained in this map.</dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public boolean equals(java.lang.Object o)</pre>
<div class="block">Compares the specified object with this map for equality. Returns
<tt>true</tt> if the given object is also a map and the two Maps
represent the same mappings.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>equals</code> in interface <code>java.util.Map</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>o</code> - object to be compared for equality with this map.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the specified object is equal to this map.</dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hashCode</h4>
<pre>public int hashCode()</pre>
<div class="block">Returns the hash code value for this map.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>hashCode</code> in interface <code>java.util.Map</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the hash code value for 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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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="../../../../org/codehaus/plexus/util/Base64.html" title="class in org.codehaus.plexus.util"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/codehaus/plexus/util/CollectionUtils.html" title="class in org.codehaus.plexus.util"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/codehaus/plexus/util/CachedMap.html" target="_top">Frames</a></li>
<li><a href="CachedMap.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><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|