[COLLECTIONS-401] Inconsistent Javadoc comment and code in removeAll(Collection<E>, Collection<?>) in org.apache.commons.collections.ListUtils

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Not A Problem
• Affects Version/s: 3.2.1
• Component/s: Collection
• Labels: javadoc
• Assignee: Unassigned
• Reporter: SHIN HWEI TAN
• Created: 30/Mar/12 03:02
• Updated: 27/Nov/15 21:47
• Resolved: 26/Jul/12 21:02

Description

The Javadoc comment below states that the method "throws NullPointerException if either parameter is null".
/*......

• @throws NullPointerException if either parameter is null
  */
  public static <E> List<E> removeAll(Collection<E> collection, Collection<?> remove) { .. }

  However, when called with two null collections (i.e., "removeAll((Collection)null, (Collection)null)"), the method executes normally without throwing any exception.

Suggested Fixes:
1. Add code "if (collection == null) throw NullPointerException();" at the beginning of the method body.
or
2. Remove "@throws NullPointerException if either parameter is null" from the Javadoc.
or
3. Change "@throws NullPointerException if either parameter is null" to "@throws NullPointerException if the first collection is null or (the first collection is non-empty and the second collection is null)".