[ephemerata.git] / KezvhLib / lib / org.apache.commons.collections / apidocs / org / apache / commons / collections / MapUtils.html
| blob | 480d6bd40eb401f11493a155094d25f4d37b10b0 |
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:17 BST 2008 -->
7 <TITLE>
8 MapUtils (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/MapUtils.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/MapIterator.html" title="interface in org.apache.commons.collections"><B>PREV CLASS</B></A>
57 <A HREF="../../../../org/apache/commons/collections/MultiHashMap.html" title="class in org.apache.commons.collections"><B>NEXT CLASS</B></A></FONT></TD>
59 <A HREF="../../../../index.html?org/apache/commons/collections/MapUtils.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: NESTED | <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 MapUtils</H2>
92 <PRE>
93 java.lang.Object
94 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.commons.collections.MapUtils</B>
95 </PRE>
96 <HR>
97 <DL>
99 </PRE>
101 <P>
102 Provides utility methods and decorators for
104 <p>
105 It contains various type safe methods
106 as well as other useful features like deep copying.
107 <p>
108 It also provides the following decorators:
110 <ul>
111 <li><A HREF="../../../../org/apache/commons/collections/MapUtils.html#fixedSizeMap(java.util.Map)"><CODE>fixedSizeMap(Map)</CODE></A>
112 <li><A HREF="../../../../org/apache/commons/collections/MapUtils.html#fixedSizeSortedMap(java.util.SortedMap)"><CODE>fixedSizeSortedMap(SortedMap)</CODE></A>
113 <li><A HREF="../../../../org/apache/commons/collections/MapUtils.html#lazyMap(java.util.Map, org.apache.commons.collections.Factory)"><CODE>lazyMap(Map,Factory)</CODE></A>
114 <li><A HREF="../../../../org/apache/commons/collections/MapUtils.html#lazyMap(java.util.Map, org.apache.commons.collections.Transformer)"><CODE>lazyMap(Map,Transformer)</CODE></A>
115 <li><A HREF="../../../../org/apache/commons/collections/MapUtils.html#lazySortedMap(java.util.SortedMap, org.apache.commons.collections.Factory)"><CODE>lazySortedMap(SortedMap,Factory)</CODE></A>
116 <li><A HREF="../../../../org/apache/commons/collections/MapUtils.html#lazySortedMap(java.util.SortedMap, org.apache.commons.collections.Transformer)"><CODE>lazySortedMap(SortedMap,Transformer)</CODE></A>
117 <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>
118 <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>
119 <li><A HREF="../../../../org/apache/commons/collections/MapUtils.html#transformedMap(java.util.Map, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)"><CODE>transformedMap(Map, Transformer, Transformer)</CODE></A>
120 <li><A HREF="../../../../org/apache/commons/collections/MapUtils.html#transformedSortedMap(java.util.SortedMap, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)"><CODE>transformedSortedMap(SortedMap, Transformer, Transformer)</CODE></A>
121 <li><A HREF="../../../../org/apache/commons/collections/MapUtils.html#typedMap(java.util.Map, java.lang.Class, java.lang.Class)"><CODE>typedMap(Map, Class, Class)</CODE></A>
122 <li><A HREF="../../../../org/apache/commons/collections/MapUtils.html#typedSortedMap(java.util.SortedMap, java.lang.Class, java.lang.Class)"><CODE>typedSortedMap(SortedMap, Class, Class)</CODE></A>
123 <li><A HREF="../../../../org/apache/commons/collections/MapUtils.html#multiValueMap(java.util.Map)"><CODE>multiValueMap( Map )</CODE></A>
124 <li><A HREF="../../../../org/apache/commons/collections/MapUtils.html#multiValueMap(java.util.Map, java.lang.Class)"><CODE>multiValueMap( Map, Class )</CODE></A>
125 <li><A HREF="../../../../org/apache/commons/collections/MapUtils.html#multiValueMap(java.util.Map, org.apache.commons.collections.Factory)"><CODE>multiValueMap( Map, Factory )</CODE></A>
126 </ul>
127 <P>
129 <P>
130 <DL>
136 <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, Matthew Hawthorne, Arun Mammen Thomas, Janek Bogucki, Max Rydahl Andersen, <a href="mailto:equinus100@hotmail.com">Ashwin S</a>, <a href="mailto:jcarman@apache.org">James Carman</a>, Neil O'Toole</DD>
137 </DL>
138 <HR>
140 <P>
141 <!-- =========== FIELD SUMMARY =========== -->
148 </TR>
152 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#EMPTY_MAP">EMPTY_MAP</A></B></CODE>
154 <BR>
156 </TR>
160 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#EMPTY_SORTED_MAP">EMPTY_SORTED_MAP</A></B></CODE>
162 <BR>
163 An empty unmodifiable sorted map.</TD>
164 </TR>
165 </TABLE>
166
167 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
174 </TR>
176 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#MapUtils()">MapUtils</A></B>()</CODE>
178 <BR>
179 <code>MapUtils</code> should not normally be instantiated.</TD>
180 </TR>
181 </TABLE>
182
183 <!-- ========== METHOD SUMMARY =========== -->
190 </TR>
194 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#debugPrint(java.io.PrintStream, java.lang.Object, java.util.Map)">debugPrint</A></B>(java.io.PrintStream out,
195 java.lang.Object label,
198 <BR>
199 Prints the given map with nice line breaks.</TD>
200 </TR>
204 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#fixedSizeMap(java.util.Map)">fixedSizeMap</A></B>(java.util.Map map)</CODE>
206 <BR>
207 Returns a fixed-sized map backed by the given map.</TD>
208 </TR>
212 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#fixedSizeSortedMap(java.util.SortedMap)">fixedSizeSortedMap</A></B>(java.util.SortedMap map)</CODE>
214 <BR>
215 Returns a fixed-sized sorted map backed by the given sorted map.</TD>
216 </TR>
220 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getBoolean(java.util.Map, java.lang.Object)">getBoolean</A></B>(java.util.Map map,
223 <BR>
224 Gets a Boolean from a Map in a null-safe manner.</TD>
225 </TR>
229 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getBoolean(java.util.Map, java.lang.Object, java.lang.Boolean)">getBoolean</A></B>(java.util.Map map,
230 java.lang.Object key,
233 <BR>
234 Looks up the given key in the given map, converting the result into
235 a boolean, using the default value if the the conversion fails.</TD>
236 </TR>
240 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getBooleanValue(java.util.Map, java.lang.Object)">getBooleanValue</A></B>(java.util.Map map,
243 <BR>
244 Gets a boolean from a Map in a null-safe manner.</TD>
245 </TR>
249 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getBooleanValue(java.util.Map, java.lang.Object, boolean)">getBooleanValue</A></B>(java.util.Map map,
250 java.lang.Object key,
253 <BR>
254 Gets a boolean from a Map in a null-safe manner,
255 using the default value if the the conversion fails.</TD>
256 </TR>
260 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getByte(java.util.Map, java.lang.Object)">getByte</A></B>(java.util.Map map,
263 <BR>
264 Gets a Byte from a Map in a null-safe manner.</TD>
265 </TR>
269 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getByte(java.util.Map, java.lang.Object, java.lang.Byte)">getByte</A></B>(java.util.Map map,
270 java.lang.Object key,
273 <BR>
274 Looks up the given key in the given map, converting the result into
275 a byte, using the default value if the the conversion fails.</TD>
276 </TR>
280 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getByteValue(java.util.Map, java.lang.Object)">getByteValue</A></B>(java.util.Map map,
283 <BR>
284 Gets a byte from a Map in a null-safe manner.</TD>
285 </TR>
289 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getByteValue(java.util.Map, java.lang.Object, byte)">getByteValue</A></B>(java.util.Map map,
290 java.lang.Object key,
293 <BR>
294 Gets a byte from a Map in a null-safe manner,
295 using the default value if the the conversion fails.</TD>
296 </TR>
300 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getDouble(java.util.Map, java.lang.Object)">getDouble</A></B>(java.util.Map map,
303 <BR>
304 Gets a Double from a Map in a null-safe manner.</TD>
305 </TR>
309 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getDouble(java.util.Map, java.lang.Object, java.lang.Double)">getDouble</A></B>(java.util.Map map,
310 java.lang.Object key,
313 <BR>
314 Looks up the given key in the given map, converting the result into
315 a double, using the default value if the the conversion fails.</TD>
316 </TR>
320 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getDoubleValue(java.util.Map, java.lang.Object)">getDoubleValue</A></B>(java.util.Map map,
323 <BR>
324 Gets a double from a Map in a null-safe manner.</TD>
325 </TR>
329 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getDoubleValue(java.util.Map, java.lang.Object, double)">getDoubleValue</A></B>(java.util.Map map,
330 java.lang.Object key,
333 <BR>
334 Gets a double from a Map in a null-safe manner,
335 using the default value if the the conversion fails.</TD>
336 </TR>
340 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getFloat(java.util.Map, java.lang.Object)">getFloat</A></B>(java.util.Map map,
343 <BR>
344 Gets a Float from a Map in a null-safe manner.</TD>
345 </TR>
349 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getFloat(java.util.Map, java.lang.Object, java.lang.Float)">getFloat</A></B>(java.util.Map map,
350 java.lang.Object key,
353 <BR>
354 Looks up the given key in the given map, converting the result into
355 a float, using the default value if the the conversion fails.</TD>
356 </TR>
360 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getFloatValue(java.util.Map, java.lang.Object)">getFloatValue</A></B>(java.util.Map map,
363 <BR>
364 Gets a float from a Map in a null-safe manner.</TD>
365 </TR>
369 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getFloatValue(java.util.Map, java.lang.Object, float)">getFloatValue</A></B>(java.util.Map map,
370 java.lang.Object key,
373 <BR>
374 Gets a float from a Map in a null-safe manner,
375 using the default value if the the conversion fails.</TD>
376 </TR>
380 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getInteger(java.util.Map, java.lang.Object)">getInteger</A></B>(java.util.Map map,
383 <BR>
384 Gets a Integer from a Map in a null-safe manner.</TD>
385 </TR>
389 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getInteger(java.util.Map, java.lang.Object, java.lang.Integer)">getInteger</A></B>(java.util.Map map,
390 java.lang.Object key,
393 <BR>
394 Looks up the given key in the given map, converting the result into
395 an integer, using the default value if the the conversion fails.</TD>
396 </TR>
400 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getIntValue(java.util.Map, java.lang.Object)">getIntValue</A></B>(java.util.Map map,
403 <BR>
404 Gets an int from a Map in a null-safe manner.</TD>
405 </TR>
409 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getIntValue(java.util.Map, java.lang.Object, int)">getIntValue</A></B>(java.util.Map map,
410 java.lang.Object key,
413 <BR>
414 Gets an int from a Map in a null-safe manner,
415 using the default value if the the conversion fails.</TD>
416 </TR>
420 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getLong(java.util.Map, java.lang.Object)">getLong</A></B>(java.util.Map map,
423 <BR>
424 Gets a Long from a Map in a null-safe manner.</TD>
425 </TR>
429 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getLong(java.util.Map, java.lang.Object, java.lang.Long)">getLong</A></B>(java.util.Map map,
430 java.lang.Object key,
433 <BR>
434 Looks up the given key in the given map, converting the result into
435 a long, using the default value if the the conversion fails.</TD>
436 </TR>
440 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getLongValue(java.util.Map, java.lang.Object)">getLongValue</A></B>(java.util.Map map,
443 <BR>
444 Gets a long from a Map in a null-safe manner.</TD>
445 </TR>
449 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getLongValue(java.util.Map, java.lang.Object, long)">getLongValue</A></B>(java.util.Map map,
450 java.lang.Object key,
453 <BR>
454 Gets a long from a Map in a null-safe manner,
455 using the default value if the the conversion fails.</TD>
456 </TR>
460 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getMap(java.util.Map, java.lang.Object)">getMap</A></B>(java.util.Map map,
463 <BR>
464 Gets a Map from a Map in a null-safe manner.</TD>
465 </TR>
469 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getMap(java.util.Map, java.lang.Object, java.util.Map)">getMap</A></B>(java.util.Map map,
470 java.lang.Object key,
473 <BR>
474 Looks up the given key in the given map, converting the result into
475 a map, using the default value if the the conversion fails.</TD>
476 </TR>
480 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)">getNumber</A></B>(java.util.Map map,
483 <BR>
484 Gets a Number from a Map in a null-safe manner.</TD>
485 </TR>
489 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object, java.lang.Number)">getNumber</A></B>(java.util.Map map,
490 java.lang.Object key,
493 <BR>
494 Looks up the given key in the given map, converting the result into
495 a number, using the default value if the the conversion fails.</TD>
496 </TR>
500 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getObject(java.util.Map, java.lang.Object)">getObject</A></B>(java.util.Map map,
503 <BR>
504 Gets from a Map in a null-safe manner.</TD>
505 </TR>
509 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getObject(java.util.Map, java.lang.Object, java.lang.Object)">getObject</A></B>(java.util.Map map,
510 java.lang.Object key,
513 <BR>
514 Looks up the given key in the given map, converting null into the
515 given default value.</TD>
516 </TR>
520 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getShort(java.util.Map, java.lang.Object)">getShort</A></B>(java.util.Map map,
523 <BR>
524 Gets a Short from a Map in a null-safe manner.</TD>
525 </TR>
529 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getShort(java.util.Map, java.lang.Object, java.lang.Short)">getShort</A></B>(java.util.Map map,
530 java.lang.Object key,
533 <BR>
534 Looks up the given key in the given map, converting the result into
535 a short, using the default value if the the conversion fails.</TD>
536 </TR>
540 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getShortValue(java.util.Map, java.lang.Object)">getShortValue</A></B>(java.util.Map map,
543 <BR>
544 Gets a short from a Map in a null-safe manner.</TD>
545 </TR>
549 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getShortValue(java.util.Map, java.lang.Object, short)">getShortValue</A></B>(java.util.Map map,
550 java.lang.Object key,
553 <BR>
554 Gets a short from a Map in a null-safe manner,
555 using the default value if the the conversion fails.</TD>
556 </TR>
560 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getString(java.util.Map, java.lang.Object)">getString</A></B>(java.util.Map map,
563 <BR>
564 Gets a String from a Map in a null-safe manner.</TD>
565 </TR>
569 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#getString(java.util.Map, java.lang.Object, java.lang.String)">getString</A></B>(java.util.Map map,
570 java.lang.Object key,
573 <BR>
574 Looks up the given key in the given map, converting the result into
575 a string, using the default value if the the conversion fails.</TD>
576 </TR>
580 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#invertMap(java.util.Map)">invertMap</A></B>(java.util.Map map)</CODE>
582 <BR>
583 Inverts the supplied map returning a new HashMap such that the keys of
584 the input are swapped with the values.</TD>
585 </TR>
589 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#isEmpty(java.util.Map)">isEmpty</A></B>(java.util.Map map)</CODE>
591 <BR>
592 Null-safe check if the specified map is empty.</TD>
593 </TR>
597 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#isNotEmpty(java.util.Map)">isNotEmpty</A></B>(java.util.Map map)</CODE>
599 <BR>
600 Null-safe check if the specified map is not empty.</TD>
601 </TR>
605 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#lazyMap(java.util.Map, org.apache.commons.collections.Factory)">lazyMap</A></B>(java.util.Map map,
606 <A HREF="../../../../org/apache/commons/collections/Factory.html" title="interface in org.apache.commons.collections">Factory</A> factory)</CODE>
608 <BR>
609 Returns a "lazy" map whose values will be created on demand.</TD>
610 </TR>
614 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#lazyMap(java.util.Map, org.apache.commons.collections.Transformer)">lazyMap</A></B>(java.util.Map map,
615 <A HREF="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections">Transformer</A> transformerFactory)</CODE>
617 <BR>
618 Returns a "lazy" map whose values will be created on demand.</TD>
619 </TR>
623 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#lazySortedMap(java.util.SortedMap, org.apache.commons.collections.Factory)">lazySortedMap</A></B>(java.util.SortedMap map,
624 <A HREF="../../../../org/apache/commons/collections/Factory.html" title="interface in org.apache.commons.collections">Factory</A> factory)</CODE>
626 <BR>
627 Returns a "lazy" sorted map whose values will be created on demand.</TD>
628 </TR>
632 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#lazySortedMap(java.util.SortedMap, org.apache.commons.collections.Transformer)">lazySortedMap</A></B>(java.util.SortedMap map,
633 <A HREF="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections">Transformer</A> transformerFactory)</CODE>
635 <BR>
636 Returns a "lazy" sorted map whose values will be created on demand.</TD>
637 </TR>
641 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#logInfo(java.lang.Exception)">logInfo</A></B>(java.lang.Exception ex)</CODE>
643 <BR>
644 Logs the given exception to <code>System.out</code>.</TD>
645 </TR>
649 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#multiValueMap(java.util.Map)">multiValueMap</A></B>(java.util.Map map)</CODE>
651 <BR>
652 Creates a mult-value map backed by the given map which returns
653 collections of type ArrayList.</TD>
654 </TR>
658 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#multiValueMap(java.util.Map, java.lang.Class)">multiValueMap</A></B>(java.util.Map map,
661 <BR>
662 Creates a multi-value map backed by the given map which returns
663 collections of the specified type.</TD>
664 </TR>
668 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#multiValueMap(java.util.Map, org.apache.commons.collections.Factory)">multiValueMap</A></B>(java.util.Map map,
669 <A HREF="../../../../org/apache/commons/collections/Factory.html" title="interface in org.apache.commons.collections">Factory</A> collectionFactory)</CODE>
671 <BR>
672 Creates a multi-value map backed by the given map which returns
673 collections created by the specified collection factory.</TD>
674 </TR>
678 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#orderedMap(java.util.Map)">orderedMap</A></B>(java.util.Map map)</CODE>
680 <BR>
681 Returns a map that maintains the order of keys that are added
682 backed by the given map.</TD>
683 </TR>
687 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#predicatedMap(java.util.Map, org.apache.commons.collections.Predicate, org.apache.commons.collections.Predicate)">predicatedMap</A></B>(java.util.Map map,
688 <A HREF="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</A> keyPred,
689 <A HREF="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</A> valuePred)</CODE>
691 <BR>
692 Returns a predicated (validating) map backed by the given map.</TD>
693 </TR>
697 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#predicatedSortedMap(java.util.SortedMap, org.apache.commons.collections.Predicate, org.apache.commons.collections.Predicate)">predicatedSortedMap</A></B>(java.util.SortedMap map,
698 <A HREF="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</A> keyPred,
699 <A HREF="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</A> valuePred)</CODE>
701 <BR>
702 Returns a predicated (validating) sorted map backed by the given map.</TD>
703 </TR>
707 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#putAll(java.util.Map, java.lang.Object[])">putAll</A></B>(java.util.Map map,
710 <BR>
711 Puts all the keys and values from the specified array into the map.</TD>
712 </TR>
716 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#safeAddToMap(java.util.Map, java.lang.Object, java.lang.Object)">safeAddToMap</A></B>(java.util.Map map,
717 java.lang.Object key,
720 <BR>
721 Protects against adding null values to a map.</TD>
722 </TR>
726 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#synchronizedMap(java.util.Map)">synchronizedMap</A></B>(java.util.Map map)</CODE>
728 <BR>
729 Returns a synchronized map backed by the given map.</TD>
730 </TR>
734 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#synchronizedSortedMap(java.util.SortedMap)">synchronizedSortedMap</A></B>(java.util.SortedMap map)</CODE>
736 <BR>
737 Returns a synchronized sorted map backed by the given sorted map.</TD>
738 </TR>
742 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#toMap(java.util.ResourceBundle)">toMap</A></B>(java.util.ResourceBundle resourceBundle)</CODE>
744 <BR>
745 Creates a new HashMap using data copied from a ResourceBundle.</TD>
746 </TR>
750 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#toProperties(java.util.Map)">toProperties</A></B>(java.util.Map map)</CODE>
752 <BR>
753 Gets a new Properties object initialised with the values from a Map.</TD>
754 </TR>
758 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#transformedMap(java.util.Map, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)">transformedMap</A></B>(java.util.Map map,
759 <A HREF="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections">Transformer</A> keyTransformer,
760 <A HREF="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections">Transformer</A> valueTransformer)</CODE>
762 <BR>
763 Returns a transformed map backed by the given map.</TD>
764 </TR>
768 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#transformedSortedMap(java.util.SortedMap, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)">transformedSortedMap</A></B>(java.util.SortedMap map,
769 <A HREF="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections">Transformer</A> keyTransformer,
770 <A HREF="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections">Transformer</A> valueTransformer)</CODE>
772 <BR>
773 Returns a transformed sorted map backed by the given map.</TD>
774 </TR>
778 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#typedMap(java.util.Map, java.lang.Class, java.lang.Class)">typedMap</A></B>(java.util.Map map,
779 java.lang.Class keyType,
782 <BR>
783 Returns a typed map backed by the given map.</TD>
784 </TR>
788 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#typedSortedMap(java.util.SortedMap, java.lang.Class, java.lang.Class)">typedSortedMap</A></B>(java.util.SortedMap map,
789 java.lang.Class keyType,
792 <BR>
793 Returns a typed sorted map backed by the given map.</TD>
794 </TR>
798 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#unmodifiableMap(java.util.Map)">unmodifiableMap</A></B>(java.util.Map map)</CODE>
800 <BR>
801 Returns an unmodifiable map backed by the given map.</TD>
802 </TR>
806 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#unmodifiableSortedMap(java.util.SortedMap)">unmodifiableSortedMap</A></B>(java.util.SortedMap map)</CODE>
808 <BR>
809 Returns an unmodifiable sorted map backed by the given sorted map.</TD>
810 </TR>
814 <TD><CODE><B><A HREF="../../../../org/apache/commons/collections/MapUtils.html#verbosePrint(java.io.PrintStream, java.lang.Object, java.util.Map)">verbosePrint</A></B>(java.io.PrintStream out,
815 java.lang.Object label,
818 <BR>
819 Prints the given map with nice line breaks.</TD>
820 </TR>
821 </TABLE>
826 </TR>
828 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
829 </TR>
830 </TABLE>
831
832 <P>
834 <!-- ============ FIELD DETAIL =========== -->
841 </TR>
842 </TABLE>
845 EMPTY_MAP</H3>
846 <PRE>
848 <DL>
849 <DD>An empty unmodifiable map.
850 This was not provided in JDK1.2.
851 <P>
852 <DL>
853 </DL>
854 </DL>
855 <HR>
858 EMPTY_SORTED_MAP</H3>
859 <PRE>
861 <DL>
862 <DD>An empty unmodifiable sorted map.
863 This is not provided in the JDK.
864 <P>
865 <DL>
866 </DL>
867 </DL>
869 <!-- ========= CONSTRUCTOR DETAIL ======== -->
876 </TR>
877 </TABLE>
880 MapUtils</H3>
881 <PRE>
883 <DL>
885 <P>
886 </DL>
888 <!-- ============ METHOD DETAIL ========== -->
895 </TR>
896 </TABLE>
899 getObject</H3>
900 <PRE>
903 <DL>
904 <DD>Gets from a Map in a null-safe manner.
905 <P>
906 <DD><DL>
907 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up
909 </DD>
910 </DL>
911 <HR>
914 getString</H3>
915 <PRE>
918 <DL>
919 <DD>Gets a String from a Map in a null-safe manner.
920 <p>
922 <P>
923 <DD><DL>
924 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up
925 <DT><B>Returns:</B><DD>the value in the Map as a String, <code>null</code> if null map input</DL>
926 </DD>
927 </DL>
928 <HR>
931 getBoolean</H3>
932 <PRE>
935 <DL>
936 <DD>Gets a Boolean from a Map in a null-safe manner.
937 <p>
944 <P>
945 <DD><DL>
946 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up
947 <DT><B>Returns:</B><DD>the value in the Map as a Boolean, <code>null</code> if null map input</DL>
948 </DD>
949 </DL>
950 <HR>
953 getNumber</H3>
954 <PRE>
957 <DL>
958 <DD>Gets a Number from a Map in a null-safe manner.
959 <p>
965 <P>
966 <DD><DL>
967 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up
968 <DT><B>Returns:</B><DD>the value in the Map as a Number, <code>null</code> if null map input</DL>
969 </DD>
970 </DL>
971 <HR>
974 getByte</H3>
975 <PRE>
978 <DL>
979 <DD>Gets a Byte from a Map in a null-safe manner.
980 <p>
981 The Byte is obtained from the results of <A HREF="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><CODE>getNumber(Map,Object)</CODE></A>.
982 <P>
983 <DD><DL>
984 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up
986 </DD>
987 </DL>
988 <HR>
991 getShort</H3>
992 <PRE>
995 <DL>
996 <DD>Gets a Short from a Map in a null-safe manner.
997 <p>
998 The Short is obtained from the results of <A HREF="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><CODE>getNumber(Map,Object)</CODE></A>.
999 <P>
1000 <DD><DL>
1001 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up
1002 <DT><B>Returns:</B><DD>the value in the Map as a Short, <code>null</code> if null map input</DL>
1003 </DD>
1004 </DL>
1005 <HR>
1008 getInteger</H3>
1009 <PRE>
1012 <DL>
1013 <DD>Gets a Integer from a Map in a null-safe manner.
1014 <p>
1015 The Integer is obtained from the results of <A HREF="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><CODE>getNumber(Map,Object)</CODE></A>.
1016 <P>
1017 <DD><DL>
1018 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up
1019 <DT><B>Returns:</B><DD>the value in the Map as a Integer, <code>null</code> if null map input</DL>
1020 </DD>
1021 </DL>
1022 <HR>
1025 getLong</H3>
1026 <PRE>
1029 <DL>
1030 <DD>Gets a Long from a Map in a null-safe manner.
1031 <p>
1032 The Long is obtained from the results of <A HREF="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><CODE>getNumber(Map,Object)</CODE></A>.
1033 <P>
1034 <DD><DL>
1035 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up
1036 <DT><B>Returns:</B><DD>the value in the Map as a Long, <code>null</code> if null map input</DL>
1037 </DD>
1038 </DL>
1039 <HR>
1042 getFloat</H3>
1043 <PRE>
1046 <DL>
1047 <DD>Gets a Float from a Map in a null-safe manner.
1048 <p>
1049 The Float is obtained from the results of <A HREF="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><CODE>getNumber(Map,Object)</CODE></A>.
1050 <P>
1051 <DD><DL>
1052 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up
1053 <DT><B>Returns:</B><DD>the value in the Map as a Float, <code>null</code> if null map input</DL>
1054 </DD>
1055 </DL>
1056 <HR>
1059 getDouble</H3>
1060 <PRE>
1063 <DL>
1064 <DD>Gets a Double from a Map in a null-safe manner.
1065 <p>
1066 The Double is obtained from the results of <A HREF="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><CODE>getNumber(Map,Object)</CODE></A>.
1067 <P>
1068 <DD><DL>
1069 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up
1070 <DT><B>Returns:</B><DD>the value in the Map as a Double, <code>null</code> if null map input</DL>
1071 </DD>
1072 </DL>
1073 <HR>
1076 getMap</H3>
1077 <PRE>
1080 <DL>
1081 <DD>Gets a Map from a Map in a null-safe manner.
1082 <p>
1083 If the value returned from the specified map is not a Map then
1085 <P>
1086 <DD><DL>
1087 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up
1089 </DD>
1090 </DL>
1091 <HR>
1094 getObject</H3>
1095 <PRE>
1097 java.lang.Object key,
1099 <DL>
1100 <DD>Looks up the given key in the given map, converting null into the
1101 given default value.
1102 <P>
1103 <DD><DL>
1104 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map whose value to look up<DD><CODE>key</CODE> - the key of the value to look up in that map<DD><CODE>defaultValue</CODE> - what to return if the value is null
1106 is null or the map is null</DL>
1107 </DD>
1108 </DL>
1109 <HR>
1112 getString</H3>
1113 <PRE>
1115 java.lang.Object key,
1117 <DL>
1118 <DD>Looks up the given key in the given map, converting the result into
1119 a string, using the default value if the the conversion fails.
1120 <P>
1121 <DD><DL>
1122 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map whose value to look up<DD><CODE>key</CODE> - the key of the value to look up in that map<DD><CODE>defaultValue</CODE> - what to return if the value is null or if the
1123 conversion fails
1125 original value is null, the map is null or the string conversion
1126 fails</DL>
1127 </DD>
1128 </DL>
1129 <HR>
1132 getBoolean</H3>
1133 <PRE>
1135 java.lang.Object key,
1137 <DL>
1138 <DD>Looks up the given key in the given map, converting the result into
1139 a boolean, using the default value if the the conversion fails.
1140 <P>
1141 <DD><DL>
1142 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map whose value to look up<DD><CODE>key</CODE> - the key of the value to look up in that map<DD><CODE>defaultValue</CODE> - what to return if the value is null or if the
1143 conversion fails
1145 original value is null, the map is null or the boolean conversion
1146 fails</DL>
1147 </DD>
1148 </DL>
1149 <HR>
1152 getNumber</H3>
1153 <PRE>
1155 java.lang.Object key,
1157 <DL>
1158 <DD>Looks up the given key in the given map, converting the result into
1159 a number, using the default value if the the conversion fails.
1160 <P>
1161 <DD><DL>
1162 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map whose value to look up<DD><CODE>key</CODE> - the key of the value to look up in that map<DD><CODE>defaultValue</CODE> - what to return if the value is null or if the
1163 conversion fails
1165 original value is null, the map is null or the number conversion
1166 fails</DL>
1167 </DD>
1168 </DL>
1169 <HR>
1172 getByte</H3>
1173 <PRE>
1175 java.lang.Object key,
1177 <DL>
1178 <DD>Looks up the given key in the given map, converting the result into
1179 a byte, using the default value if the the conversion fails.
1180 <P>
1181 <DD><DL>
1182 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map whose value to look up<DD><CODE>key</CODE> - the key of the value to look up in that map<DD><CODE>defaultValue</CODE> - what to return if the value is null or if the
1183 conversion fails
1185 original value is null, the map is null or the number conversion
1186 fails</DL>
1187 </DD>
1188 </DL>
1189 <HR>
1192 getShort</H3>
1193 <PRE>
1195 java.lang.Object key,
1197 <DL>
1198 <DD>Looks up the given key in the given map, converting the result into
1199 a short, using the default value if the the conversion fails.
1200 <P>
1201 <DD><DL>
1202 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map whose value to look up<DD><CODE>key</CODE> - the key of the value to look up in that map<DD><CODE>defaultValue</CODE> - what to return if the value is null or if the
1203 conversion fails
1205 original value is null, the map is null or the number conversion
1206 fails</DL>
1207 </DD>
1208 </DL>
1209 <HR>
1212 getInteger</H3>
1213 <PRE>
1215 java.lang.Object key,
1217 <DL>
1218 <DD>Looks up the given key in the given map, converting the result into
1219 an integer, using the default value if the the conversion fails.
1220 <P>
1221 <DD><DL>
1222 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map whose value to look up<DD><CODE>key</CODE> - the key of the value to look up in that map<DD><CODE>defaultValue</CODE> - what to return if the value is null or if the
1223 conversion fails
1225 original value is null, the map is null or the number conversion
1226 fails</DL>
1227 </DD>
1228 </DL>
1229 <HR>
1232 getLong</H3>
1233 <PRE>
1235 java.lang.Object key,
1237 <DL>
1238 <DD>Looks up the given key in the given map, converting the result into
1239 a long, using the default value if the the conversion fails.
1240 <P>
1241 <DD><DL>
1242 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map whose value to look up<DD><CODE>key</CODE> - the key of the value to look up in that map<DD><CODE>defaultValue</CODE> - what to return if the value is null or if the
1243 conversion fails
1245 original value is null, the map is null or the number conversion
1246 fails</DL>
1247 </DD>
1248 </DL>
1249 <HR>
1252 getFloat</H3>
1253 <PRE>
1255 java.lang.Object key,
1257 <DL>
1258 <DD>Looks up the given key in the given map, converting the result into
1259 a float, using the default value if the the conversion fails.
1260 <P>
1261 <DD><DL>
1262 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map whose value to look up<DD><CODE>key</CODE> - the key of the value to look up in that map<DD><CODE>defaultValue</CODE> - what to return if the value is null or if the
1263 conversion fails
1265 original value is null, the map is null or the number conversion
1266 fails</DL>
1267 </DD>
1268 </DL>
1269 <HR>
1272 getDouble</H3>
1273 <PRE>
1275 java.lang.Object key,
1277 <DL>
1278 <DD>Looks up the given key in the given map, converting the result into
1279 a double, using the default value if the the conversion fails.
1280 <P>
1281 <DD><DL>
1282 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map whose value to look up<DD><CODE>key</CODE> - the key of the value to look up in that map<DD><CODE>defaultValue</CODE> - what to return if the value is null or if the
1283 conversion fails
1285 original value is null, the map is null or the number conversion
1286 fails</DL>
1287 </DD>
1288 </DL>
1289 <HR>
1292 getMap</H3>
1293 <PRE>
1295 java.lang.Object key,
1297 <DL>
1298 <DD>Looks up the given key in the given map, converting the result into
1299 a map, using the default value if the the conversion fails.
1300 <P>
1301 <DD><DL>
1302 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map whose value to look up<DD><CODE>key</CODE> - the key of the value to look up in that map<DD><CODE>defaultValue</CODE> - what to return if the value is null or if the
1303 conversion fails
1305 original value is null, the map is null or the map conversion
1306 fails</DL>
1307 </DD>
1308 </DL>
1309 <HR>
1312 getBooleanValue</H3>
1313 <PRE>
1316 <DL>
1317 <DD>Gets a boolean from a Map in a null-safe manner.
1318 <p>
1325 <P>
1326 <DD><DL>
1327 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up
1328 <DT><B>Returns:</B><DD>the value in the Map as a Boolean, <code>false</code> if null map input</DL>
1329 </DD>
1330 </DL>
1331 <HR>
1334 getByteValue</H3>
1335 <PRE>
1338 <DL>
1339 <DD>Gets a byte from a Map in a null-safe manner.
1340 <p>
1341 The byte is obtained from the results of <A HREF="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><CODE>getNumber(Map,Object)</CODE></A>.
1342 <P>
1343 <DD><DL>
1344 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up
1346 </DD>
1347 </DL>
1348 <HR>
1351 getShortValue</H3>
1352 <PRE>
1355 <DL>
1356 <DD>Gets a short from a Map in a null-safe manner.
1357 <p>
1358 The short is obtained from the results of <A HREF="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><CODE>getNumber(Map,Object)</CODE></A>.
1359 <P>
1360 <DD><DL>
1361 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up
1363 </DD>
1364 </DL>
1365 <HR>
1368 getIntValue</H3>
1369 <PRE>
1372 <DL>
1373 <DD>Gets an int from a Map in a null-safe manner.
1374 <p>
1375 The int is obtained from the results of <A HREF="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><CODE>getNumber(Map,Object)</CODE></A>.
1376 <P>
1377 <DD><DL>
1378 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up
1380 </DD>
1381 </DL>
1382 <HR>
1385 getLongValue</H3>
1386 <PRE>
1389 <DL>
1390 <DD>Gets a long from a Map in a null-safe manner.
1391 <p>
1392 The long is obtained from the results of <A HREF="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><CODE>getNumber(Map,Object)</CODE></A>.
1393 <P>
1394 <DD><DL>
1395 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up
1397 </DD>
1398 </DL>
1399 <HR>
1402 getFloatValue</H3>
1403 <PRE>
1406 <DL>
1407 <DD>Gets a float from a Map in a null-safe manner.
1408 <p>
1409 The float is obtained from the results of <A HREF="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><CODE>getNumber(Map,Object)</CODE></A>.
1410 <P>
1411 <DD><DL>
1412 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up
1413 <DT><B>Returns:</B><DD>the value in the Map as a float, <code>0.0F</code> if null map input</DL>
1414 </DD>
1415 </DL>
1416 <HR>
1419 getDoubleValue</H3>
1420 <PRE>
1423 <DL>
1424 <DD>Gets a double from a Map in a null-safe manner.
1425 <p>
1426 The double is obtained from the results of <A HREF="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><CODE>getNumber(Map,Object)</CODE></A>.
1427 <P>
1428 <DD><DL>
1429 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up
1430 <DT><B>Returns:</B><DD>the value in the Map as a double, <code>0.0</code> if null map input</DL>
1431 </DD>
1432 </DL>
1433 <HR>
1436 getBooleanValue</H3>
1437 <PRE>
1439 java.lang.Object key,
1441 <DL>
1442 <DD>Gets a boolean from a Map in a null-safe manner,
1443 using the default value if the the conversion fails.
1444 <p>
1451 <P>
1452 <DD><DL>
1453 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up<DD><CODE>defaultValue</CODE> - return if the value is null or if the
1454 conversion fails
1455 <DT><B>Returns:</B><DD>the value in the Map as a Boolean, <code>defaultValue</code> if null map input</DL>
1456 </DD>
1457 </DL>
1458 <HR>
1461 getByteValue</H3>
1462 <PRE>
1464 java.lang.Object key,
1466 <DL>
1467 <DD>Gets a byte from a Map in a null-safe manner,
1468 using the default value if the the conversion fails.
1469 <p>
1470 The byte is obtained from the results of <A HREF="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><CODE>getNumber(Map,Object)</CODE></A>.
1471 <P>
1472 <DD><DL>
1473 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up<DD><CODE>defaultValue</CODE> - return if the value is null or if the
1474 conversion fails
1475 <DT><B>Returns:</B><DD>the value in the Map as a byte, <code>defaultValue</code> if null map input</DL>
1476 </DD>
1477 </DL>
1478 <HR>
1481 getShortValue</H3>
1482 <PRE>
1484 java.lang.Object key,
1486 <DL>
1487 <DD>Gets a short from a Map in a null-safe manner,
1488 using the default value if the the conversion fails.
1489 <p>
1490 The short is obtained from the results of <A HREF="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><CODE>getNumber(Map,Object)</CODE></A>.
1491 <P>
1492 <DD><DL>
1493 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up<DD><CODE>defaultValue</CODE> - return if the value is null or if the
1494 conversion fails
1495 <DT><B>Returns:</B><DD>the value in the Map as a short, <code>defaultValue</code> if null map input</DL>
1496 </DD>
1497 </DL>
1498 <HR>
1501 getIntValue</H3>
1502 <PRE>
1504 java.lang.Object key,
1506 <DL>
1507 <DD>Gets an int from a Map in a null-safe manner,
1508 using the default value if the the conversion fails.
1509 <p>
1510 The int is obtained from the results of <A HREF="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><CODE>getNumber(Map,Object)</CODE></A>.
1511 <P>
1512 <DD><DL>
1513 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up<DD><CODE>defaultValue</CODE> - return if the value is null or if the
1514 conversion fails
1515 <DT><B>Returns:</B><DD>the value in the Map as an int, <code>defaultValue</code> if null map input</DL>
1516 </DD>
1517 </DL>
1518 <HR>
1521 getLongValue</H3>
1522 <PRE>
1524 java.lang.Object key,
1526 <DL>
1527 <DD>Gets a long from a Map in a null-safe manner,
1528 using the default value if the the conversion fails.
1529 <p>
1530 The long is obtained from the results of <A HREF="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><CODE>getNumber(Map,Object)</CODE></A>.
1531 <P>
1532 <DD><DL>
1533 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up<DD><CODE>defaultValue</CODE> - return if the value is null or if the
1534 conversion fails
1535 <DT><B>Returns:</B><DD>the value in the Map as a long, <code>defaultValue</code> if null map input</DL>
1536 </DD>
1537 </DL>
1538 <HR>
1541 getFloatValue</H3>
1542 <PRE>
1544 java.lang.Object key,
1546 <DL>
1547 <DD>Gets a float from a Map in a null-safe manner,
1548 using the default value if the the conversion fails.
1549 <p>
1550 The float is obtained from the results of <A HREF="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><CODE>getNumber(Map,Object)</CODE></A>.
1551 <P>
1552 <DD><DL>
1553 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up<DD><CODE>defaultValue</CODE> - return if the value is null or if the
1554 conversion fails
1555 <DT><B>Returns:</B><DD>the value in the Map as a float, <code>defaultValue</code> if null map input</DL>
1556 </DD>
1557 </DL>
1558 <HR>
1561 getDoubleValue</H3>
1562 <PRE>
1564 java.lang.Object key,
1566 <DL>
1567 <DD>Gets a double from a Map in a null-safe manner,
1568 using the default value if the the conversion fails.
1569 <p>
1570 The double is obtained from the results of <A HREF="../../../../org/apache/commons/collections/MapUtils.html#getNumber(java.util.Map, java.lang.Object)"><CODE>getNumber(Map,Object)</CODE></A>.
1571 <P>
1572 <DD><DL>
1573 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to use<DD><CODE>key</CODE> - the key to look up<DD><CODE>defaultValue</CODE> - return if the value is null or if the
1574 conversion fails
1575 <DT><B>Returns:</B><DD>the value in the Map as a double, <code>defaultValue</code> if null map input</DL>
1576 </DD>
1577 </DL>
1578 <HR>
1581 toProperties</H3>
1582 <PRE>
1584 <DL>
1585 <DD>Gets a new Properties object initialised with the values from a Map.
1586 A null input will return an empty properties object.
1587 <P>
1588 <DD><DL>
1589 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to convert to a Properties object, may not be null
1591 </DD>
1592 </DL>
1593 <HR>
1596 toMap</H3>
1597 <PRE>
1599 <DL>
1600 <DD>Creates a new HashMap using data copied from a ResourceBundle.
1601 <P>
1602 <DD><DL>
1603 <DT><B>Parameters:</B><DD><CODE>resourceBundle</CODE> - the resource bundle to convert, may not be null
1607 </DD>
1608 </DL>
1609 <HR>
1612 verbosePrint</H3>
1613 <PRE>
1615 java.lang.Object label,
1617 <DL>
1618 <DD>Prints the given map with nice line breaks.
1619 <p>
1620 This method prints a nicely formatted String describing the Map.
1621 Each map entry will be printed with key and value.
1622 When the value is a Map, recursive behaviour occurs.
1623 <p>
1624 This method is NOT thread-safe in any special way. You must manually
1625 synchronize on either this class or the stream as required.
1626 <P>
1627 <DD><DL>
1628 <DT><B>Parameters:</B><DD><CODE>out</CODE> - the stream to print to, must not be null<DD><CODE>label</CODE> - The label to be used, may be <code>null</code>.
1630 It typically represents the name of the property in a bean or similar.<DD><CODE>map</CODE> - The map to print, may be <code>null</code>.
1634 </DD>
1635 </DL>
1636 <HR>
1639 debugPrint</H3>
1640 <PRE>
1642 java.lang.Object label,
1644 <DL>
1645 <DD>Prints the given map with nice line breaks.
1646 <p>
1647 This method prints a nicely formatted String describing the Map.
1648 Each map entry will be printed with key, value and value classname.
1649 When the value is a Map, recursive behaviour occurs.
1650 <p>
1651 This method is NOT thread-safe in any special way. You must manually
1652 synchronize on either this class or the stream as required.
1653 <P>
1654 <DD><DL>
1655 <DT><B>Parameters:</B><DD><CODE>out</CODE> - the stream to print to, must not be null<DD><CODE>label</CODE> - The label to be used, may be <code>null</code>.
1657 It typically represents the name of the property in a bean or similar.<DD><CODE>map</CODE> - The map to print, may be <code>null</code>.
1661 </DD>
1662 </DL>
1663 <HR>
1666 logInfo</H3>
1667 <PRE>
1669 <DL>
1671 <p>
1672 This method exists as Jakarta Collections does not depend on logging.
1673 <P>
1674 <DD><DL>
1676 </DD>
1677 </DL>
1678 <HR>
1681 invertMap</H3>
1682 <PRE>
1684 <DL>
1685 <DD>Inverts the supplied map returning a new HashMap such that the keys of
1686 the input are swapped with the values.
1687 <p>
1688 This operation assumes that the inverse mapping is well defined.
1689 If the input map had multiple entries with the same value mapped to
1690 different keys, the returned map will map one of those keys to the
1691 value, but the exact key which will be mapped is undefined.
1692 <P>
1693 <DD><DL>
1698 </DD>
1699 </DL>
1700 <HR>
1703 safeAddToMap</H3>
1704 <PRE>
1706 java.lang.Object key,
1707 java.lang.Object value)
1708 throws java.lang.NullPointerException</PRE>
1709 <DL>
1710 <DD>Protects against adding null values to a map.
1711 <p>
1712 This method checks the value being added to the map, and if it is null
1713 it is replaced by an empty string.
1714 <p>
1715 This could be useful if the map does not accept null values, or for
1716 receiving data from a source that may provide null or empty string
1717 which should be held in the same way in the map.
1718 <p>
1719 Keys are not validated.
1720 <P>
1721 <DD><DL>
1722 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to add to, may not be null<DD><CODE>key</CODE> - the key<DD><CODE>value</CODE> - the value, null converted to ""
1725 </DD>
1726 </DL>
1727 <HR>
1730 putAll</H3>
1731 <PRE>
1734 <DL>
1735 <DD>Puts all the keys and values from the specified array into the map.
1736 <p>
1738 method and constructors. It allows you to build a map from an object array
1739 of various possible styles.
1740 <p>
1742 or <A HREF="../../../../org/apache/commons/collections/KeyValue.html" title="interface in org.apache.commons.collections"><CODE>KeyValue</CODE></A> then the key and value are added from that object.
1743 If the first entry in the object array is an object array itself, then
1745 Otherwise, the array is treated as keys and values in alternate indices.
1746 <p>
1747 For example, to create a color map:
1748 <pre>
1749 Map colorMap = MapUtils.putAll(new HashMap(), new String[][] {
1753 });
1754 </pre>
1755 or:
1756 <pre>
1757 Map colorMap = MapUtils.putAll(new HashMap(), new String[] {
1761 });
1762 </pre>
1763 or:
1764 <pre>
1765 Map colorMap = MapUtils.putAll(new HashMap(), new Map.Entry[] {
1769 });
1770 </pre>
1771 <P>
1772 <DD><DL>
1773 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to populate, must not be null<DD><CODE>array</CODE> - an array to populate from, null ignored
1777 <DD><CODE>java.lang.IllegalArgumentException</CODE> - if sub-array or entry matching used and an
1778 entry is invalid
1779 <DD><CODE>java.lang.ClassCastException</CODE> - if the array contents is mixed<DT><B>Since:</B></DT>
1781 </DL>
1782 </DD>
1783 </DL>
1784 <HR>
1787 isEmpty</H3>
1788 <PRE>
1790 <DL>
1791 <DD>Null-safe check if the specified map is empty.
1792 <p>
1793 Null returns true.
1794 <P>
1795 <DD><DL>
1799 </DL>
1800 </DD>
1801 </DL>
1802 <HR>
1805 isNotEmpty</H3>
1806 <PRE>
1808 <DL>
1809 <DD>Null-safe check if the specified map is not empty.
1810 <p>
1811 Null returns false.
1812 <P>
1813 <DD><DL>
1817 </DL>
1818 </DD>
1819 </DL>
1820 <HR>
1823 synchronizedMap</H3>
1824 <PRE>
1826 <DL>
1827 <DD>Returns a synchronized map backed by the given map.
1828 <p>
1829 You must manually synchronize on the returned buffer's iterator to
1830 avoid non-deterministic behavior:
1832 <pre>
1833 Map m = MapUtils.synchronizedMap(myMap);
1834 Set s = m.keySet(); // outside synchronized block
1835 synchronized (m) { // synchronized on MAP!
1836 Iterator i = s.iterator();
1837 while (i.hasNext()) {
1838 process (i.next());
1839 }
1840 }
1841 </pre>
1844 <P>
1845 <DD><DL>
1850 </DD>
1851 </DL>
1852 <HR>
1855 unmodifiableMap</H3>
1856 <PRE>
1858 <DL>
1859 <DD>Returns an unmodifiable map backed by the given map.
1860 <p>
1861 This method uses the implementation in the decorators subpackage.
1862 <P>
1863 <DD><DL>
1868 </DD>
1869 </DL>
1870 <HR>
1872 <A NAME="predicatedMap(java.util.Map, org.apache.commons.collections.Predicate, org.apache.commons.collections.Predicate)"><!-- --></A><H3>
1873 predicatedMap</H3>
1874 <PRE>
1876 <A HREF="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</A> keyPred,
1877 <A HREF="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</A> valuePred)</PRE>
1878 <DL>
1879 <DD>Returns a predicated (validating) map backed by the given map.
1880 <p>
1881 Only objects that pass the tests in the given predicates can be added to the map.
1882 Trying to add an invalid object results in an IllegalArgumentException.
1883 Keys must pass the key predicate, values must pass the value predicate.
1884 It is important not to use the original map after invoking this method,
1885 as it is a backdoor for adding invalid objects.
1886 <P>
1887 <DD><DL>
1888 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to predicate, must not be null<DD><CODE>keyPred</CODE> - the predicate for keys, null means no check<DD><CODE>valuePred</CODE> - the predicate for values, null means no check
1892 </DD>
1893 </DL>
1894 <HR>
1897 typedMap</H3>
1898 <PRE>
1900 java.lang.Class keyType,
1902 <DL>
1903 <DD>Returns a typed map backed by the given map.
1904 <p>
1905 Only keys and values of the specified types can be added to the map.
1906 <P>
1907 <DD><DL>
1908 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to limit to a specific type, must not be null<DD><CODE>keyType</CODE> - the type of keys which may be added to the map, must not be null<DD><CODE>valueType</CODE> - the type of values which may be added to the map, must not be null
1912 </DD>
1913 </DL>
1914 <HR>
1916 <A NAME="transformedMap(java.util.Map, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)"><!-- --></A><H3>
1917 transformedMap</H3>
1918 <PRE>
1920 <A HREF="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections">Transformer</A> keyTransformer,
1921 <A HREF="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections">Transformer</A> valueTransformer)</PRE>
1922 <DL>
1923 <DD>Returns a transformed map backed by the given map.
1924 <p>
1925 This method returns a new map (decorating the specified map) that
1926 will transform any new entries added to it.
1927 Existing entries in the specified map will not be transformed.
1928 If you want that behaviour, see <A HREF="../../../../org/apache/commons/collections/map/TransformedMap.html#decorateTransform(java.util.Map, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)"><CODE>TransformedMap.decorateTransform(java.util.Map, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)</CODE></A>.
1929 <p>
1930 Each object is passed through the transformers as it is added to the
1931 Map. It is important not to use the original map after invoking this
1932 method, as it is a backdoor for adding untransformed objects.
1933 <p>
1934 If there are any elements already in the map being decorated, they
1935 are NOT transformed.
1936 <P>
1937 <DD><DL>
1938 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to transform, must not be null, typically empty<DD><CODE>keyTransformer</CODE> - the transformer for the map keys, null means no transformation<DD><CODE>valueTransformer</CODE> - the transformer for the map values, null means no transformation
1942 </DD>
1943 </DL>
1944 <HR>
1947 fixedSizeMap</H3>
1948 <PRE>
1950 <DL>
1951 <DD>Returns a fixed-sized map backed by the given map.
1952 Elements may not be added or removed from the returned map, but
1953 existing elements can be changed (for instance, via the
1955 <P>
1956 <DD><DL>
1961 </DD>
1962 </DL>
1963 <HR>
1966 lazyMap</H3>
1967 <PRE>
1969 <A HREF="../../../../org/apache/commons/collections/Factory.html" title="interface in org.apache.commons.collections">Factory</A> factory)</PRE>
1970 <DL>
1972 <p>
1974 method is not present in the map, then the factory will be used
1975 to create a new object and that object will become the value
1976 associated with that key.
1977 <p>
1978 For instance:
1979 <pre>
1980 Factory factory = new Factory() {
1981 public Object create() {
1982 return new Date();
1983 }
1984 }
1985 Map lazyMap = MapUtils.lazyMap(new HashMap(), factory);
1986 Object obj = lazyMap.get("test");
1987 </pre>
1992 <P>
1993 <DD><DL>
1994 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to make lazy, must not be null<DD><CODE>factory</CODE> - the factory for creating new objects, must not be null
1998 </DD>
1999 </DL>
2000 <HR>
2003 lazyMap</H3>
2004 <PRE>
2006 <A HREF="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections">Transformer</A> transformerFactory)</PRE>
2007 <DL>
2009 <p>
2011 method is not present in the map, then the factory will be used
2012 to create a new object and that object will become the value
2013 associated with that key. The factory is a <A HREF="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections"><CODE>Transformer</CODE></A>
2014 that will be passed the key which it must transform into the value.
2015 <p>
2016 For instance:
2017 <pre>
2018 Transformer factory = new Transformer() {
2019 public Object transform(Object mapKey) {
2020 return new File(mapKey);
2021 }
2022 }
2023 Map lazyMap = MapUtils.lazyMap(new HashMap(), factory);
2024 Object obj = lazyMap.get("C:/dev");
2025 </pre>
2031 <p>
2032 If a lazy map is wrapped by a synchronized map, the result is a simple
2033 synchronized cache. When an object is not is the cache, the cache itself
2034 calls back to the factory Transformer to populate itself, all within the
2035 same synchronized block.
2036 <P>
2037 <DD><DL>
2038 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to make lazy, must not be null<DD><CODE>transformerFactory</CODE> - the factory for creating new objects, must not be null
2042 </DD>
2043 </DL>
2044 <HR>
2047 orderedMap</H3>
2048 <PRE>
2050 <DL>
2051 <DD>Returns a map that maintains the order of keys that are added
2052 backed by the given map.
2053 <p>
2054 If a key is added twice, the order is determined by the first add.
2055 The order is observed through the keySet, values and entrySet.
2056 <P>
2057 <DD><DL>
2062 </DD>
2063 </DL>
2064 <HR>
2067 multiValueMap</H3>
2068 <PRE>
2070 <DL>
2071 <DD>Creates a mult-value map backed by the given map which returns
2072 collections of type ArrayList.
2073 <P>
2074 <DD><DL>
2076 <DT><B>Returns:</B><DD>a multi-value map backed by the given map which returns ArrayLists of values.<DT><B>Since:</B></DT>
2078 <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/commons/collections/map/MultiValueMap.html" title="class in org.apache.commons.collections.map"><CODE>MultiValueMap</CODE></A></DL>
2079 </DD>
2080 </DL>
2081 <HR>
2084 multiValueMap</H3>
2085 <PRE>
2088 <DL>
2089 <DD>Creates a multi-value map backed by the given map which returns
2090 collections of the specified type.
2091 <P>
2092 <DD><DL>
2093 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to decorate<DD><CODE>collectionClass</CODE> - the type of collections to return from the map (must contain public no-arg constructor
2094 and extend Collection).
2095 <DT><B>Returns:</B><DD>a multi-value map backed by the given map which returns collections of the specified type<DT><B>Since:</B></DT>
2097 <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/commons/collections/map/MultiValueMap.html" title="class in org.apache.commons.collections.map"><CODE>MultiValueMap</CODE></A></DL>
2098 </DD>
2099 </DL>
2100 <HR>
2102 <A NAME="multiValueMap(java.util.Map, org.apache.commons.collections.Factory)"><!-- --></A><H3>
2103 multiValueMap</H3>
2104 <PRE>
2106 <A HREF="../../../../org/apache/commons/collections/Factory.html" title="interface in org.apache.commons.collections">Factory</A> collectionFactory)</PRE>
2107 <DL>
2108 <DD>Creates a multi-value map backed by the given map which returns
2109 collections created by the specified collection factory.
2110 <P>
2111 <DD><DL>
2112 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to decorate<DD><CODE>collectionFactory</CODE> - a factor which creates collection objects
2116 <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/commons/collections/map/MultiValueMap.html" title="class in org.apache.commons.collections.map"><CODE>MultiValueMap</CODE></A></DL>
2117 </DD>
2118 </DL>
2119 <HR>
2122 synchronizedSortedMap</H3>
2123 <PRE>
2125 <DL>
2126 <DD>Returns a synchronized sorted map backed by the given sorted map.
2127 <p>
2128 You must manually synchronize on the returned buffer's iterator to
2129 avoid non-deterministic behavior:
2131 <pre>
2132 Map m = MapUtils.synchronizedSortedMap(myMap);
2133 Set s = m.keySet(); // outside synchronized block
2134 synchronized (m) { // synchronized on MAP!
2135 Iterator i = s.iterator();
2136 while (i.hasNext()) {
2137 process (i.next());
2138 }
2139 }
2140 </pre>
2143 <P>
2144 <DD><DL>
2149 </DD>
2150 </DL>
2151 <HR>
2154 unmodifiableSortedMap</H3>
2155 <PRE>
2157 <DL>
2158 <DD>Returns an unmodifiable sorted map backed by the given sorted map.
2159 <p>
2160 This method uses the implementation in the decorators subpackage.
2161 <P>
2162 <DD><DL>
2163 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the sorted map to make unmodifiable, must not be null
2167 </DD>
2168 </DL>
2169 <HR>
2171 <A NAME="predicatedSortedMap(java.util.SortedMap, org.apache.commons.collections.Predicate, org.apache.commons.collections.Predicate)"><!-- --></A><H3>
2172 predicatedSortedMap</H3>
2173 <PRE>
2175 <A HREF="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</A> keyPred,
2176 <A HREF="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</A> valuePred)</PRE>
2177 <DL>
2178 <DD>Returns a predicated (validating) sorted map backed by the given map.
2179 <p>
2180 Only objects that pass the tests in the given predicates can be added to the map.
2181 Trying to add an invalid object results in an IllegalArgumentException.
2182 Keys must pass the key predicate, values must pass the value predicate.
2183 It is important not to use the original map after invoking this method,
2184 as it is a backdoor for adding invalid objects.
2185 <P>
2186 <DD><DL>
2187 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to predicate, must not be null<DD><CODE>keyPred</CODE> - the predicate for keys, null means no check<DD><CODE>valuePred</CODE> - the predicate for values, null means no check
2191 </DD>
2192 </DL>
2193 <HR>
2195 <A NAME="typedSortedMap(java.util.SortedMap, java.lang.Class, java.lang.Class)"><!-- --></A><H3>
2196 typedSortedMap</H3>
2197 <PRE>
2199 java.lang.Class keyType,
2201 <DL>
2202 <DD>Returns a typed sorted map backed by the given map.
2203 <p>
2204 Only keys and values of the specified types can be added to the map.
2205 <P>
2206 <DD><DL>
2207 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to limit to a specific type, must not be null<DD><CODE>keyType</CODE> - the type of keys which may be added to the map, must not be null<DD><CODE>valueType</CODE> - the type of values which may be added to the map, must not be null
2209 </DD>
2210 </DL>
2211 <HR>
2213 <A NAME="transformedSortedMap(java.util.SortedMap, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)"><!-- --></A><H3>
2214 transformedSortedMap</H3>
2215 <PRE>
2217 <A HREF="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections">Transformer</A> keyTransformer,
2218 <A HREF="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections">Transformer</A> valueTransformer)</PRE>
2219 <DL>
2220 <DD>Returns a transformed sorted map backed by the given map.
2221 <p>
2222 This method returns a new sorted map (decorating the specified map) that
2223 will transform any new entries added to it.
2224 Existing entries in the specified map will not be transformed.
2225 If you want that behaviour, see <A HREF="../../../../org/apache/commons/collections/map/TransformedSortedMap.html#decorateTransform(java.util.SortedMap, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)"><CODE>TransformedSortedMap.decorateTransform(java.util.SortedMap, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)</CODE></A>.
2226 <p>
2227 Each object is passed through the transformers as it is added to the
2228 Map. It is important not to use the original map after invoking this
2229 method, as it is a backdoor for adding untransformed objects.
2230 <p>
2231 If there are any elements already in the map being decorated, they
2232 are NOT transformed.
2233 <P>
2234 <DD><DL>
2235 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to transform, must not be null, typically empty<DD><CODE>keyTransformer</CODE> - the transformer for the map keys, null means no transformation<DD><CODE>valueTransformer</CODE> - the transformer for the map values, null means no transformation
2239 </DD>
2240 </DL>
2241 <HR>
2244 fixedSizeSortedMap</H3>
2245 <PRE>
2246 public static java.util.SortedMap <B>fixedSizeSortedMap</B>(java.util.SortedMap map)</PRE>
2247 <DL>
2248 <DD>Returns a fixed-sized sorted map backed by the given sorted map.
2249 Elements may not be added or removed from the returned map, but
2250 existing elements can be changed (for instance, via the
2252 <P>
2253 <DD><DL>
2258 </DD>
2259 </DL>
2260 <HR>
2262 <A NAME="lazySortedMap(java.util.SortedMap, org.apache.commons.collections.Factory)"><!-- --></A><H3>
2263 lazySortedMap</H3>
2264 <PRE>
2266 <A HREF="../../../../org/apache/commons/collections/Factory.html" title="interface in org.apache.commons.collections">Factory</A> factory)</PRE>
2267 <DL>
2269 <p>
2271 method is not present in the map, then the factory will be used
2272 to create a new object and that object will become the value
2273 associated with that key.
2274 <p>
2275 For instance:
2277 <pre>
2278 Factory factory = new Factory() {
2279 public Object create() {
2280 return new Date();
2281 }
2282 }
2283 SortedMap lazy = MapUtils.lazySortedMap(new TreeMap(), factory);
2284 Object obj = lazy.get("test");
2285 </pre>
2290 <P>
2291 <DD><DL>
2292 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to make lazy, must not be null<DD><CODE>factory</CODE> - the factory for creating new objects, must not be null
2296 </DD>
2297 </DL>
2298 <HR>
2300 <A NAME="lazySortedMap(java.util.SortedMap, org.apache.commons.collections.Transformer)"><!-- --></A><H3>
2301 lazySortedMap</H3>
2302 <PRE>
2304 <A HREF="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections">Transformer</A> transformerFactory)</PRE>
2305 <DL>
2307 <p>
2309 method is not present in the map, then the factory will be used
2310 to create a new object and that object will become the value
2311 associated with that key. The factory is a <A HREF="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections"><CODE>Transformer</CODE></A>
2312 that will be passed the key which it must transform into the value.
2313 <p>
2314 For instance:
2315 <pre>
2316 Transformer factory = new Transformer() {
2317 public Object transform(Object mapKey) {
2318 return new File(mapKey);
2319 }
2320 }
2321 SortedMap lazy = MapUtils.lazySortedMap(new TreeMap(), factory);
2322 Object obj = lazy.get("C:/dev");
2323 </pre>
2329 <p>
2330 If a lazy map is wrapped by a synchronized map, the result is a simple
2331 synchronized cache. When an object is not is the cache, the cache itself
2332 calls back to the factory Transformer to populate itself, all within the
2333 same synchronized block.
2334 <P>
2335 <DD><DL>
2336 <DT><B>Parameters:</B><DD><CODE>map</CODE> - the map to make lazy, must not be null<DD><CODE>transformerFactory</CODE> - the factory for creating new objects, must not be null
2340 </DD>
2341 </DL>
2342 <!-- ========= END OF CLASS DATA ========= -->
2343 <HR>
2346 <!-- ======= START OF BOTTOM NAVBAR ====== -->
2350 <TR>
2355 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
2356 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
2357 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
2358 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MapUtils.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
2359 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
2360 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
2361 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
2362 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
2363 </TR>
2364 </TABLE>
2365 </TD>
2367 </EM>
2368 </TD>
2369 </TR>
2371 <TR>
2373 <A HREF="../../../../org/apache/commons/collections/MapIterator.html" title="interface in org.apache.commons.collections"><B>PREV CLASS</B></A>
2374 <A HREF="../../../../org/apache/commons/collections/MultiHashMap.html" title="class in org.apache.commons.collections"><B>NEXT CLASS</B></A></FONT></TD>
2376 <A HREF="../../../../index.html?org/apache/commons/collections/MapUtils.html" target="_top"><B>FRAMES</B></A>
2379 <!--
2380 if(window==top) {
2381 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
2382 }
2383 //-->
2384 </SCRIPT>
2385 <NOSCRIPT>
2387 </NOSCRIPT>
2390 </FONT></TD>
2391 </TR>
2392 <TR>
2394 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
2396 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
2397 </TR>
2398 </TABLE>
2400 <!-- ======== END OF BOTTOM NAVBAR ======= -->
2402 <HR>
2403 Copyright © 2001-2008 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
2404 </BODY>
2405 </HTML>