[
https://issues.apache.org/jira/browse/COLLECTIONS-795?focusedWorklogId=604898&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-604898
]
ASF GitHub Bot logged work on COLLECTIONS-795:
----------------------------------------------
Author: ASF GitHub Bot
Created on: 02/Jun/21 02:11
Start Date: 02/Jun/21 02:11
Worklog Time Spent: 10m
Work Description: 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:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 604898)
Time Spent: 3h 50m (was: 3h 40m)
> provide a PairIterator to zip two iterators of different types.
> ---------------------------------------------------------------
>
> Key: COLLECTIONS-795
> URL: https://issues.apache.org/jira/browse/COLLECTIONS-795
> Project: Commons Collections
> Issue Type: New Feature
> Components: Iterator
> Reporter: Anant Damle
> Priority: Minor
> Time Spent: 3h 50m
> Remaining Estimate: 0h
>
> ZippingIterator provides a way to simulatenously iterate over multiple
> iterators of the *same-type.*
> The proposed pair iterator allows simultaneously iterating over two iterators
> of different type, like the example below:
> {code:java}
> Iterator<L> leftIterator = ...;
> Iterator<R> rightIterator = ...;
> PairIterator<L,R> pairIterator = PairIterator.of(leftIterator, rightIterator);
> while (pairIterator.hasNext()) {
> ImmutablePair<L,R> item = pairIterator.next();
> ...
> }{code}
>
> Another convenience could be to use an Iterable for easy for-each constructs.
> {code:java}
> List<Integer> studentIds = ...
> List<String> studentNames = ...
> for (PairedItem<Integer, String> items :
> IterableUtils.pairedIterable(studentIds, studentNames) {
> Integer studentId = item.getLeft();
> String studentName = item.getRight();
> ...
> }
> {code}
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
