You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by tn...@apache.org on 2012/07/26 23:18:24 UTC

svn commit: r1366204 - in /commons/proper/collections/trunk/src: changes/changes.xml main/java/org/apache/commons/collections/CollectionUtils.java

Author: tn
Date: Thu Jul 26 21:18:24 2012
New Revision: 1366204

URL: http://svn.apache.org/viewvc?rev=1366204&view=rev
Log:
[COLLECTIONS-379] Fixed javadoc in CollectionUtils.

Modified:
    commons/proper/collections/trunk/src/changes/changes.xml
    commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/CollectionUtils.java

Modified: commons/proper/collections/trunk/src/changes/changes.xml
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/changes/changes.xml?rev=1366204&r1=1366203&r2=1366204&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/changes/changes.xml (original)
+++ commons/proper/collections/trunk/src/changes/changes.xml Thu Jul 26 21:18:24 2012
@@ -22,6 +22,9 @@
   <body>
 
   <release version="4.0" date="TBA" description="Next release">
+    <action dev="luc" issue="COLLECTIONS-379" type="fix" due-to="Shin Hwei Tan">
+      Fixed javadoc for several methods wrt expected NullPointerExceptions.
+    </action>
     <action dev="luc" issue="COLLECTIONS-404" type="add" due-to="Jordane Sarda">
       Added an implementation of Eugene Myers difference algorithm.
     </action>

Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/CollectionUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/CollectionUtils.java?rev=1366204&r1=1366203&r2=1366204&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/CollectionUtils.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/CollectionUtils.java Thu Jul 26 21:18:24 2012
@@ -610,8 +610,9 @@ public class CollectionUtils {
      * @param predicate
      *            the predicate to use, may be null
      * @param outputCollection
-     *            the collection to output into, may not be null
-     * @return outputCollection
+     *            the collection to output into, may not be null if the inputCollection
+     *            and predicate or not null
+     * @return the outputCollection
      */
     public static <O, R extends Collection<? super O>> R select(Collection<? extends O> inputCollection,
             Predicate<? super O> predicate, R outputCollection) {
@@ -657,7 +658,8 @@ public class CollectionUtils {
      * @param predicate
      *            the predicate to use, may be null
      * @param outputCollection
-     *            the collection to output into, may not be null
+     *            the collection to output into, may not be null if the inputCollection
+     *            and predicate or not null
      * @return outputCollection
      */
     public static <O, R extends Collection<? super O>> R selectRejected(
@@ -726,12 +728,14 @@ public class CollectionUtils {
      *
      * @param inputCollection  the collection to get the input from, may be null
      * @param transformer  the transformer to use, may be null
-     * @param outputCollection  the collection to output into, may not be null
+     * @param outputCollection  the collection to output into, may not be null if the inputCollection
+     *   and transformer are not null
      * @param <I> the type of object in the input collection
      * @param <O> the type of object in the output collection
      * @param <R> the output type of the transformer - this extends O.
      * @return the outputCollection with the transformed input added
-     * @throws NullPointerException if the output collection is null
+     * @throws NullPointerException if the output collection is null and both, inputCollection and
+     *   transformer are not null
      */
     public static <I, O, R extends Collection<? super O>> R collect(Iterable<? extends I> inputCollection,
             final Transformer<? super I, ? extends O> transformer, final R outputCollection) {
@@ -750,12 +754,14 @@ public class CollectionUtils {
      *
      * @param inputIterator  the iterator to get the input from, may be null
      * @param transformer  the transformer to use, may be null
-     * @param outputCollection  the collection to output into, may not be null
+     * @param outputCollection  the collection to output into, may not be null if the inputCollection
+     *   and transformer are not null
      * @param <I> the type of object in the input collection
      * @param <O> the type of object in the output collection
      * @param <R> the output type of the transformer - this extends O.
      * @return the outputCollection with the transformed input added
-     * @throws NullPointerException if the output collection is null
+     * @throws NullPointerException if the output collection is null and both, inputCollection and
+     *   transformer are not null
      */
     //TODO - deprecate and replace with IteratorIterable
     public static <I, O, R extends Collection<? super O>> R collect(Iterator<? extends I> inputIterator,