[ephemerata.git] / KezvhLib / lib / org.apache.commons.collections / apidocs / org / apache / commons / collections / BeanMap.html
| blob | 4dd3d051864f40bff445d2b08bde14c4931c9f86 |
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by javadoc (build 1.5.0_07) on Fri Apr 11 15:39:16 BST 2008 -->
7 <TITLE>
8 BeanMap (Commons Collections 3.2.1 API)
9 </TITLE>
16 function windowTitle()
17 {
19 }
20 </SCRIPT>
21 <NOSCRIPT>
22 </NOSCRIPT>
24 </HEAD>
29 <!-- ========= START OF TOP NAVBAR ======= -->
33 <TR>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
40 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BeanMap.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
46 </TR>
47 </TABLE>
48 </TD>
50 </EM>
51 </TD>
52 </TR>
54 <TR>
56 <A HREF="../../../../org/apache/commons/collections/BagUtils.html" title="class in org.apache.commons.collections"><B>PREV CLASS</B></A>
57 <A HREF="../../../../org/apache/commons/collections/BeanMap.MyMapEntry.html" title="class in org.apache.commons.collections"><B>NEXT CLASS</B></A></FONT></TD>
59 <A HREF="../../../../index.html?org/apache/commons/collections/BeanMap.html" target="_top"><B>FRAMES</B></A>
62 <!--
63 if(window==top) {
64 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
65 }
66 //-->
67 </SCRIPT>
68 <NOSCRIPT>
70 </NOSCRIPT>
73 </FONT></TD>
74 </TR>
75 <TR>
77 SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
79 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
80 </TR>
81 </TABLE>
83 <!-- ========= END OF TOP NAVBAR ========= -->
85 <HR>
86 <!-- ======== START OF CLASS DATA ======== -->
87 <H2>
89 org.apache.commons.collections</FONT>
90 <BR>
91 Class BeanMap</H2>
92 <PRE>
93 java.lang.Object
95 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.commons.collections.BeanMap</B>
96 </PRE>
97 <DL>
99 </DL>
100 <HR>
101 <B>Deprecated.</B> <I>Identical class now available in commons-beanutils (full jar version).
102 This version is due to be removed in collections v4.0.</I>
103 <P>
104 <DL>
105 <DT><PRE>public class <B>BeanMap</B><DT>extends java.util.AbstractMap<DT>implements java.lang.Cloneable</DL>
106 </PRE>
108 <P>
109 An implementation of Map for JavaBeans which uses introspection to
110 get and put properties in the bean.
111 <p>
112 If an exception occurs during attempts to get or set a property then the
113 property is considered non existent in the Map
114 <P>
116 <P>
117 <DL>
124 </DL>
125 <HR>
127 <P>
128 <!-- ======== NESTED CLASS SUMMARY ======== -->
135 </TR>
139 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.MyMapEntry.html" title="class in org.apache.commons.collections">BeanMap.MyMapEntry</A></B></CODE>
141 <BR>
142 <B>Deprecated.</B> Map entry used by <A HREF="../../../../org/apache/commons/collections/BeanMap.html" title="class in org.apache.commons.collections"><CODE>BeanMap</CODE></A>.</TD>
143 </TR>
144 </TABLE>
149 </TR>
152 </TR>
153 </TABLE>
154
155 <!-- =========== FIELD SUMMARY =========== -->
162 </TR>
166 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#defaultTransformers">defaultTransformers</A></B></CODE>
168 <BR>
169 <B>Deprecated.</B> Maps primitive Class types to transformers.</TD>
170 </TR>
174 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#NULL_ARGUMENTS">NULL_ARGUMENTS</A></B></CODE>
176 <BR>
177 <B>Deprecated.</B> An empty array.</TD>
178 </TR>
179 </TABLE>
180
181 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
188 </TR>
190 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#BeanMap()">BeanMap</A></B>()</CODE>
192 <BR>
193 <B>Deprecated.</B> Constructs a new empty <code>BeanMap</code>.</TD>
194 </TR>
196 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#BeanMap(java.lang.Object)">BeanMap</A></B>(java.lang.Object bean)</CODE>
198 <BR>
199 <B>Deprecated.</B> Constructs a new <code>BeanMap</code> that operates on the
200 specified bean.</TD>
201 </TR>
202 </TABLE>
203
204 <!-- ========== METHOD SUMMARY =========== -->
211 </TR>
215 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#clear()">clear</A></B>()</CODE>
217 <BR>
218 <B>Deprecated.</B> This method reinitializes the bean map to have default values for the
219 bean's properties.</TD>
220 </TR>
224 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#clone()">clone</A></B>()</CODE>
226 <BR>
227 <B>Deprecated.</B> Clone this bean map using the following process:
230 If there is no underlying bean, return a cloned BeanMap without a
231 bean.</TD>
232 </TR>
236 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#containsKey(java.lang.Object)">containsKey</A></B>(java.lang.Object name)</CODE>
238 <BR>
239 <B>Deprecated.</B> Returns true if the bean defines a property with the given name.</TD>
240 </TR>
244 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#containsValue(java.lang.Object)">containsValue</A></B>(java.lang.Object value)</CODE>
246 <BR>
247 <B>Deprecated.</B> Returns true if the bean defines a property whose current value is
248 the given object.</TD>
249 </TR>
253 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#convertType(java.lang.Class, java.lang.Object)">convertType</A></B>(java.lang.Class newType,
256 <BR>
257 <B>Deprecated.</B> Converts the given value to the given type.</TD>
258 </TR>
262 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#createWriteMethodArguments(java.lang.reflect.Method, java.lang.Object)">createWriteMethodArguments</A></B>(java.lang.reflect.Method method,
265 <BR>
266 <B>Deprecated.</B> Creates an array of parameters to pass to the given mutator method.</TD>
267 </TR>
271 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#entryIterator()">entryIterator</A></B>()</CODE>
273 <BR>
274 <B>Deprecated.</B> Convenience method for getting an iterator over the entries.</TD>
275 </TR>
279 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#entrySet()">entrySet</A></B>()</CODE>
281 <BR>
282 <B>Deprecated.</B> Gets a Set of MapEntry objects that are the mappings for this BeanMap.</TD>
283 </TR>
287 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#firePropertyChange(java.lang.Object, java.lang.Object, java.lang.Object)">firePropertyChange</A></B>(java.lang.Object key,
288 java.lang.Object oldValue,
291 <BR>
292 <B>Deprecated.</B> 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.</TD>
293 </TR>
297 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#get(java.lang.Object)">get</A></B>(java.lang.Object name)</CODE>
299 <BR>
300 <B>Deprecated.</B> Returns the value of the bean's property with the given name.</TD>
301 </TR>
305 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#getBean()">getBean</A></B>()</CODE>
307 <BR>
308 <B>Deprecated.</B> Returns the bean currently being operated on.</TD>
309 </TR>
313 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#getReadMethod(java.lang.Object)">getReadMethod</A></B>(java.lang.Object name)</CODE>
315 <BR>
316 <B>Deprecated.</B> Returns the accessor for the property with the given name.</TD>
317 </TR>
321 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#getReadMethod(java.lang.String)">getReadMethod</A></B>(java.lang.String name)</CODE>
323 <BR>
324 <B>Deprecated.</B> Returns the accessor for the property with the given name.</TD>
325 </TR>
329 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#getType(java.lang.String)">getType</A></B>(java.lang.String name)</CODE>
331 <BR>
332 <B>Deprecated.</B> Returns the type of the property with the given name.</TD>
333 </TR>
336 <CODE>protected <A HREF="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections">Transformer</A></CODE></FONT></TD>
337 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#getTypeTransformer(java.lang.Class)">getTypeTransformer</A></B>(java.lang.Class aType)</CODE>
339 <BR>
340 <B>Deprecated.</B> Returns a transformer for the given primitive type.</TD>
341 </TR>
345 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#getWriteMethod(java.lang.Object)">getWriteMethod</A></B>(java.lang.Object name)</CODE>
347 <BR>
348 <B>Deprecated.</B> Returns the mutator for the property with the given name.</TD>
349 </TR>
353 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#getWriteMethod(java.lang.String)">getWriteMethod</A></B>(java.lang.String name)</CODE>
355 <BR>
356 <B>Deprecated.</B> Returns the mutator for the property with the given name.</TD>
357 </TR>
361 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#keyIterator()">keyIterator</A></B>()</CODE>
363 <BR>
364 <B>Deprecated.</B> Convenience method for getting an iterator over the keys.</TD>
365 </TR>
369 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#keySet()">keySet</A></B>()</CODE>
371 <BR>
372 <B>Deprecated.</B> Get the keys for this BeanMap.</TD>
373 </TR>
377 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#logInfo(java.lang.Exception)">logInfo</A></B>(java.lang.Exception ex)</CODE>
379 <BR>
380 <B>Deprecated.</B> Logs the given exception to <code>System.out</code>.</TD>
381 </TR>
385 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#logWarn(java.lang.Exception)">logWarn</A></B>(java.lang.Exception ex)</CODE>
387 <BR>
388 <B>Deprecated.</B> Logs the given exception to <code>System.err</code>.</TD>
389 </TR>
393 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#put(java.lang.Object, java.lang.Object)">put</A></B>(java.lang.Object name,
396 <BR>
397 <B>Deprecated.</B> Sets the bean property with the given name to the given value.</TD>
398 </TR>
402 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#putAllWriteable(org.apache.commons.collections.BeanMap)">putAllWriteable</A></B>(<A HREF="../../../../org/apache/commons/collections/BeanMap.html" title="class in org.apache.commons.collections">BeanMap</A> map)</CODE>
404 <BR>
405 <B>Deprecated.</B> Puts all of the writable properties from the given BeanMap into this
406 BeanMap.</TD>
407 </TR>
411 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#reinitialise()">reinitialise</A></B>()</CODE>
413 <BR>
414 <B>Deprecated.</B> Reinitializes this bean.</TD>
415 </TR>
419 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#setBean(java.lang.Object)">setBean</A></B>(java.lang.Object newBean)</CODE>
421 <BR>
422 <B>Deprecated.</B> Sets the bean to be operated on by this map.</TD>
423 </TR>
427 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#size()">size</A></B>()</CODE>
429 <BR>
430 <B>Deprecated.</B> Returns the number of properties defined by the bean.</TD>
431 </TR>
435 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#toString()">toString</A></B>()</CODE>
437 <BR>
439 </TR>
443 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#valueIterator()">valueIterator</A></B>()</CODE>
445 <BR>
446 <B>Deprecated.</B> Convenience method for getting an iterator over the values.</TD>
447 </TR>
451 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/BeanMap.html#values()">values</A></B>()</CODE>
453 <BR>
454 <B>Deprecated.</B> Returns the values for the BeanMap.</TD>
455 </TR>
456 </TABLE>
461 </TR>
464 </TR>
465 </TABLE>
470 </TR>
473 </TR>
474 </TABLE>
475
476 <P>
478 <!-- ============ FIELD DETAIL =========== -->
485 </TR>
486 </TABLE>
489 NULL_ARGUMENTS</H3>
490 <PRE>
492 <DL>
494 <P>
495 <DL>
496 </DL>
497 </DL>
498 <HR>
501 defaultTransformers</H3>
502 <PRE>
504 <DL>
506 transform strings into the appropriate primitive wrapper.
507 <P>
508 <DL>
509 </DL>
510 </DL>
512 <!-- ========= CONSTRUCTOR DETAIL ======== -->
519 </TR>
520 </TABLE>
523 BeanMap</H3>
524 <PRE>
526 <DL>
528 <P>
529 </DL>
530 <HR>
533 BeanMap</H3>
534 <PRE>
536 <DL>
539 this map will be empty.
540 <P>
541 <DL>
543 </DL>
545 <!-- ============ METHOD DETAIL ========== -->
552 </TR>
553 </TABLE>
556 toString</H3>
557 <PRE>
559 <DL>
562 </DD>
563 <DD><DL>
564 </DL>
565 </DD>
566 </DL>
567 <HR>
570 clone</H3>
571 <PRE>
573 throws java.lang.CloneNotSupportedException</PRE>
574 <DL>
577 <ul>
578 <li>If there is no underlying bean, return a cloned BeanMap without a
579 bean.
581 <li>Since there is an underlying bean, try to instantiate a new bean of
582 the same type using Class.newInstance().
584 <li>If the instantiation fails, throw a CloneNotSupportedException
586 <li>Clone the bean map and set the newly instantiated bean as the
587 underlying bean for the bean map.
589 <li>Copy each property that is both readable and writable from the
590 existing object to a cloned bean map.
592 <li>If anything fails along the way, throw a
593 CloneNotSupportedException.
595 <ul>
596 <P>
597 <DD><DL>
599 </DD>
600 <DD><DL>
604 </DD>
605 </DL>
606 <HR>
609 putAllWriteable</H3>
610 <PRE>
611 public void <B>putAllWriteable</B>(<A HREF="../../../../org/apache/commons/collections/BeanMap.html" title="class in org.apache.commons.collections">BeanMap</A> map)</PRE>
612 <DL>
613 <DD><B>Deprecated.</B> <DD>Puts all of the writable properties from the given BeanMap into this
614 BeanMap. Read-only and Write-only properties will be ignored.
615 <P>
616 <DD><DL>
617 </DL>
618 </DD>
619 <DD><DL>
621 </DD>
622 </DL>
623 <HR>
626 clear</H3>
627 <PRE>
629 <DL>
630 <DD><B>Deprecated.</B> <DD>This method reinitializes the bean map to have default values for the
631 bean's properties. This is accomplished by constructing a new instance
632 of the bean which the map uses as its underlying data source. This
634 the mappings are not actually removed from the map (the mappings for a
635 BeanMap are fixed).
636 <P>
637 <DD><DL>
638 <DT><B>Specified by:</B><DD><CODE>clear</CODE> in interface <CODE>java.util.Map</CODE><DT><B>Overrides:</B><DD><CODE>clear</CODE> in class <CODE>java.util.AbstractMap</CODE></DL>
639 </DD>
640 <DD><DL>
641 </DL>
642 </DD>
643 </DL>
644 <HR>
647 containsKey</H3>
648 <PRE>
650 <DL>
651 <DD><B>Deprecated.</B> <DD>Returns true if the bean defines a property with the given name.
652 <p>
654 returns false. This method will also return false if the bean
655 does not define a property with that name.
656 <p>
657 Write-only properties will not be matched as the test operates against
658 property read methods.
659 <P>
660 <DD><DL>
661 <DT><B>Specified by:</B><DD><CODE>containsKey</CODE> in interface <CODE>java.util.Map</CODE><DT><B>Overrides:</B><DD><CODE>containsKey</CODE> in class <CODE>java.util.AbstractMap</CODE></DL>
662 </DD>
663 <DD><DL>
666 false if the bean does not define a property with that name; or
667 true if the bean does define a property with that name</DL>
668 </DD>
669 </DL>
670 <HR>
673 containsValue</H3>
674 <PRE>
676 <DL>
677 <DD><B>Deprecated.</B> <DD>Returns true if the bean defines a property whose current value is
678 the given object.
679 <P>
680 <DD><DL>
681 <DT><B>Specified by:</B><DD><CODE>containsValue</CODE> in interface <CODE>java.util.Map</CODE><DT><B>Overrides:</B><DD><CODE>containsValue</CODE> in class <CODE>java.util.AbstractMap</CODE></DL>
682 </DD>
683 <DD><DL>
686 current value is that object, false otherwise</DL>
687 </DD>
688 </DL>
689 <HR>
692 get</H3>
693 <PRE>
695 <DL>
697 <p>
700 If the bean defines a property with the given name, the value of
702 returned.
703 <p>
704 Write-only properties will not be matched as the test operates against
705 property read methods.
706 <P>
707 <DD><DL>
708 <DT><B>Specified by:</B><DD><CODE>get</CODE> in interface <CODE>java.util.Map</CODE><DT><B>Overrides:</B><DD><CODE>get</CODE> in class <CODE>java.util.AbstractMap</CODE></DL>
709 </DD>
710 <DD><DL>
713 </DD>
714 </DL>
715 <HR>
718 put</H3>
719 <PRE>
721 java.lang.Object value)
722 throws java.lang.IllegalArgumentException,
723 java.lang.ClassCastException</PRE>
724 <DL>
726 <P>
727 <DD><DL>
728 <DT><B>Specified by:</B><DD><CODE>put</CODE> in interface <CODE>java.util.Map</CODE><DT><B>Overrides:</B><DD><CODE>put</CODE> in class <CODE>java.util.AbstractMap</CODE></DL>
729 </DD>
730 <DD><DL>
731 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the property to set<DD><CODE>value</CODE> - the value to set that property to
736 define a property with that name; or if the bean property with
737 that name is read-only
739 </DD>
740 </DL>
741 <HR>
744 size</H3>
745 <PRE>
747 <DL>
749 <P>
750 <DD><DL>
751 <DT><B>Specified by:</B><DD><CODE>size</CODE> in interface <CODE>java.util.Map</CODE><DT><B>Overrides:</B><DD><CODE>size</CODE> in class <CODE>java.util.AbstractMap</CODE></DL>
752 </DD>
753 <DD><DL>
756 </DD>
757 </DL>
758 <HR>
761 keySet</H3>
762 <PRE>
764 <DL>
766 <p>
768 property names, although it is possible to set their value and to get
769 their type.
770 <P>
771 <DD><DL>
772 <DT><B>Specified by:</B><DD><CODE>keySet</CODE> in interface <CODE>java.util.Map</CODE><DT><B>Overrides:</B><DD><CODE>keySet</CODE> in class <CODE>java.util.AbstractMap</CODE></DL>
773 </DD>
774 <DD><DL>
777 modifiable.</DL>
778 </DD>
779 </DL>
780 <HR>
783 entrySet</H3>
784 <PRE>
786 <DL>
787 <DD><B>Deprecated.</B> <DD>Gets a Set of MapEntry objects that are the mappings for this BeanMap.
788 <p>
789 Each MapEntry can be set but not removed.
790 <P>
791 <DD><DL>
792 <DT><B>Specified by:</B><DD><CODE>entrySet</CODE> in interface <CODE>java.util.Map</CODE><DT><B>Specified by:</B><DD><CODE>entrySet</CODE> in class <CODE>java.util.AbstractMap</CODE></DL>
793 </DD>
794 <DD><DL>
797 </DD>
798 </DL>
799 <HR>
802 values</H3>
803 <PRE>
805 <DL>
807 <P>
808 <DD><DL>
809 <DT><B>Specified by:</B><DD><CODE>values</CODE> in interface <CODE>java.util.Map</CODE><DT><B>Overrides:</B><DD><CODE>values</CODE> in class <CODE>java.util.AbstractMap</CODE></DL>
810 </DD>
811 <DD><DL>
814 modifiable.</DL>
815 </DD>
816 </DL>
817 <HR>
820 getType</H3>
821 <PRE>
823 <DL>
825 <P>
826 <DD><DL>
827 </DL>
828 </DD>
829 <DD><DL>
832 property exists</DL>
833 </DD>
834 </DL>
835 <HR>
838 keyIterator</H3>
839 <PRE>
841 <DL>
843 <p>
844 Write-only properties will not be returned in the iterator.
845 <P>
846 <DD><DL>
847 </DL>
848 </DD>
849 <DD><DL>
852 </DD>
853 </DL>
854 <HR>
857 valueIterator</H3>
858 <PRE>
860 <DL>
862 <P>
863 <DD><DL>
864 </DL>
865 </DD>
866 <DD><DL>
869 </DD>
870 </DL>
871 <HR>
874 entryIterator</H3>
875 <PRE>
877 <DL>
879 <P>
880 <DD><DL>
881 </DL>
882 </DD>
883 <DD><DL>
886 </DD>
887 </DL>
888 <HR>
891 getBean</H3>
892 <PRE>
894 <DL>
895 <DD><B>Deprecated.</B> <DD>Returns the bean currently being operated on. The return value may
896 be null if this map is empty.
897 <P>
898 <DD><DL>
899 </DL>
900 </DD>
901 <DD><DL>
904 </DD>
905 </DL>
906 <HR>
909 setBean</H3>
910 <PRE>
912 <DL>
913 <DD><B>Deprecated.</B> <DD>Sets the bean to be operated on by this map. The given value may
914 be null, in which case this map will be empty.
915 <P>
916 <DD><DL>
917 </DL>
918 </DD>
919 <DD><DL>
921 </DD>
922 </DL>
923 <HR>
926 getReadMethod</H3>
927 <PRE>
929 <DL>
931 <P>
932 <DD><DL>
933 </DL>
934 </DD>
935 <DD><DL>
938 </DD>
939 </DL>
940 <HR>
943 getWriteMethod</H3>
944 <PRE>
946 <DL>
948 <P>
949 <DD><DL>
950 </DL>
951 </DD>
952 <DD><DL>
955 </DD>
956 </DL>
957 <HR>
960 getReadMethod</H3>
961 <PRE>
963 <DL>
965 <P>
966 <DD><DL>
967 </DL>
968 </DD>
969 <DD><DL>
973 method for that property</DL>
974 </DD>
975 </DL>
976 <HR>
979 getWriteMethod</H3>
980 <PRE>
982 <DL>
984 <P>
985 <DD><DL>
986 </DL>
987 </DD>
988 <DD><DL>
992 property is read-only; or the mutator method for that property</DL>
993 </DD>
994 </DL>
995 <HR>
998 reinitialise</H3>
999 <PRE>
1001 <DL>
1002 <DD><B>Deprecated.</B> <DD>Reinitializes this bean. Called during <A HREF="../../../../org/apache/commons/collections/BeanMap.html#setBean(java.lang.Object)"><CODE>setBean(Object)</CODE></A>.
1003 Does introspection to find properties.
1004 <P>
1005 <DD><DL>
1006 </DL>
1007 </DD>
1008 <DD><DL>
1009 </DL>
1010 </DD>
1011 </DL>
1012 <HR>
1014 <A NAME="firePropertyChange(java.lang.Object, java.lang.Object, java.lang.Object)"><!-- --></A><H3>
1015 firePropertyChange</H3>
1016 <PRE>
1018 java.lang.Object oldValue,
1020 <DL>
1021 <DD><B>Deprecated.</B> <DD>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.
1022 Default implementation does nothing. Override to be notified of
1023 property changes in the bean caused by this map.
1024 <P>
1025 <DD><DL>
1026 </DL>
1027 </DD>
1028 <DD><DL>
1029 <DT><B>Parameters:</B><DD><CODE>key</CODE> - the name of the property that changed<DD><CODE>oldValue</CODE> - the old value for that property<DD><CODE>newValue</CODE> - the new value for that property</DL>
1030 </DD>
1031 </DL>
1032 <HR>
1034 <A NAME="createWriteMethodArguments(java.lang.reflect.Method, java.lang.Object)"><!-- --></A><H3>
1035 createWriteMethodArguments</H3>
1036 <PRE>
1037 protected java.lang.Object[] <B>createWriteMethodArguments</B>(java.lang.reflect.Method method,
1038 java.lang.Object value)
1039 throws java.lang.IllegalAccessException,
1040 java.lang.ClassCastException</PRE>
1041 <DL>
1042 <DD><B>Deprecated.</B> <DD>Creates an array of parameters to pass to the given mutator method.
1043 If the given object is not the right type to pass to the method
1044 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>.
1045 <P>
1046 <DD><DL>
1047 </DL>
1048 </DD>
1049 <DD><DL>
1050 <DT><B>Parameters:</B><DD><CODE>method</CODE> - the mutator method<DD><CODE>value</CODE> - the value to pass to the mutator method
1052 or a transformed value
1054 <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>
1055 raises it
1057 by <A HREF="../../../../org/apache/commons/collections/BeanMap.html#convertType(java.lang.Class, java.lang.Object)"><CODE>convertType(Class,Object)</CODE></A>
1059 </DD>
1060 </DL>
1061 <HR>
1064 convertType</H3>
1065 <PRE>
1067 java.lang.Object value)
1068 throws java.lang.InstantiationException,
1069 java.lang.IllegalAccessException,
1070 java.lang.IllegalArgumentException,
1071 java.lang.reflect.InvocationTargetException</PRE>
1072 <DL>
1073 <DD><B>Deprecated.</B> <DD>Converts the given value to the given type. First, reflection is
1074 is used to find a public constructor declared by the given class
1075 that takes one argument, which must be the precise type of the
1076 given value. If such a constructor is found, a new object is
1077 created by passing the given value to that constructor, and the
1078 newly constructed object is returned.<P>
1080 If no such constructor exists, and the given type is a primitive
1081 type, then the given value is converted to a string using its
1083 parsed into the correct primitive type using, for instance,
1087 If no special constructor exists and the given type is not a
1088 primitive type, this method returns the original value.
1089 <P>
1090 <DD><DL>
1091 </DL>
1092 </DD>
1093 <DD><DL>
1094 <DT><B>Parameters:</B><DD><CODE>newType</CODE> - the type to convert the value to<DD><CODE>value</CODE> - the value to convert
1098 the string representation of the given value cannot be converted
1099 to that type
1101 reflection raises it
1103 reflection raises it
1106 </DD>
1107 </DL>
1108 <HR>
1111 getTypeTransformer</H3>
1112 <PRE>
1113 protected <A HREF="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections">Transformer</A> <B>getTypeTransformer</B>(java.lang.Class aType)</PRE>
1114 <DL>
1116 <P>
1117 <DD><DL>
1118 </DL>
1119 </DD>
1120 <DD><DL>
1123 or null if the given type is not a primitive type</DL>
1124 </DD>
1125 </DL>
1126 <HR>
1129 logInfo</H3>
1130 <PRE>
1132 <DL>
1133 <DD><B>Deprecated.</B> <DD>Logs the given exception to <code>System.out</code>. Used to display
1134 warnings while accessing/mutating the bean.
1135 <P>
1136 <DD><DL>
1137 </DL>
1138 </DD>
1139 <DD><DL>
1141 </DD>
1142 </DL>
1143 <HR>
1146 logWarn</H3>
1147 <PRE>
1149 <DL>
1150 <DD><B>Deprecated.</B> <DD>Logs the given exception to <code>System.err</code>. Used to display
1151 errors while accessing/mutating the bean.
1152 <P>
1153 <DD><DL>
1154 </DL>
1155 </DD>
1156 <DD><DL>
1158 </DD>
1159 </DL>
1160 <!-- ========= END OF CLASS DATA ========= -->
1161 <HR>
1164 <!-- ======= START OF BOTTOM NAVBAR ====== -->
1168 <TR>
1173 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
1174 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
1175 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
1176 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BeanMap.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
1177 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
1178 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
1179 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
1180 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
1181 </TR>
1182 </TABLE>
1183 </TD>
1185 </EM>
1186 </TD>
1187 </TR>
1189 <TR>
1191 <A HREF="../../../../org/apache/commons/collections/BagUtils.html" title="class in org.apache.commons.collections"><B>PREV CLASS</B></A>
1192 <A HREF="../../../../org/apache/commons/collections/BeanMap.MyMapEntry.html" title="class in org.apache.commons.collections"><B>NEXT CLASS</B></A></FONT></TD>
1194 <A HREF="../../../../index.html?org/apache/commons/collections/BeanMap.html" target="_top"><B>FRAMES</B></A>
1197 <!--
1198 if(window==top) {
1199 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
1200 }
1201 //-->
1202 </SCRIPT>
1203 <NOSCRIPT>
1205 </NOSCRIPT>
1208 </FONT></TD>
1209 </TR>
1210 <TR>
1212 SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
1214 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
1215 </TR>
1216 </TABLE>
1218 <!-- ======== END OF BOTTOM NAVBAR ======= -->
1220 <HR>
1221 Copyright © 2001-2008 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
1222 </BODY>
1223 </HTML>