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

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 3.0, 3.1, 3.2
• Fix Version/s: 4.0-alpha1, 4.0
• Component/s: Collection
• Labels: code javadoc synchronizedMap

Environment

Platform independent

• Assignee: Unassigned
• Reporter: SHIN HWEI TAN
• Created: 26/Oct/11 20:21
• Updated: 09/Nov/14 14:31
• Resolved: 29/Oct/11 20:54

Description

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".