[jira] [Resolved] (COLLECTIONS-384) Inconsistent Javadoc comment and code for synchronizedMap(Map) in org.apache.commons.collections.MapUtils

["Gary D. Gregory (Resolved) (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/COLLECTIONS-384?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Gary D. Gregory resolved COLLECTIONS-384.
-----------------------------------------

    Resolution: Fixed

Committed revision 1195031.
                
> Inconsistent Javadoc comment and code for synchronizedMap(Map) in org.apache.commons.collections.MapUtils
> ---------------------------------------------------------------------------------------------------------
>
>                 Key: COLLECTIONS-384
>                 URL: https://issues.apache.org/jira/browse/COLLECTIONS-384
>             Project: Commons Collections
>          Issue Type: Bug
>          Components: Collection
>    Affects Versions: 3.0, 3.1, 3.2
>         Environment: Platform independent
>            Reporter: SHIN HWEI TAN
>              Labels: code, javadoc, synchronizedMap
>   Original Estimate: 5m
>  Remaining Estimate: 5m
>
> The Javadoc comment below states that the method "throws IllegalArgumentException if the map is null":
>     /**
>      ...
>      * @param map  the map to synchronize, must not be null
>      * @return a synchronized map backed by the given map
>      * @throws IllegalArgumentException  if the map is null
>      */
>     public static Map synchronizedMap(Map map) {
>         return Collections.synchronizedMap(map);
>     }
> However, the method throws NullPointerException instead of IllegalArgumentException when called with null.
> Suggested Fixes:
> 1. Add code "if (map == null) throw IllegalArgumentException();" at the beginning of the method body.
> or
> 2. Change "@throws IllegalArgumentException  if the map is null" to "@throws NullPointerException  if the map is null".
> or
> 3. Remove the entire "@throws IllegalArgumentException  if the map is null".

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira