cvs commit: jakarta-commons/collections/src/java/org/apache/commons/collections MapUtils.java

[sc...@apache.org]

scolebourne    2003/09/09 14:05:51

  Modified:    collections/src/java/org/apache/commons/collections
                        MapUtils.java
  Log:
  Javadoc fixes
  bug 22972, from Janek Bogucki
  
  Revision  Changes    Path
  1.33      +7 -8      jakarta-commons/collections/src/java/org/apache/commons/collections/MapUtils.java
  
  Index: MapUtils.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/MapUtils.java,v
  retrieving revision 1.32
  retrieving revision 1.33
  diff -u -r1.32 -r1.33
  --- MapUtils.java	31 Aug 2003 17:52:13 -0000	1.32
  +++ MapUtils.java	9 Sep 2003 21:05:51 -0000	1.33
  @@ -640,7 +640,6 @@
        * 
        * @param map  the map to convert to a Properties object, may not be null
        * @return the properties object
  -     * @throws NullPointerException if the map is null
        */
       public static Properties toProperties(Map map) {
           Properties answer = new Properties();
  @@ -940,7 +939,7 @@
        * Map. It is important not to use the original map after invoking this 
        * method, as it is a backdoor for adding untransformed objects.
        *
  -     * @param map  the map to predicate, must not be null
  +     * @param map  the map to transform, must not be null
        * @param keyTransformer  the transformer for the map keys, null means no transformation
        * @param valueTransformer  the transformer for the map values, null means no transformation
        * @return a transformed map backed by the given map
  @@ -1113,11 +1112,11 @@
        * Map. It is important not to use the original map after invoking this 
        * method, as it is a backdoor for adding untransformed objects.
        *
  -     * @param map  the map to predicate, must not be null
  +     * @param map  the map to transform, must not be null
        * @param keyTransformer  the transformer for the map keys, null means no transformation
        * @param valueTransformer  the transformer for the map values, null means no transformation
        * @return a transformed map backed by the given map
  -     * @throws IllegalArgumentException  if the Map is null
  +     * @throws IllegalArgumentException  if the SortedMap is null
        */
       public static SortedMap transformedSortedMap(SortedMap map, Transformer keyTransformer, Transformer valueTransformer) {
           return TransformedSortedMap.decorate(map, keyTransformer, valueTransformer);
  @@ -1186,8 +1185,8 @@
        *         return new File(mapKey);
        *     }
        * }
  -     * Map lazyMap = MapUtils.lazyMap(new HashMap(), factory);
  -     * Object obj = lazyMap.get("C:/dev");
  +     * SortedMap lazy = MapUtils.lazySortedMap(new TreeMap(), factory);
  +     * Object obj = lazy.get("C:/dev");
        * </pre>
        *
        * After the above code is executed, <code>obj</code> will contain