[
https://issues.apache.org/jira/browse/COLLECTIONS-795?focusedWorklogId=602591&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-602591
]
ASF GitHub Bot logged work on COLLECTIONS-795:
----------------------------------------------
Author: ASF GitHub Bot
Created on: 26/May/21 21:42
Start Date: 26/May/21 21:42
Worklog Time Spent: 10m
Work Description: kinow commented on a change in pull request #238:
URL:
https://github.com/apache/commons-collections/pull/238#discussion_r640141352
##########
File path:
src/main/java/org/apache/commons/collections4/iterators/ZippedTupleIterator.java
##########
@@ -0,0 +1,176 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.commons.collections4.iterators;
+
+import static java.util.Objects.requireNonNull;
+
+import java.util.Iterator;
+import java.util.NoSuchElementException;
+import
org.apache.commons.collections4.iterators.ZippedTupleIterator.ZippedTuple;
+
+/**
+ * Provides a iteration over the elements contained in a pair of Iterators.
+ *
+ * <p>
+ * Given two {@link Iterator} instances {@code A} and {@code B}, the {@link
#next} method on this
+ * iterator provide a Pair of {@code A.next()} and {@code B.next()} until one
of the iterators is
+ * exhausted.
+ * </p>
+ * Example usage:
+ * <pre>{@code
+ * List<Integer> studentIds = ...
+ * List<String> studentNames = ...
+ *
+ * ZippedTupleIterator<ZippedTuple<Integer, String>> zippedIterator =
+ * ZippedTupleIterator.ofIterables(studentIds, studentNames);
+ *
+ * while (zippedIterator.hasNext()) {
+ * ZippedTuple<Integer, String> item = zippedIterator.next();
+ * ...
+ * }
+ * }</pre>
+ *
+ * @param <L> the left elements' type
+ * @param <R> the right elements' type
+ */
+public class ZippedTupleIterator<L, R> implements Iterator<ZippedTuple<L, R>> {
Review comment:
I'm not good naming things, so can't really suggest a better one. The
code example in the Python docs uses `zipped` too for the variable that
contains the tuples returned with `zip` (that were zipped), so that should
sound OK for users coming from Python (or JS using Lodash's
[zip/unzip](https://lodash.com/docs/#unzip) which I'm using in my current
project). But if that's confusing for other users, we can try to think in a
better name I think.
--
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: 602591)
Time Spent: 1h (was: 50m)
> 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: 1h
> 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}
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
