[GitHub] [commons-collections] anantdamle commented on a change in pull request #238: [COLLECTIONS-795] Add a new Iterator to allowing zipping over two iterators of different types

[GitBox]

anantdamle commented on a change in pull request #238:
URL: 
https://github.com/apache/commons-collections/pull/238#discussion_r643602080



##########
File path: src/main/java/org/apache/commons/collections4/IteratorUtils.java
##########
@@ -907,6 +908,20 @@ public static NodeListIterator nodeListIterator(final Node 
node) {
         return new ZippingIterator<>(iterators);
     }
 
+    /**
+     * Returns an iterator that provides the elements contained in a pair of 
Iterators.
+     *
+     * @param <L> the left elements' type
+     * @param <R> the right elements' type
+     * @param left the iterator for the left side elements
+     * @param right the iterator for the right side elements
+     * @return an iterator, to iterate over the decorated iterators together 
until one is exhausted
+     * @throws NullPointerException if any iterator is null

Review comment:
       Added a more descriptive Javadoc.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org