/usr/share/doc/libcommons-collections-java/api/org/apache/commons/collections/BeanMap.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 | <!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:51:59 UTC 2013 -->
<title>BeanMap (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="BeanMap (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/BagUtils.html" title="class in org.apache.commons.collections"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/commons/collections/BeanMap.MyMapEntry.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/BeanMap.html" target="_top">Frames</a></li>
<li><a href="BeanMap.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><a href="#nested_class_summary">Nested</a> | </li>
<li><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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 BeanMap" class="title">Class BeanMap</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.util.AbstractMap</li>
<li>
<ul class="inheritance">
<li>org.apache.commons.collections.BeanMap</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Cloneable, java.util.Map</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">BeanMap</span>
extends java.util.AbstractMap
implements java.lang.Cloneable</pre>
<div class="block">An implementation of Map for JavaBeans which uses introspection to
get and put properties in the bean.
If an exception occurs during attempts to get or set a property then the
property is considered non existent in the Map</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></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>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static class </code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.MyMapEntry.html" title="class in org.apache.commons.collections">BeanMap.MyMapEntry</a></strong></code>
<div class="block">Map entry used by <a href="../../../../org/apache/commons/collections/BeanMap.html" title="class in org.apache.commons.collections"><code>BeanMap</code></a>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_java.util.AbstractMap">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class java.util.AbstractMap</h3>
<code>java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V></code></li>
</ul>
<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>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.HashMap</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#defaultTransformers">defaultTransformers</a></strong></code>
<div class="block">Maps primitive Class types to transformers.</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/BeanMap.html#NULL_ARGUMENTS">NULL_ARGUMENTS</a></strong></code>
<div class="block">An empty array.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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/BeanMap.html#BeanMap()">BeanMap</a></strong>()</code>
<div class="block">Constructs a new empty <Code>BeanMap</Code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#BeanMap(java.lang.Object)">BeanMap</a></strong>(java.lang.Object bean)</code>
<div class="block">Constructs a new <Code>BeanMap</Code> that operates on the
specified bean.</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#clear()">clear</a></strong>()</code>
<div class="block">This method reinitializes the bean map to have default values for the
bean's properties.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#clone()">clone</a></strong>()</code>
<div class="block">Clone this bean map using the following process:
If there is no underlying bean, return a cloned BeanMap without a
bean.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#containsKey(java.lang.Object)">containsKey</a></strong>(java.lang.Object name)</code>
<div class="block">Returns true if the bean defines a property with the given name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#containsValue(java.lang.Object)">containsValue</a></strong>(java.lang.Object value)</code>
<div class="block">Returns true if the bean defines a property whose current value is
the given object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#convertType(java.lang.Class, java.lang.Object)">convertType</a></strong>(java.lang.Class newType,
java.lang.Object value)</code>
<div class="block">Converts the given value to the given type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.Object[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#createWriteMethodArguments(java.lang.reflect.Method, java.lang.Object)">createWriteMethodArguments</a></strong>(java.lang.reflect.Method method,
java.lang.Object value)</code>
<div class="block">Creates an array of parameters to pass to the given mutator method.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Iterator</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#entryIterator()">entryIterator</a></strong>()</code>
<div class="block">Convenience method for getting an iterator over the entries.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Set</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#entrySet()">entrySet</a></strong>()</code>
<div class="block">Get the mappings for this BeanMap</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#firePropertyChange(java.lang.Object, java.lang.Object, java.lang.Object)">firePropertyChange</a></strong>(java.lang.Object key,
java.lang.Object oldValue,
java.lang.Object newValue)</code>
<div class="block">Called during a successful <a href="../../../../org/apache/commons/collections/BeanMap.html#put(java.lang.Object, java.lang.Object)"><code>put(Object,Object)</code></a> operation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#get(java.lang.Object)">get</a></strong>(java.lang.Object name)</code>
<div class="block">Returns the value of the bean's property with the given name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#getBean()">getBean</a></strong>()</code>
<div class="block">Returns the bean currently being operated on.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.reflect.Method</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#getReadMethod(java.lang.Object)">getReadMethod</a></strong>(java.lang.Object name)</code>
<div class="block">Returns the accessor for the property with the given name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Class</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#getType(java.lang.String)">getType</a></strong>(java.lang.String name)</code>
<div class="block">Returns the type of the property with the given name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections">Transformer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#getTypeTransformer(java.lang.Class)">getTypeTransformer</a></strong>(java.lang.Class aType)</code>
<div class="block">Returns a transformer for the given primitive type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.reflect.Method</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#getWriteMethod(java.lang.Object)">getWriteMethod</a></strong>(java.lang.Object name)</code>
<div class="block">Returns the mutator for the property with the given name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Iterator</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#keyIterator()">keyIterator</a></strong>()</code>
<div class="block">Convenience method for getting an iterator over the keys.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Set</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#keySet()">keySet</a></strong>()</code>
<div class="block">Get the keys for this BeanMap.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.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="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#logWarn(java.lang.Exception)">logWarn</a></strong>(java.lang.Exception e)</code>
<div class="block">Logs the given exception to <Code>System.err</Code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#put(java.lang.Object, java.lang.Object)">put</a></strong>(java.lang.Object name,
java.lang.Object value)</code>
<div class="block">Sets the bean property with the given name to the given value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#putAllWriteable(org.apache.commons.collections.BeanMap)">putAllWriteable</a></strong>(<a href="../../../../org/apache/commons/collections/BeanMap.html" title="class in org.apache.commons.collections">BeanMap</a> map)</code>
<div class="block">Puts all of the writeable properties from the given BeanMap into this
BeanMap.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#reinitialise()">reinitialise</a></strong>()</code>
<div class="block">Reinitializes this bean.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#setBean(java.lang.Object)">setBean</a></strong>(java.lang.Object newBean)</code>
<div class="block">Sets the bean to be operated on by this map.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#size()">size</a></strong>()</code>
<div class="block">Returns the number of properties defined by the bean.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Iterator</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#valueIterator()">valueIterator</a></strong>()</code>
<div class="block">Convenience method for getting an iterator over the values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Collection</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/BeanMap.html#values()">values</a></strong>()</code>
<div class="block">Returns the values for the BeanMap.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.util.AbstractMap">
<!-- -->
</a>
<h3>Methods inherited from class java.util.AbstractMap</h3>
<code>equals, hashCode, isEmpty, putAll, remove, toString</code></li>
</ul>
<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>finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="defaultTransformers">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultTransformers</h4>
<pre>public static java.util.HashMap defaultTransformers</pre>
<div class="block">Maps primitive Class types to transformers. The transformer
transform strings into the appropriate primitive wrapper.</div>
</li>
</ul>
<a name="NULL_ARGUMENTS">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NULL_ARGUMENTS</h4>
<pre>public static final java.lang.Object[] NULL_ARGUMENTS</pre>
<div class="block">An empty array. Used to invoke accessors via reflection.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="BeanMap()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BeanMap</h4>
<pre>public BeanMap()</pre>
<div class="block">Constructs a new empty <Code>BeanMap</Code>.</div>
</li>
</ul>
<a name="BeanMap(java.lang.Object)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BeanMap</h4>
<pre>public BeanMap(java.lang.Object bean)</pre>
<div class="block">Constructs a new <Code>BeanMap</Code> that operates on the
specified bean. If the given bean is <Code>null</COde>, then
this map will be empty.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bean</code> - the bean for this map to operate on</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="clear()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>public void clear()</pre>
<div class="block">This method reinitializes the bean map to have default values for the
bean's properties. This is accomplished by constructing a new instance
of the bean which the map uses as its underlying data source. This
behavior for <code>clear()</code> differs from the Map contract in that
the mappings are not actually removed from the map (the mappings for a
BeanMap are fixed).</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>clear</code> in interface <code>java.util.Map</code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code>clear</code> in class <code>java.util.AbstractMap</code></dd>
</dl>
</li>
</ul>
<a name="clone()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre>public java.lang.Object clone()
throws java.lang.CloneNotSupportedException</pre>
<div class="block">Clone this bean map using the following process:
<ul>
<li>If there is no underlying bean, return a cloned BeanMap without a
bean.
<li>Since there is an underlying bean, try to instantiate a new bean of
the same type using Class.newInstance().
<li>If the instantiation fails, throw a CloneNotSupportedException
<li>Clone the bean map and set the newly instantiated bean as the
underyling bean for the bean map.
<li>Copy each property that is both readable and writable from the
existing object to a cloned bean map.
<li>If anything fails along the way, throw a
CloneNotSupportedException.
<ul></div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>clone</code> in class <code>java.util.AbstractMap</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.CloneNotSupportedException</code></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 name)</pre>
<div class="block">Returns true if the bean defines a property with the given name.
The given name must be a <Code>String</Code>; if not, this method
returns false. This method will also return false if the bean
does not define a property with that name.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>containsKey</code> in interface <code>java.util.Map</code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code>containsKey</code> in class <code>java.util.AbstractMap</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the property to check</dd>
<dt><span class="strong">Returns:</span></dt><dd>false if the given name is null or is not a <Code>String</Code>;
false if the bean does not define a property with that name; or
true if the bean does define a property with that name</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 true if the bean defines a property whose current value is
the given object.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>containsValue</code> in interface <code>java.util.Map</code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code>containsValue</code> in class <code>java.util.AbstractMap</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the value to check</dd>
<dt><span class="strong">Returns:</span></dt><dd>false true if the bean has at least one property whose
current value is that object, false otherwise</dd></dl>
</li>
</ul>
<a name="convertType(java.lang.Class, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>convertType</h4>
<pre>protected java.lang.Object convertType(java.lang.Class newType,
java.lang.Object value)
throws java.lang.InstantiationException,
java.lang.IllegalAccessException,
java.lang.IllegalArgumentException,
java.lang.reflect.InvocationTargetException</pre>
<div class="block">Converts the given value to the given type. First, reflection is
is used to find a public constructor declared by the given class
that takes one argument, which must be the precise type of the
given value. If such a constructor is found, a new object is
created by passing the given value to that constructor, and the
newly constructed object is returned.<P>
If no such constructor exists, and the given type is a primitive
type, then the given value is converted to a string using its
<code>toString()</code> method, and that string is
parsed into the correct primitve type using, for instance,
<code>Integer.valueOf(String)</code> to convert the string into an
<Code>int</Code>.<P>
If no special constructor exists and the given type is not a
primitive type, this method returns the original value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newType</code> - the type to convert the value to</dd><dd><code>value</code> - the value to conert</dd>
<dt><span class="strong">Returns:</span></dt><dd>the converted value</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NumberFormatException</code> - if newType is a primitive type, and
the string representation of the given value cannot be converted
to that type</dd>
<dd><code>java.lang.InstantiationException</code> - if the constructor found with
reflection raises it</dd>
<dd><code>InvocationTargetExcetpion</code> - if the constructor found with
reflection raises it</dd>
<dd><code>java.lang.IllegalAccessException</code> - never</dd>
<dd><code>java.lang.IllegalArgumentException</code> - never</dd>
<dd><code>java.lang.reflect.InvocationTargetException</code></dd></dl>
</li>
</ul>
<a name="createWriteMethodArguments(java.lang.reflect.Method, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createWriteMethodArguments</h4>
<pre>protected java.lang.Object[] createWriteMethodArguments(java.lang.reflect.Method method,
java.lang.Object value)
throws java.lang.IllegalAccessException,
java.lang.ClassCastException</pre>
<div class="block">Creates an array of parameters to pass to the given mutator method.
If the given object is not the right type to pass to the method
directly, it will be converted using <a href="../../../../org/apache/commons/collections/BeanMap.html#convertType(java.lang.Class, java.lang.Object)"><code>convertType(Class,Object)</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>method</code> - the mutator method</dd><dd><code>value</code> - the value to pass to the mutator method</dd>
<dt><span class="strong">Returns:</span></dt><dd>an array containing one object that is either the given value
or a transformed value</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalAccessException</code> - if <a href="../../../../org/apache/commons/collections/BeanMap.html#convertType(java.lang.Class, java.lang.Object)"><code>convertType(Class,Object)</code></a>
raises it</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if any other exception is raised
by <a href="../../../../org/apache/commons/collections/BeanMap.html#convertType(java.lang.Class, java.lang.Object)"><code>convertType(Class,Object)</code></a></dd>
<dd><code>java.lang.ClassCastException</code></dd></dl>
</li>
</ul>
<a name="entryIterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>entryIterator</h4>
<pre>public java.util.Iterator entryIterator()</pre>
<div class="block">Convenience method for getting an iterator over the entries.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an iterator over the entries</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">Get the mappings for this BeanMap</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>entrySet</code> in interface <code>java.util.Map</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>entrySet</code> in class <code>java.util.AbstractMap</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>BeanMap mappings. The Set returned by this method
is not modifiable.</dd></dl>
</li>
</ul>
<a name="firePropertyChange(java.lang.Object, java.lang.Object, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>firePropertyChange</h4>
<pre>protected void firePropertyChange(java.lang.Object key,
java.lang.Object oldValue,
java.lang.Object newValue)</pre>
<div class="block">Called during a successful <a href="../../../../org/apache/commons/collections/BeanMap.html#put(java.lang.Object, java.lang.Object)"><code>put(Object,Object)</code></a> operation.
Default implementation does nothing. Override to be notified of
property changes in the bean caused by this map.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the name of the property that changed</dd><dd><code>oldValue</code> - the old value for that property</dd><dd><code>newValue</code> - the new value for that property</dd></dl>
</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 name)</pre>
<div class="block">Returns the value of the bean's property with the given name.
The given name must be a <code>String</code> and must not be
null; otherwise, this method returns <Code>null</Code>.
If the bean defines a property with the given name, the value of
that property is returned. Otherwise, <Code>null</Code> is
returned.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>get</code> in interface <code>java.util.Map</code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code>get</code> in class <code>java.util.AbstractMap</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the property whose value to return</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value of the property with that name</dd></dl>
</li>
</ul>
<a name="getBean()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBean</h4>
<pre>public java.lang.Object getBean()</pre>
<div class="block">Returns the bean currently being operated on. The return value may
be null if this map is empty.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the bean being operated on by this map</dd></dl>
</li>
</ul>
<a name="getReadMethod(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReadMethod</h4>
<pre>protected java.lang.reflect.Method getReadMethod(java.lang.Object name)</pre>
<div class="block">Returns the accessor for the property with the given name.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the property</dd>
<dt><span class="strong">Returns:</span></dt><dd>null if the name is null; null if the name is not a
<code>String</code>; null if no such property exists; or the accessor
method for that property</dd></dl>
</li>
</ul>
<a name="getType(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>public java.lang.Class getType(java.lang.String name)</pre>
<div class="block">Returns the type of the property with the given name.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the property</dd>
<dt><span class="strong">Returns:</span></dt><dd>the type of the property, or <Code>null</Code> if no such
property exists</dd></dl>
</li>
</ul>
<a name="getTypeTransformer(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTypeTransformer</h4>
<pre>protected <a href="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections">Transformer</a> getTypeTransformer(java.lang.Class aType)</pre>
<div class="block">Returns a transformer for the given primitive type.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>aType</code> - the primitive type whose transformer to return</dd>
<dt><span class="strong">Returns:</span></dt><dd>a transformer that will convert strings into that type,
or null if the given type is not a primitive type</dd></dl>
</li>
</ul>
<a name="getWriteMethod(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteMethod</h4>
<pre>protected java.lang.reflect.Method getWriteMethod(java.lang.Object name)</pre>
<div class="block">Returns the mutator for the property with the given name.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the</dd>
<dt><span class="strong">Returns:</span></dt><dd>null if the name is null; null if the name is not a
<code>String</code>; null if no such property exists; null if the
property is read-only; or the mutator method for that property</dd></dl>
</li>
</ul>
<a name="keyIterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keyIterator</h4>
<pre>public java.util.Iterator keyIterator()</pre>
<div class="block">Convenience method for getting an iterator over the keys.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an iterator over the keys</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">Get the keys for this BeanMap.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>keySet</code> in interface <code>java.util.Map</code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code>keySet</code> in class <code>java.util.AbstractMap</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>BeanMap keys. The Set returned by this method is not
modifiable.</dd></dl>
</li>
</ul>
<a name="logInfo(java.lang.Exception)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logInfo</h4>
<pre>protected void logInfo(java.lang.Exception e)</pre>
<div class="block">Logs the given exception to <Code>System.out</Code>. Used to display
warnings while accessing/mutating the bean.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - the exception to log</dd></dl>
</li>
</ul>
<a name="logWarn(java.lang.Exception)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logWarn</h4>
<pre>protected void logWarn(java.lang.Exception e)</pre>
<div class="block">Logs the given exception to <Code>System.err</Code>. Used to display
errors while accessing/mutating the bean.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - the exception to log</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 name,
java.lang.Object value)
throws java.lang.IllegalArgumentException,
java.lang.ClassCastException</pre>
<div class="block">Sets the bean property with the given name to the given value.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>put</code> in interface <code>java.util.Map</code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code>put</code> in class <code>java.util.AbstractMap</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the property to set</dd><dd><code>value</code> - the value to set that property to</dd>
<dt><span class="strong">Returns:</span></dt><dd>the previous value of that property</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the given name is null;
if the given name is not a <code>String</code>; if the bean doesn't
define a property with that name; or if the bean property with
that name is read-only</dd>
<dd><code>java.lang.ClassCastException</code></dd></dl>
</li>
</ul>
<a name="putAllWriteable(org.apache.commons.collections.BeanMap)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putAllWriteable</h4>
<pre>public void putAllWriteable(<a href="../../../../org/apache/commons/collections/BeanMap.html" title="class in org.apache.commons.collections">BeanMap</a> map)</pre>
<div class="block">Puts all of the writeable properties from the given BeanMap into this
BeanMap. Read-only properties will be ignored.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the BeanMap whose properties to put</dd></dl>
</li>
</ul>
<a name="reinitialise()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reinitialise</h4>
<pre>protected void reinitialise()</pre>
<div class="block">Reinitializes this bean. Called during <a href="../../../../org/apache/commons/collections/BeanMap.html#setBean(java.lang.Object)"><code>setBean(Object)</code></a>.
Does introspection to find properties.</div>
</li>
</ul>
<a name="setBean(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBean</h4>
<pre>public void setBean(java.lang.Object newBean)</pre>
<div class="block">Sets the bean to be operated on by this map. The given value may
be null, in which case this map will be empty.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newBean</code> - the new bean to operate on</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 properties defined by the bean.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>size</code> in interface <code>java.util.Map</code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code>size</code> in class <code>java.util.AbstractMap</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the number of properties defined by the bean</dd></dl>
</li>
</ul>
<a name="valueIterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueIterator</h4>
<pre>public java.util.Iterator valueIterator()</pre>
<div class="block">Convenience method for getting an iterator over the values.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an iterator over the values</dd></dl>
</li>
</ul>
<a name="values()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>values</h4>
<pre>public java.util.Collection values()</pre>
<div class="block">Returns the values for the BeanMap.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>values</code> in interface <code>java.util.Map</code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code>values</code> in class <code>java.util.AbstractMap</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>values for the BeanMap. The returned collection is not
modifiable.</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/BagUtils.html" title="class in org.apache.commons.collections"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/commons/collections/BeanMap.MyMapEntry.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/BeanMap.html" target="_top">Frames</a></li>
<li><a href="BeanMap.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><a href="#nested_class_summary">Nested</a> | </li>
<li><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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>
|