Apache
/
commons-collections
mirror of https://github.com/apache/commons-collections.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[COLLECTIONS-379] Fixed javadoc in CollectionUtils. 

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/trunk@1366204 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Thomas Neidhart 2012-07-26 21:18:24 +00:00
parent 4303c163b1
commit 88b7b4b3a0
2 changed files with 16 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/changes/changes.xml
View File

@ -22,6 +22,9 @@
<body> <body>
<release version="4.0" date="TBA" description="Next release"> <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"> <action dev="luc" issue="COLLECTIONS-404" type="add" due-to="Jordane Sarda">
Added an implementation of Eugene Myers difference algorithm. Added an implementation of Eugene Myers difference algorithm.
</action> </action>

20
src/main/java/org/apache/commons/collections/CollectionUtils.java
View File

@ -610,8 +610,9 @@ public class CollectionUtils {
* @param predicate * @param predicate
* the predicate to use, may be null * the predicate to use, may be null
* @param outputCollection * @param outputCollection
* the collection to output into, may not be null * the collection to output into, may not be null if the inputCollection
* @return outputCollection * and predicate or not null
* @return the outputCollection
*/ */
public static <O, R extends Collection<? super O>> R select(Collection<? extends O> inputCollection, public static <O, R extends Collection<? super O>> R select(Collection<? extends O> inputCollection,
Predicate<? super O> predicate, R outputCollection) { Predicate<? super O> predicate, R outputCollection) {
@ -657,7 +658,8 @@ public class CollectionUtils {
* @param predicate * @param predicate
* the predicate to use, may be null * the predicate to use, may be null
* @param outputCollection * @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 * @return outputCollection
*/ */
public static <O, R extends Collection<? super O>> R selectRejected( 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 inputCollection the collection to get the input from, may be null
* @param transformer the transformer to use, 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 <I> the type of object in the input collection
* @param <O> the type of object in the output collection * @param <O> the type of object in the output collection
* @param <R> the output type of the transformer - this extends O. * @param <R> the output type of the transformer - this extends O.
* @return the outputCollection with the transformed input added * @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, 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) { 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 inputIterator the iterator to get the input from, may be null
* @param transformer the transformer to use, 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 <I> the type of object in the input collection
* @param <O> the type of object in the output collection * @param <O> the type of object in the output collection
* @param <R> the output type of the transformer - this extends O. * @param <R> the output type of the transformer - this extends O.
* @return the outputCollection with the transformed input added * @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 //TODO - deprecate and replace with IteratorIterable
public static <I, O, R extends Collection<? super O>> R collect(Iterator<? extends I> inputIterator, public static <I, O, R extends Collection<? super O>> R collect(Iterator<? extends I> inputIterator,