You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kafka.apache.org by ch...@apache.org on 2024/04/17 13:26:10 UTC
(kafka) branch trunk updated: MINOR: fix duplicated return and other streams docs typos (#15713)
This is an automated email from the ASF dual-hosted git repository.
chia7712 pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/kafka.git
The following commit(s) were added to refs/heads/trunk by this push:
new e63efbc5d77 MINOR: fix duplicated return and other streams docs typos (#15713)
e63efbc5d77 is described below
commit e63efbc5d771a6e69eb8678db6f88730b4e751e1
Author: Ayoub Omari <ay...@outlook.fr>
AuthorDate: Wed Apr 17 15:26:04 2024 +0200
MINOR: fix duplicated return and other streams docs typos (#15713)
Reviewers: Johnny Hsu <jo...@fb.com>, Chia-Ping Tsai <ch...@gmail.com>
---
.../main/java/org/apache/kafka/streams/kstream/BranchedKStream.java | 2 +-
.../main/java/org/apache/kafka/streams/kstream/KGroupedStream.java | 2 +-
streams/src/main/java/org/apache/kafka/streams/kstream/KStream.java | 4 ++--
.../src/main/java/org/apache/kafka/streams/kstream/Materialized.java | 5 ++---
.../main/java/org/apache/kafka/streams/kstream/NamedOperation.java | 2 +-
.../main/java/org/apache/kafka/streams/kstream/UnlimitedWindows.java | 2 +-
.../org/apache/kafka/streams/kstream/ValueTransformerSupplier.java | 3 +--
.../kafka/streams/kstream/ValueTransformerWithKeySupplier.java | 3 +--
8 files changed, 10 insertions(+), 13 deletions(-)
diff --git a/streams/src/main/java/org/apache/kafka/streams/kstream/BranchedKStream.java b/streams/src/main/java/org/apache/kafka/streams/kstream/BranchedKStream.java
index 43475a4227c..6a4fb9cf96b 100644
--- a/streams/src/main/java/org/apache/kafka/streams/kstream/BranchedKStream.java
+++ b/streams/src/main/java/org/apache/kafka/streams/kstream/BranchedKStream.java
@@ -101,7 +101,7 @@ import java.util.Map;
* }</pre>
*
* <h3>Dynamic branching</h3>
- * There is also a case when we might need to create branches dynamically, e. g. one per enum value:
+ * There is also a case when we might need to create branches dynamically, e.g. one per enum value:
*
* <pre> {@code
* BranchedKStream branched = stream.split();
diff --git a/streams/src/main/java/org/apache/kafka/streams/kstream/KGroupedStream.java b/streams/src/main/java/org/apache/kafka/streams/kstream/KGroupedStream.java
index 486377addd0..669511dc7f4 100644
--- a/streams/src/main/java/org/apache/kafka/streams/kstream/KGroupedStream.java
+++ b/streams/src/main/java/org/apache/kafka/streams/kstream/KGroupedStream.java
@@ -561,7 +561,7 @@ public interface KGroupedStream<K, V> {
SessionWindowedKStream<K, V> windowedBy(final SessionWindows windows);
/**
- * Create a new {@link CogroupedKStream} from the this grouped KStream to allow cogrouping other
+ * Create a new {@link CogroupedKStream} from this grouped KStream to allow cogrouping other
* {@code KGroupedStream} to it.
* {@link CogroupedKStream} is an abstraction of multiple <i>grouped</i> record streams of {@link KeyValue} pairs.
* It is an intermediate representation after a grouping of {@link KStream}s, before the
diff --git a/streams/src/main/java/org/apache/kafka/streams/kstream/KStream.java b/streams/src/main/java/org/apache/kafka/streams/kstream/KStream.java
index b8870620e90..4054475b173 100644
--- a/streams/src/main/java/org/apache/kafka/streams/kstream/KStream.java
+++ b/streams/src/main/java/org/apache/kafka/streams/kstream/KStream.java
@@ -1836,7 +1836,7 @@ public interface KStream<K, V> {
* a value (with arbitrary type) for the result record.
* The key of the result record is the same as for both joining input records.
* Furthermore, for each input record of both {@code KStream}s that does not satisfy the join predicate the provided
- * {@link ValueJoiner} will be called with a {@code null} value for the this/other stream, respectively.
+ * {@link ValueJoiner} will be called with a {@code null} value for this/other stream, respectively.
* If an input record value is {@code null} the record will not be included in the join operation and thus no
* output record will be added to the resulting {@code KStream}.
* <p>
@@ -1917,7 +1917,7 @@ public interface KStream<K, V> {
* Note that the key is read-only and should not be modified, as this can lead to undefined behaviour.
* The key of the result record is the same as for both joining input records.
* Furthermore, for each input record of both {@code KStream}s that does not satisfy the join predicate the provided
- * {@link ValueJoinerWithKey} will be called with a {@code null} value for the this/other stream, respectively.
+ * {@link ValueJoinerWithKey} will be called with a {@code null} value for this/other stream, respectively.
* If an input record value is {@code null} the record will not be included in the join operation and thus no
* output record will be added to the resulting {@code KStream}.
* <p>
diff --git a/streams/src/main/java/org/apache/kafka/streams/kstream/Materialized.java b/streams/src/main/java/org/apache/kafka/streams/kstream/Materialized.java
index a5cc2dec2fa..da352ca6b50 100644
--- a/streams/src/main/java/org/apache/kafka/streams/kstream/Materialized.java
+++ b/streams/src/main/java/org/apache/kafka/streams/kstream/Materialized.java
@@ -187,8 +187,7 @@ public class Materialized<K, V, S extends StateStore> {
* @param supplier the {@link SessionBytesStoreSupplier} used to materialize the store
* @param <K> key type of the store
* @param <V> value type of the store
- * @return a new {@link Materialized} instance with the given sup
- * plier
+ * @return a new {@link Materialized} instance with the given supplier
*/
public static <K, V> Materialized<K, V, SessionStore<Bytes, byte[]>> as(final SessionBytesStoreSupplier supplier) {
Objects.requireNonNull(supplier, "supplier can't be null");
@@ -240,7 +239,7 @@ public class Materialized<K, V, S extends StateStore> {
}
/**
- * Set the keySerde the materialize {@link StateStore} will use.
+ * Set the keySerde the materialized {@link StateStore} will use.
* @param keySerde the key {@link Serde} to use. If the {@link Serde} is null, then the default key
* serde from configs will be used
* @return itself
diff --git a/streams/src/main/java/org/apache/kafka/streams/kstream/NamedOperation.java b/streams/src/main/java/org/apache/kafka/streams/kstream/NamedOperation.java
index 9a2c40b168b..578bde67ac0 100644
--- a/streams/src/main/java/org/apache/kafka/streams/kstream/NamedOperation.java
+++ b/streams/src/main/java/org/apache/kafka/streams/kstream/NamedOperation.java
@@ -17,7 +17,7 @@
package org.apache.kafka.streams.kstream;
/**
- * Default interface which can be used to personalized the named of operations, internal topics or store.
+ * Default interface which can be used to customize the name of operations, internal topics or stores.
*/
interface NamedOperation<T extends NamedOperation<T>> {
diff --git a/streams/src/main/java/org/apache/kafka/streams/kstream/UnlimitedWindows.java b/streams/src/main/java/org/apache/kafka/streams/kstream/UnlimitedWindows.java
index 513f19e224a..7a0573077f7 100644
--- a/streams/src/main/java/org/apache/kafka/streams/kstream/UnlimitedWindows.java
+++ b/streams/src/main/java/org/apache/kafka/streams/kstream/UnlimitedWindows.java
@@ -91,7 +91,7 @@ public final class UnlimitedWindows extends Windows<UnlimitedWindow> {
/**
* {@inheritDoc}
- * As unlimited windows have conceptually infinite size, this methods just returns {@link Long#MAX_VALUE}.
+ * As unlimited windows have conceptually infinite size, this method just returns {@link Long#MAX_VALUE}.
*
* @return the size of the specified windows which is {@link Long#MAX_VALUE}
*/
diff --git a/streams/src/main/java/org/apache/kafka/streams/kstream/ValueTransformerSupplier.java b/streams/src/main/java/org/apache/kafka/streams/kstream/ValueTransformerSupplier.java
index b0c18db4378..b1faeb387df 100644
--- a/streams/src/main/java/org/apache/kafka/streams/kstream/ValueTransformerSupplier.java
+++ b/streams/src/main/java/org/apache/kafka/streams/kstream/ValueTransformerSupplier.java
@@ -45,8 +45,7 @@ public interface ValueTransformerSupplier<V, VR> extends ConnectedStoreProvider
* Creating a single {@link ValueTransformer} object and returning the same object reference in {@link ValueTransformerSupplier#get()}
* is a violation of the supplier pattern and leads to runtime exceptions.
*
- * @return a new {@link ValueTransformer} instance
- * @return a newly constructed {@link ValueTransformer} instance
+ * @return a newly constructed {@link ValueTransformer} instance
*/
ValueTransformer<V, VR> get();
}
diff --git a/streams/src/main/java/org/apache/kafka/streams/kstream/ValueTransformerWithKeySupplier.java b/streams/src/main/java/org/apache/kafka/streams/kstream/ValueTransformerWithKeySupplier.java
index 9aae791cf7c..7c49a5e0372 100644
--- a/streams/src/main/java/org/apache/kafka/streams/kstream/ValueTransformerWithKeySupplier.java
+++ b/streams/src/main/java/org/apache/kafka/streams/kstream/ValueTransformerWithKeySupplier.java
@@ -47,8 +47,7 @@ public interface ValueTransformerWithKeySupplier<K, V, VR> extends ConnectedStor
* Creating a single {@link ValueTransformerWithKey} object and returning the same object reference in {@link ValueTransformerWithKeySupplier#get()}
* is a violation of the supplier pattern and leads to runtime exceptions.
*
- * @return a new {@link ValueTransformerWithKey} instance
- * @return a newly constructed {@link ValueTransformerWithKey} instance
+ * @return a newly constructed {@link ValueTransformerWithKey} instance
*/
ValueTransformerWithKey<K, V, VR> get();
}