Re: [PR] MINOR: cleanup KStream JavaDocs (9/N) - flatMap[Values] [kafka]

[via GitHub]

lucasbru commented on code in PR #18805:
URL: https://github.com/apache/kafka/pull/18805#discussion_r1946880377


##########
streams/src/main/java/org/apache/kafka/streams/kstream/KStream.java:
##########
@@ -283,89 +283,47 @@ <KOut, VOut> KStream<KOut, VOut> map(final 
KeyValueMapper<? super K, ? super V,
      *         }
      *     });
      * }</pre>
-     * The provided {@link KeyValueMapper} must return an {@link Iterable} 
(e.g., any {@link java.util.Collection} type)
-     * and the return value must not be {@code null}.
-     * <p>
-     * Flat-mapping records might result in an internal data redistribution if 
a key based operator (like an aggregation
-     * or join) is applied to the result {@code KStream}. (cf. {@link 
#flatMapValues(ValueMapper)})
+     * The provided {@link KeyValueMapper} must return an {@link Iterable} 
(e.g., any {@link java.util.Collection}
+     * type) and the return value must not be {@code null}.
+     *
+     * <p>Flat-mapping records might result in an internal data redistribution 
if a key based operator (like an
+     * aggregation or join) is applied to the result {@code KStream}. (cf. 
{@link #flatMapValues(ValueMapper)})
+     *
+     * @param mapper
+     *        a {@link KeyValueMapper KeyValueMapper&lt;K, V, 
Iterable&lt;KeyValue&lt;K', V'&gt;&gt;&lt;} that
+     *        computes zero of more new {@link KeyValue} pairs for each input 
record
+     *
+     * @param <KOut> the key type of the result stream
+     * @param <VOut> the value type of the result stream
+     *
+     * @return A {@code KStream} that contains more or less records with new 
keys and values (possibly of different types).

Review Comment:
   ```suggestion
        * @return A {@code KStream} that contains more or fewer records with 
new keys and values (possibly of different types).
   ```



##########
streams/src/main/java/org/apache/kafka/streams/kstream/KStream.java:
##########
@@ -283,89 +283,47 @@ <KOut, VOut> KStream<KOut, VOut> map(final 
KeyValueMapper<? super K, ? super V,
      *         }
      *     });
      * }</pre>
-     * The provided {@link KeyValueMapper} must return an {@link Iterable} 
(e.g., any {@link java.util.Collection} type)
-     * and the return value must not be {@code null}.
-     * <p>
-     * Flat-mapping records might result in an internal data redistribution if 
a key based operator (like an aggregation
-     * or join) is applied to the result {@code KStream}. (cf. {@link 
#flatMapValues(ValueMapper)})
+     * The provided {@link KeyValueMapper} must return an {@link Iterable} 
(e.g., any {@link java.util.Collection}
+     * type) and the return value must not be {@code null}.
+     *
+     * <p>Flat-mapping records might result in an internal data redistribution 
if a key based operator (like an

Review Comment:
   ```suggestion
        * <p>Flat-mapping records might result in an internal data 
redistribution if a key-based operator (like an
   ```



##########
streams/src/main/java/org/apache/kafka/streams/kstream/KStream.java:
##########
@@ -283,89 +283,47 @@ <KOut, VOut> KStream<KOut, VOut> map(final 
KeyValueMapper<? super K, ? super V,
      *         }
      *     });
      * }</pre>
-     * The provided {@link KeyValueMapper} must return an {@link Iterable} 
(e.g., any {@link java.util.Collection} type)
-     * and the return value must not be {@code null}.
-     * <p>
-     * Flat-mapping records might result in an internal data redistribution if 
a key based operator (like an aggregation
-     * or join) is applied to the result {@code KStream}. (cf. {@link 
#flatMapValues(ValueMapper)})
+     * The provided {@link KeyValueMapper} must return an {@link Iterable} 
(e.g., any {@link java.util.Collection}
+     * type) and the return value must not be {@code null}.
+     *
+     * <p>Flat-mapping records might result in an internal data redistribution 
if a key based operator (like an
+     * aggregation or join) is applied to the result {@code KStream}. (cf. 
{@link #flatMapValues(ValueMapper)})
+     *
+     * @param mapper
+     *        a {@link KeyValueMapper KeyValueMapper&lt;K, V, 
Iterable&lt;KeyValue&lt;K', V'&gt;&gt;&lt;} that

Review Comment:
   ```suggestion
        *        a {@link KeyValueMapper KeyValueMapper&lt;K, V, 
Iterable&lt;KeyValue&lt;K', V'&gt;&gt;&gt;} that
   ```



-- 
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.

To unsubscribe, e-mail: jira-unsubscr...@kafka.apache.org

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