/usr/share/doc/libcommons-collections-java/api/org/apache/commons/collections/MapUtils.html is in libcommons-collections-java-doc 2.1.1-11.
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 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 | <!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_21) on Mon Apr 29 13:52:00 UTC 2013 -->
<title>MapUtils (Jakarta Commons Collections Package)</title>
<meta name="date" content="2013-04-29">
<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="MapUtils (Jakarta Commons Collections Package)";
}
//-->
</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="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/commons/collections/LRUMap.html" title="class in org.apache.commons.collections"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/commons/collections/MultiHashMap.html" title="class in org.apache.commons.collections"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/commons/collections/MapUtils.html" target="_top">Frames</a></li>
<li><a href="MapUtils.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.apache.commons.collections</div>
<h2 title="Class MapUtils" class="title">Class MapUtils</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.commons.collections.MapUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">MapUtils</span>
extends java.lang.Object</pre>
<div class="block">A helper class for using <code>Map</code> instances.<P>
It contains various typesafe methods
as well as other useful features like deep copying.<P>
It also provides the following decorators:
<UL>
<LI><a href="../../../../org/apache/commons/collections/MapUtils.html#fixedSizeMap(java.util.Map)"><code>fixedSizeMap(Map)</code></a>
<LI><a href="../../../../org/apache/commons/collections/MapUtils.html#fixedSizeSortedMap(java.util.SortedMap)"><code>fixedSizeSortedMap(SortedMap)</code></a>
<LI><a href="../../../../org/apache/commons/collections/MapUtils.html#lazyMap(java.util.Map, org.apache.commons.collections.Factory)"><code>lazyMap(Map,Factory)</code></a>
<LI><a href="../../../../org/apache/commons/collections/MapUtils.html#lazySortedMap(java.util.SortedMap, org.apache.commons.collections.Factory)"><code>lazySortedMap(SortedMap,Factory)</code></a>
<LI><a href="../../../../org/apache/commons/collections/MapUtils.html#predicatedMap(java.util.Map, org.apache.commons.collections.Predicate, org.apache.commons.collections.Predicate)"><code>predicatedMap(Map,Predicate,Predicate)</code></a>
<LI><a href="../../../../org/apache/commons/collections/MapUtils.html#predicatedSortedMap(java.util.SortedMap, org.apache.commons.collections.Predicate, org.apache.commons.collections.Predicate)"><code>predicatedSortedMap(SortedMap,Predicate,Predicate)</code></a>
</UL></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.0</dd>
<dt><span class="strong">Author:</span></dt>
<dd><a href="mailto:jstrachan@apache.org">James Strachan</a>, <a href="mailto:nissim@nksystems.com">Nissim Karpenstein</a>, <a href="mailto:knielsen@apache.org">Kasper Nielsen</a>, Paul Jack, Stephen Colebourne</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" 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><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#MapUtils()">MapUtils</a></strong>()</code>
<div class="block">Please don't instantiate a <Code>MapUtils</Code>.</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="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>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#debugPrint(java.io.PrintStream, java.lang.Object, java.util.Map)">debugPrint</a></strong>(java.io.PrintStream out,
java.lang.Object key,
java.util.Map map)</code>
<div class="block">Prints the given map with nice line breaks.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#debugPrintIndent(java.io.PrintStream)">debugPrintIndent</a></strong>(java.io.PrintStream out)</code>
<div class="block">Writes indentation to the given stream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.Map</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#fixedSizeMap(java.util.Map)">fixedSizeMap</a></strong>(java.util.Map map)</code>
<div class="block">Returns a fixed-sized map backed by the given map.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.SortedMap</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#fixedSizeSortedMap(java.util.SortedMap)">fixedSizeSortedMap</a></strong>(java.util.SortedMap map)</code>
<div class="block">Returns a fixed-sized sorted map backed by the given sorted map.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.Boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#getBoolean(java.util.Map, java.lang.Object)">getBoolean</a></strong>(java.util.Map map,
java.lang.Object key)</code>
<div class="block">Looks up the given key in the given map, converting the result into
a <code>Boolean</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.Boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#getBoolean(java.util.Map, java.lang.Object, java.lang.Boolean)">getBoolean</a></strong>(java.util.Map map,
java.lang.Object key,
java.lang.Boolean defaultValue)</code>
<div class="block">Looks up the given key in the given map, converting the result into
a boolean, using the default value if the the conversion fails.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.Byte</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#getByte(java.util.Map, java.lang.Object)">getByte</a></strong>(java.util.Map map,
java.lang.Object key)</code>
<div class="block">Looks up the given key in the given map, converting the result into
a <code>Byte</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.Byte</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#getByte(java.util.Map, java.lang.Object, java.lang.Byte)">getByte</a></strong>(java.util.Map map,
java.lang.Object key,
java.lang.Byte defaultValue)</code>
<div class="block">Looks up the given key in the given map, converting the result into
a byte, using the default value if the the conversion fails.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.Double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#getDouble(java.util.Map, java.lang.Object)">getDouble</a></strong>(java.util.Map map,
java.lang.Object key)</code>
<div class="block">Looks up the given key in the given map, converting the result into
a <code>Double</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.Double</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#getDouble(java.util.Map, java.lang.Object, java.lang.Double)">getDouble</a></strong>(java.util.Map map,
java.lang.Object key,
java.lang.Double defaultValue)</code>
<div class="block">Looks up the given key in the given map, converting the result into
a double, using the default value if the the conversion fails.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.Float</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#getFloat(java.util.Map, java.lang.Object)">getFloat</a></strong>(java.util.Map map,
java.lang.Object key)</code>
<div class="block">Looks up the given key in the given map, converting the result into
a <code>Float</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.Float</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#getFloat(java.util.Map, java.lang.Object, java.lang.Float)">getFloat</a></strong>(java.util.Map map,
java.lang.Object key,
java.lang.Float defaultValue)</code>
<div class="block">Looks up the given key in the given map, converting the result into
a float, using the default value if the the conversion fails.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.Integer</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#getInteger(java.util.Map, java.lang.Object)">getInteger</a></strong>(java.util.Map map,
java.lang.Object key)</code>
<div class="block">Looks up the given key in the given map, converting the result into
an <code>Integer</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.Integer</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#getInteger(java.util.Map, java.lang.Object, java.lang.Integer)">getInteger</a></strong>(java.util.Map map,
java.lang.Object key,
java.lang.Integer defaultValue)</code>
<div class="block">Looks up the given key in the given map, converting the result into
an integer, using the default value if the the conversion fails.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.Long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#getLong(java.util.Map, java.lang.Object)">getLong</a></strong>(java.util.Map map,
java.lang.Object key)</code>
<div class="block">Looks up the given key in the given map, converting the result into
a <code>Long</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.Long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#getLong(java.util.Map, java.lang.Object, java.lang.Long)">getLong</a></strong>(java.util.Map map,
java.lang.Object key,
java.lang.Long defaultValue)</code>
<div class="block">Looks up the given key in the given map, converting the result into
a long, using the default value if the the conversion fails.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.Map</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#getMap(java.util.Map, java.lang.Object)">getMap</a></strong>(java.util.Map map,
java.lang.Object key)</code>
<div class="block">Looks up the given key in the given map, returning another map.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.Map</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#getMap(java.util.Map, java.lang.Object, java.util.Map)">getMap</a></strong>(java.util.Map map,
java.lang.Object key,
java.util.Map defaultValue)</code>
<div class="block">Looks up the given key in the given map, converting the result into
a map, using the default value if the the conversion fails.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.Number</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)">getNumber</a></strong>(java.util.Map map,
java.lang.Object key)</code>
<div class="block">Looks up the given key in the given map, converting the result into
a <code>Number</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.Number</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object, java.lang.Number)">getNumber</a></strong>(java.util.Map map,
java.lang.Object key,
java.lang.Number defaultValue)</code>
<div class="block">Looks up the given key in the given map, converting the result into
a number, using the default value if the the conversion fails.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#getObject(java.util.Map, java.lang.Object)">getObject</a></strong>(java.util.Map map,
java.lang.Object key)</code>
<div class="block">Synonym for <code>Map.get(Object)</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#getObject(java.util.Map, java.lang.Object, java.lang.Object)">getObject</a></strong>(java.util.Map map,
java.lang.Object key,
java.lang.Object defaultValue)</code>
<div class="block">Looks up the given key in the given map, converting null into the
given default value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.Short</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#getShort(java.util.Map, java.lang.Object)">getShort</a></strong>(java.util.Map map,
java.lang.Object key)</code>
<div class="block">Looks up the given key in the given map, converting the result into
a <code>Short</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.Short</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#getShort(java.util.Map, java.lang.Object, java.lang.Short)">getShort</a></strong>(java.util.Map map,
java.lang.Object key,
java.lang.Short defaultValue)</code>
<div class="block">Looks up the given key in the given map, converting the result into
a short, using the default value if the the conversion fails.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#getString(java.util.Map, java.lang.Object)">getString</a></strong>(java.util.Map map,
java.lang.Object key)</code>
<div class="block">Looks up the given key in the given map, converting the result into
a string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#getString(java.util.Map, java.lang.Object, java.lang.String)">getString</a></strong>(java.util.Map map,
java.lang.Object key,
java.lang.String defaultValue)</code>
<div class="block">Looks up the given key in the given map, converting the result into
a string, using the default value if the the conversion fails.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.Map</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#lazyMap(java.util.Map, org.apache.commons.collections.Factory)">lazyMap</a></strong>(java.util.Map map,
<a href="../../../../org/apache/commons/collections/Factory.html" title="interface in org.apache.commons.collections">Factory</a> factory)</code>
<div class="block">Returns a "lazy" map whose values will be created on demand.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.SortedMap</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#lazySortedMap(java.util.SortedMap, org.apache.commons.collections.Factory)">lazySortedMap</a></strong>(java.util.SortedMap map,
<a href="../../../../org/apache/commons/collections/Factory.html" title="interface in org.apache.commons.collections">Factory</a> factory)</code>
<div class="block">Returns a "lazy" sorted map whose values will be created on demand.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#logInfo(java.lang.Exception)">logInfo</a></strong>(java.lang.Exception e)</code>
<div class="block">Logs the given exception to <Code>System.out</Code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.Map</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#predicatedMap(java.util.Map, org.apache.commons.collections.Predicate, org.apache.commons.collections.Predicate)">predicatedMap</a></strong>(java.util.Map map,
<a href="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</a> keyPred,
<a href="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</a> valuePred)</code>
<div class="block">Returns a predicated map backed by the given map.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.SortedMap</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#predicatedSortedMap(java.util.SortedMap, org.apache.commons.collections.Predicate, org.apache.commons.collections.Predicate)">predicatedSortedMap</a></strong>(java.util.SortedMap map,
<a href="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</a> keyPred,
<a href="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</a> valuePred)</code>
<div class="block">Returns a predicated sorted map backed by the given map.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#safeAddToMap(java.util.Map, java.lang.Object, java.lang.Object)">safeAddToMap</a></strong>(java.util.Map map,
java.lang.Object key,
java.lang.Object value)</code>
<div class="block">Nice method for adding data to a map in such a way
as to not get NPE's.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.Properties</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#toProperties(java.util.Map)">toProperties</a></strong>(java.util.Map map)</code>
<div class="block">Gets a new Properties object initialised with the values from a Map.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/MapUtils.html#verbosePrint(java.io.PrintStream, java.lang.Object, java.util.Map)">verbosePrint</a></strong>(java.io.PrintStream out,
java.lang.Object key,
java.util.Map map)</code>
<div class="block">Prints the given map with nice line breaks.</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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="MapUtils()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MapUtils</h4>
<pre>public MapUtils()</pre>
<div class="block">Please don't instantiate a <Code>MapUtils</Code>.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="debugPrint(java.io.PrintStream, java.lang.Object, java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>debugPrint</h4>
<pre>public static void debugPrint(java.io.PrintStream out,
java.lang.Object key,
java.util.Map map)</pre>
<div class="block">Prints the given map with nice line breaks.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - the stream to print to</dd><dd><code>key</code> - the key that maps to the map in some other map</dd><dd><code>map</code> - the map to print</dd></dl>
</li>
</ul>
<a name="debugPrintIndent(java.io.PrintStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>debugPrintIndent</h4>
<pre>protected static void debugPrintIndent(java.io.PrintStream out)</pre>
<div class="block">Writes indentation to the given stream.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - the stream to indent</dd></dl>
</li>
</ul>
<a name="fixedSizeMap(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fixedSizeMap</h4>
<pre>public static java.util.Map fixedSizeMap(java.util.Map map)</pre>
<div class="block">Returns a fixed-sized map backed by the given map.
Elements may not be added or removed from the returned map, but
existing elements can be changed (for instance, via the
<code>Map.put(Object,Object)</code> method).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose size to fix, must not be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>a fixed-size map backed by that map</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the Map is null</dd></dl>
</li>
</ul>
<a name="fixedSizeSortedMap(java.util.SortedMap)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fixedSizeSortedMap</h4>
<pre>public static java.util.SortedMap fixedSizeSortedMap(java.util.SortedMap map)</pre>
<div class="block">Returns a fixed-sized sorted map backed by the given sorted map.
Elements may not be added or removed from the returned map, but
existing elements can be changed (for instance, via the
<code>Map.put(Object,Object)</code> method).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose size to fix, must not be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>a fixed-size map backed by that map</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the SortedMap is null</dd></dl>
</li>
</ul>
<a name="getBoolean(java.util.Map, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBoolean</h4>
<pre>public static java.lang.Boolean getBoolean(java.util.Map map,
java.lang.Object key)</pre>
<div class="block">Looks up the given key in the given map, converting the result into
a <code>Boolean</code>. If the map is null, this method returns null.
If the value mapped by the given key is a
<code>Boolean</code>, then it is returned as-is. Otherwise, if the value
is a string, then if that string ignoring case equals "true", then
a true <code>Boolean</code> is returned. Any other string value will
result in a false <code>Boolean</code> being returned. OR, if the value
is a <code>Number</code>, and that <code>Number</code> is 0, then a false
<code>Boolean</code> is returned. Any other <code>Number</code> value results
in a true <code>Boolean</code> being returned.<P>
Any value that is not a <code>Boolean</code>, <code>String</code> or
<code>Number</code> results in null being returned.<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose value to look up</dd><dd><code>key</code> - the key whose value to look up in that map</dd>
<dt><span class="strong">Returns:</span></dt><dd>a <code>Boolean</code> or null</dd></dl>
</li>
</ul>
<a name="getBoolean(java.util.Map, java.lang.Object, java.lang.Boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBoolean</h4>
<pre>public static java.lang.Boolean getBoolean(java.util.Map map,
java.lang.Object key,
java.lang.Boolean defaultValue)</pre>
<div class="block">Looks up the given key in the given map, converting the result into
a boolean, using the default value if the the conversion fails.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose value to look up</dd><dd><code>key</code> - the key of the value to look up in that map</dd><dd><code>defaultValue</code> - what to return if the value is null or if the
conversion fails</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value in the map as a boolean, or defaultValue if the
original value is null, the map is null or the boolean conversion
fails</dd></dl>
</li>
</ul>
<a name="getByte(java.util.Map, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getByte</h4>
<pre>public static java.lang.Byte getByte(java.util.Map map,
java.lang.Object key)</pre>
<div class="block">Looks up the given key in the given map, converting the result into
a <code>Byte</code>. First, <a href="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><code>getNumber(Map,Object)</code></a> is invoked.
If the result is null, then null is returned. Otherwise, the
byte value of the resulting <code>Number</code> is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose value to look up</dd><dd><code>key</code> - the key whose value to look up in that map</dd>
<dt><span class="strong">Returns:</span></dt><dd>a <code>Byte</code> or null</dd></dl>
</li>
</ul>
<a name="getByte(java.util.Map, java.lang.Object, java.lang.Byte)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getByte</h4>
<pre>public static java.lang.Byte getByte(java.util.Map map,
java.lang.Object key,
java.lang.Byte defaultValue)</pre>
<div class="block">Looks up the given key in the given map, converting the result into
a byte, using the default value if the the conversion fails.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose value to look up</dd><dd><code>key</code> - the key of the value to look up in that map</dd><dd><code>defaultValue</code> - what to return if the value is null or if the
conversion fails</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value in the map as a number, or defaultValue if the
original value is null, the map is null or the number conversion
fails</dd></dl>
</li>
</ul>
<a name="getDouble(java.util.Map, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDouble</h4>
<pre>public static java.lang.Double getDouble(java.util.Map map,
java.lang.Object key)</pre>
<div class="block">Looks up the given key in the given map, converting the result into
a <code>Double</code>. First, <a href="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><code>getNumber(Map,Object)</code></a> is invoked.
If the result is null, then null is returned. Otherwise, the
double value of the resulting <code>Number</code> is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose value to look up</dd><dd><code>key</code> - the key whose value to look up in that map</dd>
<dt><span class="strong">Returns:</span></dt><dd>a <code>Double</code> or null</dd></dl>
</li>
</ul>
<a name="getDouble(java.util.Map, java.lang.Object, java.lang.Double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDouble</h4>
<pre>public static java.lang.Double getDouble(java.util.Map map,
java.lang.Object key,
java.lang.Double defaultValue)</pre>
<div class="block">Looks up the given key in the given map, converting the result into
a double, using the default value if the the conversion fails.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose value to look up</dd><dd><code>key</code> - the key of the value to look up in that map</dd><dd><code>defaultValue</code> - what to return if the value is null or if the
conversion fails</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value in the map as a number, or defaultValue if the
original value is null, the map is null or the number conversion
fails</dd></dl>
</li>
</ul>
<a name="getFloat(java.util.Map, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFloat</h4>
<pre>public static java.lang.Float getFloat(java.util.Map map,
java.lang.Object key)</pre>
<div class="block">Looks up the given key in the given map, converting the result into
a <code>Float</code>. First, <a href="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><code>getNumber(Map,Object)</code></a> is invoked.
If the result is null, then null is returned. Otherwise, the
float value of the resulting <code>Number</code> is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose value to look up</dd><dd><code>key</code> - the key whose value to look up in that map</dd>
<dt><span class="strong">Returns:</span></dt><dd>a <code>Float</code> or null</dd></dl>
</li>
</ul>
<a name="getFloat(java.util.Map, java.lang.Object, java.lang.Float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFloat</h4>
<pre>public static java.lang.Float getFloat(java.util.Map map,
java.lang.Object key,
java.lang.Float defaultValue)</pre>
<div class="block">Looks up the given key in the given map, converting the result into
a float, using the default value if the the conversion fails.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose value to look up</dd><dd><code>key</code> - the key of the value to look up in that map</dd><dd><code>defaultValue</code> - what to return if the value is null or if the
conversion fails</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value in the map as a number, or defaultValue if the
original value is null, the map is null or the number conversion
fails</dd></dl>
</li>
</ul>
<a name="getInteger(java.util.Map, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInteger</h4>
<pre>public static java.lang.Integer getInteger(java.util.Map map,
java.lang.Object key)</pre>
<div class="block">Looks up the given key in the given map, converting the result into
an <code>Integer</code>. First, <a href="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><code>getNumber(Map,Object)</code></a> is invoked.
If the result is null, then null is returned. Otherwise, the
integer value of the resulting <code>Number</code> is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose value to look up</dd><dd><code>key</code> - the key whose value to look up in that map</dd>
<dt><span class="strong">Returns:</span></dt><dd>an <code>Integer</code> or null</dd></dl>
</li>
</ul>
<a name="getInteger(java.util.Map, java.lang.Object, java.lang.Integer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInteger</h4>
<pre>public static java.lang.Integer getInteger(java.util.Map map,
java.lang.Object key,
java.lang.Integer defaultValue)</pre>
<div class="block">Looks up the given key in the given map, converting the result into
an integer, using the default value if the the conversion fails.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose value to look up</dd><dd><code>key</code> - the key of the value to look up in that map</dd><dd><code>defaultValue</code> - what to return if the value is null or if the
conversion fails</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value in the map as a number, or defaultValue if the
original value is null, the map is null or the number conversion
fails</dd></dl>
</li>
</ul>
<a name="getLong(java.util.Map, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLong</h4>
<pre>public static java.lang.Long getLong(java.util.Map map,
java.lang.Object key)</pre>
<div class="block">Looks up the given key in the given map, converting the result into
a <code>Long</code>. First, <a href="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><code>getNumber(Map,Object)</code></a> is invoked.
If the result is null, then null is returned. Otherwise, the
long value of the resulting <code>Number</code> is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose value to look up</dd><dd><code>key</code> - the key whose value to look up in that map</dd>
<dt><span class="strong">Returns:</span></dt><dd>a <code>Long</code> or null</dd></dl>
</li>
</ul>
<a name="getLong(java.util.Map, java.lang.Object, java.lang.Long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLong</h4>
<pre>public static java.lang.Long getLong(java.util.Map map,
java.lang.Object key,
java.lang.Long defaultValue)</pre>
<div class="block">Looks up the given key in the given map, converting the result into
a long, using the default value if the the conversion fails.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose value to look up</dd><dd><code>key</code> - the key of the value to look up in that map</dd><dd><code>defaultValue</code> - what to return if the value is null or if the
conversion fails</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value in the map as a number, or defaultValue if the
original value is null, the map is null or the number conversion
fails</dd></dl>
</li>
</ul>
<a name="getMap(java.util.Map, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMap</h4>
<pre>public static java.util.Map getMap(java.util.Map map,
java.lang.Object key)</pre>
<div class="block">Looks up the given key in the given map, returning another map.
If the given map is null or if the given key doesn't map to another
map, then this method returns null. Otherwise the mapped map is
returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose value to look up</dd><dd><code>key</code> - the key whose value to look up in that map</dd>
<dt><span class="strong">Returns:</span></dt><dd>a <code>Map</code> or null</dd></dl>
</li>
</ul>
<a name="getMap(java.util.Map, java.lang.Object, java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMap</h4>
<pre>public static java.util.Map getMap(java.util.Map map,
java.lang.Object key,
java.util.Map defaultValue)</pre>
<div class="block">Looks up the given key in the given map, converting the result into
a map, using the default value if the the conversion fails.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose value to look up</dd><dd><code>key</code> - the key of the value to look up in that map</dd><dd><code>defaultValue</code> - what to return if the value is null or if the
conversion fails</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value in the map as a number, or defaultValue if the
original value is null, the map is null or the map conversion
fails</dd></dl>
</li>
</ul>
<a name="getNumber(java.util.Map, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumber</h4>
<pre>public static java.lang.Number getNumber(java.util.Map map,
java.lang.Object key)</pre>
<div class="block">Looks up the given key in the given map, converting the result into
a <code>Number</code>. If the map is null, this method returns null.
Otherwise, if the key maps to a <code>Number</code>, then that number
is returned as-is. Otherwise, if the key maps to a <code>String</code>,
that string is parsed into a number using the system default
<code>NumberFormat</code>.<P>
If the value is not a <code>Number</code> or a <code>String</code>, or if
the value is a <code>String</code> that cannot be parsed into a
<code>Number</code>, then null is returned.<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose value to look up</dd><dd><code>key</code> - the key whose value to look up in that map</dd>
<dt><span class="strong">Returns:</span></dt><dd>a <code>Number</code> or null</dd></dl>
</li>
</ul>
<a name="getNumber(java.util.Map, java.lang.Object, java.lang.Number)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumber</h4>
<pre>public static java.lang.Number getNumber(java.util.Map map,
java.lang.Object key,
java.lang.Number defaultValue)</pre>
<div class="block">Looks up the given key in the given map, converting the result into
a number, using the default value if the the conversion fails.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose value to look up</dd><dd><code>key</code> - the key of the value to look up in that map</dd><dd><code>defaultValue</code> - what to return if the value is null or if the
conversion fails</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value in the map as a number, or defaultValue if the
original value is null, the map is null or the number conversion
fails</dd></dl>
</li>
</ul>
<a name="getObject(java.util.Map, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObject</h4>
<pre>public static java.lang.Object getObject(java.util.Map map,
java.lang.Object key)</pre>
<div class="block">Synonym for <code>Map.get(Object)</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose value to look up</dd><dd><code>key</code> - the key whose value to look up in that map</dd>
<dt><span class="strong">Returns:</span></dt><dd>null if the map is null; or the result of
<Code>map.get(key)</Code></dd></dl>
</li>
</ul>
<a name="getObject(java.util.Map, java.lang.Object, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObject</h4>
<pre>public static java.lang.Object getObject(java.util.Map map,
java.lang.Object key,
java.lang.Object defaultValue)</pre>
<div class="block">Looks up the given key in the given map, converting null into the
given default value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose value to look up</dd><dd><code>key</code> - the key of the value to look up in that map</dd><dd><code>defaultValue</code> - what to return if the value is null</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value in the map, or defaultValue if the original value
is null or the map is null</dd></dl>
</li>
</ul>
<a name="getShort(java.util.Map, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getShort</h4>
<pre>public static java.lang.Short getShort(java.util.Map map,
java.lang.Object key)</pre>
<div class="block">Looks up the given key in the given map, converting the result into
a <code>Short</code>. First, <a href="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><code>getNumber(Map,Object)</code></a> is invoked.
If the result is null, then null is returned. Otherwise, the
short value of the resulting <code>Number</code> is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose value to look up</dd><dd><code>key</code> - the key whose value to look up in that map</dd>
<dt><span class="strong">Returns:</span></dt><dd>a <code>Short</code> or null</dd></dl>
</li>
</ul>
<a name="getShort(java.util.Map, java.lang.Object, java.lang.Short)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getShort</h4>
<pre>public static java.lang.Short getShort(java.util.Map map,
java.lang.Object key,
java.lang.Short defaultValue)</pre>
<div class="block">Looks up the given key in the given map, converting the result into
a short, using the default value if the the conversion fails.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose value to look up</dd><dd><code>key</code> - the key of the value to look up in that map</dd><dd><code>defaultValue</code> - what to return if the value is null or if the
conversion fails</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value in the map as a number, or defaultValue if the
original value is null, the map is null or the number conversion
fails</dd></dl>
</li>
</ul>
<a name="getString(java.util.Map, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getString</h4>
<pre>public static java.lang.String getString(java.util.Map map,
java.lang.Object key)</pre>
<div class="block">Looks up the given key in the given map, converting the result into
a string.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose value to look up</dd><dd><code>key</code> - the key whose value to look up in that map</dd>
<dt><span class="strong">Returns:</span></dt><dd>null if the map is null; null if the value mapped by that
key is null; or the <Code>toString()</Code>
result of the value for that key</dd></dl>
</li>
</ul>
<a name="getString(java.util.Map, java.lang.Object, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getString</h4>
<pre>public static java.lang.String getString(java.util.Map map,
java.lang.Object key,
java.lang.String defaultValue)</pre>
<div class="block">Looks up the given key in the given map, converting the result into
a string, using the default value if the the conversion fails.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map whose value to look up</dd><dd><code>key</code> - the key of the value to look up in that map</dd><dd><code>defaultValue</code> - what to return if the value is null or if the
conversion fails</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value in the map as a string, or defaultValue if the
original value is null, the map is null or the string conversion
fails</dd></dl>
</li>
</ul>
<a name="lazyMap(java.util.Map, org.apache.commons.collections.Factory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lazyMap</h4>
<pre>public static java.util.Map lazyMap(java.util.Map map,
<a href="../../../../org/apache/commons/collections/Factory.html" title="interface in org.apache.commons.collections">Factory</a> factory)</pre>
<div class="block">Returns a "lazy" map whose values will be created on demand.<P>
<p>
When the key passed to the returned map's <code>Map.get(Object)</code>
method is not present in the map, then the factory will be used
to create a new object and that object will become the value
associated with that key.
<p>
For instance:
<pre>
Factory factory = new Factory() {
public Object create() {
return new Date();
}
}
Map lazy = MapUtils.lazyMap(new HashMap(), factory);
Object obj = lazy.get("test");
</pre>
After the above code is executed, <code>obj</code> will contain
a new <code>Date</code> instance. Furthermore, that <code>Date</code>
instance is the value for the <code>test</code> key.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map to make lazy, must not be null</dd><dd><code>factory</code> - the factory for creating new objects, must not be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>a lazy map backed by the given map</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the Map or Factory is null</dd></dl>
</li>
</ul>
<a name="lazySortedMap(java.util.SortedMap, org.apache.commons.collections.Factory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lazySortedMap</h4>
<pre>public static java.util.SortedMap lazySortedMap(java.util.SortedMap map,
<a href="../../../../org/apache/commons/collections/Factory.html" title="interface in org.apache.commons.collections">Factory</a> factory)</pre>
<div class="block">Returns a "lazy" sorted map whose values will be created on demand.
<p>
When the key passed to the returned map's <code>Map.get(Object)</code>
method is not present in the map, then the factory will be used
to create a new object and that object will become the value
associated with that key.
<p>
For instance:
<pre>
Factory factory = new Factory() {
public Object create() {
return new Date();
}
}
SortedMap lazy = MapUtils.lazySortedMap(new TreeMap(), factory);
Object obj = lazy.get("test");
</pre>
After the above code is executed, <code>obj</code> will contain
a new <code>Date</code> instance. Furthermore, that <code>Date</code>
instance is the value for the <code>test</code> key.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map to make lazy, must not be null</dd><dd><code>factory</code> - the factory for creating new objects, must not be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>a lazy map backed by the given map</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the SortedMap or Factory is null</dd></dl>
</li>
</ul>
<a name="logInfo(java.lang.Exception)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logInfo</h4>
<pre>protected static void logInfo(java.lang.Exception e)</pre>
<div class="block">Logs the given exception to <Code>System.out</Code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - the exception to log</dd></dl>
</li>
</ul>
<a name="predicatedMap(java.util.Map, org.apache.commons.collections.Predicate, org.apache.commons.collections.Predicate)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>predicatedMap</h4>
<pre>public static java.util.Map predicatedMap(java.util.Map map,
<a href="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</a> keyPred,
<a href="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</a> valuePred)</pre>
<div class="block">Returns a predicated map backed by the given map. Only keys and
values that pass the given predicates can be added to the map.
It is important not to use the original map after invoking this
method, as it is a backdoor for adding unvalidated objects.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map to predicate, must not be null</dd><dd><code>keyPred</code> - the predicate for keys, must not be null</dd><dd><code>valuePred</code> - the predicate for values, must not be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>a predicated map backed by the given map</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the Map or Predicates are null</dd></dl>
</li>
</ul>
<a name="predicatedSortedMap(java.util.SortedMap, org.apache.commons.collections.Predicate, org.apache.commons.collections.Predicate)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>predicatedSortedMap</h4>
<pre>public static java.util.SortedMap predicatedSortedMap(java.util.SortedMap map,
<a href="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</a> keyPred,
<a href="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</a> valuePred)</pre>
<div class="block">Returns a predicated sorted map backed by the given map. Only keys and
values that pass the given predicates can be added to the map.
It is important not to use the original map after invoking this
method, as it is a backdoor for adding unvalidated objects.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map to predicate, must not be null</dd><dd><code>keyPred</code> - the predicate for keys, must not be null</dd><dd><code>valuePred</code> - the predicate for values, must not be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>a predicated map backed by the given map</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the SortedMap or Predicates are null</dd></dl>
</li>
</ul>
<a name="safeAddToMap(java.util.Map, java.lang.Object, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>safeAddToMap</h4>
<pre>public static final void safeAddToMap(java.util.Map map,
java.lang.Object key,
java.lang.Object value)
throws java.lang.NullPointerException</pre>
<div class="block">Nice method for adding data to a map in such a way
as to not get NPE's. The point being that if the
value is null, map.put() will throw an exception.
That blows in the case of this class cause you may want to
essentially treat put("Not Null", null ) == put("Not Null", "")
We will still throw a NPE if the key is null cause that should
never happen.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code></dd></dl>
</li>
</ul>
<a name="toProperties(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toProperties</h4>
<pre>public static java.util.Properties toProperties(java.util.Map map)</pre>
<div class="block">Gets a new Properties object initialised with the values from a Map.
A null input will return an empty properties object.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the map to convert to a Properties object</dd>
<dt><span class="strong">Returns:</span></dt><dd>the properties object</dd></dl>
</li>
</ul>
<a name="verbosePrint(java.io.PrintStream, java.lang.Object, java.util.Map)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>verbosePrint</h4>
<pre>public static void verbosePrint(java.io.PrintStream out,
java.lang.Object key,
java.util.Map map)</pre>
<div class="block">Prints the given map with nice line breaks.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - the stream to print to</dd><dd><code>key</code> - the key that maps to the map in some other map</dd><dd><code>map</code> - the map to print</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="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/commons/collections/LRUMap.html" title="class in org.apache.commons.collections"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/commons/collections/MultiHashMap.html" title="class in org.apache.commons.collections"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/commons/collections/MapUtils.html" target="_top">Frames</a></li>
<li><a href="MapUtils.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 ======= -->
<p class="legalCopy"><small><small>Copyright © 2001-2004 Apache Software Foundation. Documenation generated April 29 2013</small>.</small></p>
</body>
</html>
|