You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kafka.apache.org by bb...@apache.org on 2020/10/20 23:41:35 UTC
[kafka] branch 2.7 updated: MINOR: Clean-up streams javadoc
warnings (#9461)
This is an automated email from the ASF dual-hosted git repository.
bbejeck pushed a commit to branch 2.7
in repository https://gitbox.apache.org/repos/asf/kafka.git
The following commit(s) were added to refs/heads/2.7 by this push:
new 91f4ed9 MINOR: Clean-up streams javadoc warnings (#9461)
91f4ed9 is described below
commit 91f4ed9c0d7d65606255a1d148946730f37e2ca7
Author: Bill Bejeck <bb...@gmail.com>
AuthorDate: Tue Oct 20 19:30:49 2020 -0400
MINOR: Clean-up streams javadoc warnings (#9461)
Reviewers: Matthias J. Sax <mj...@apache.org>, John Roesler <jo...@confluent.io>
---
streams/src/main/java/org/apache/kafka/streams/LagInfo.java | 2 +-
streams/src/main/java/org/apache/kafka/streams/Topology.java | 6 +++---
.../java/org/apache/kafka/streams/kstream/CogroupedKStream.java | 4 ++--
.../main/java/org/apache/kafka/streams/kstream/SlidingWindows.java | 2 +-
.../main/java/org/apache/kafka/streams/processor/StateStore.java | 2 +-
.../main/java/org/apache/kafka/streams/processor/api/Record.java | 4 ++--
6 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/streams/src/main/java/org/apache/kafka/streams/LagInfo.java b/streams/src/main/java/org/apache/kafka/streams/LagInfo.java
index 7148840..4a6f642 100644
--- a/streams/src/main/java/org/apache/kafka/streams/LagInfo.java
+++ b/streams/src/main/java/org/apache/kafka/streams/LagInfo.java
@@ -40,7 +40,7 @@ public class LagInfo {
* Get the current maximum offset on the store partition's changelog topic, that has been successfully written into
* the store partition's state store.
*
- * @return current consume offset for standby/restoring store partitions & simply endoffset for active store partition replicas
+ * @return current consume offset for standby/restoring store partitions & simply endoffset for active store partition replicas
*/
public long currentOffsetPosition() {
return this.currentOffsetPosition;
diff --git a/streams/src/main/java/org/apache/kafka/streams/Topology.java b/streams/src/main/java/org/apache/kafka/streams/Topology.java
index 8753e54..255d57a 100644
--- a/streams/src/main/java/org/apache/kafka/streams/Topology.java
+++ b/streams/src/main/java/org/apache/kafka/streams/Topology.java
@@ -655,7 +655,7 @@ public class Topology {
* and process
* @return itself
* @throws TopologyException if parent processor is not added yet, or if this processor's name is equal to the parent's name
- * @deprecated Since 2.7.0 Use {@link this#addProcessor(String, ProcessorSupplier, String...)} instead.
+ * @deprecated Since 2.7.0 Use {@link #addProcessor(String, ProcessorSupplier, String...)} instead.
*/
@SuppressWarnings("rawtypes")
@Deprecated
@@ -742,7 +742,7 @@ public class Topology {
* @param stateUpdateSupplier the instance of {@link org.apache.kafka.streams.processor.ProcessorSupplier}
* @return itself
* @throws TopologyException if the processor of state is already registered
- * @deprecated Since 2.7.0. Use {@link this#addGlobalStore(StoreBuilder, String, Deserializer, Deserializer, String, String, ProcessorSupplier)} instead.
+ * @deprecated Since 2.7.0. Use {@link #addGlobalStore(StoreBuilder, String, Deserializer, Deserializer, String, String, ProcessorSupplier)} instead.
*/
@Deprecated
public synchronized <K, V> Topology addGlobalStore(final StoreBuilder<?> storeBuilder,
@@ -788,7 +788,7 @@ public class Topology {
* @param stateUpdateSupplier the instance of {@link org.apache.kafka.streams.processor.ProcessorSupplier}
* @return itself
* @throws TopologyException if the processor of state is already registered
- * @deprecated Since 2.7.0. Use {@link this#addGlobalStore(StoreBuilder, String, TimestampExtractor, Deserializer, Deserializer, String, String, ProcessorSupplier)} instead.
+ * @deprecated Since 2.7.0. Use {@link #addGlobalStore(StoreBuilder, String, TimestampExtractor, Deserializer, Deserializer, String, String, ProcessorSupplier)} instead.
*/
@Deprecated
public synchronized <K, V> Topology addGlobalStore(final StoreBuilder<?> storeBuilder,
diff --git a/streams/src/main/java/org/apache/kafka/streams/kstream/CogroupedKStream.java b/streams/src/main/java/org/apache/kafka/streams/kstream/CogroupedKStream.java
index 616b3b3..d219360 100644
--- a/streams/src/main/java/org/apache/kafka/streams/kstream/CogroupedKStream.java
+++ b/streams/src/main/java/org/apache/kafka/streams/kstream/CogroupedKStream.java
@@ -181,7 +181,7 @@ public interface CogroupedKStream<K, VOut> {
* <p>
* To query the local {@link ReadOnlyKeyValueStore} it must be obtained via
* {@link KafkaStreams#store(StoreQueryParameters) KafkaStreams#store(...)}:
- * <pre>
+ * <pre>{@code
* KafkaStreams streams = ... // some aggregation on value type double
* String queryableStoreName = "storeName" // the store name should be the name of the store as defined by the Materialized instance
* ReadOnlyKeyValueStore<K, ValueAndTimestamp<VOut>> localStore = streams.store(queryableStoreName, QueryableStoreTypes.<K, ValueAndTimestamp<VOut>> timestampedKeyValueStore());
@@ -233,7 +233,7 @@ public interface CogroupedKStream<K, VOut> {
* <p>
* To query the local {@link org.apache.kafka.streams.state.ReadOnlyKeyValueStore} it must be obtained via
* {@link KafkaStreams#store(StoreQueryParameters) KafkaStreams#store(...)}:
- * <pre>
+ * <pre>{@code
* KafkaStreams streams = ... // some aggregation on value type double
* String queryableStoreName = "storeName" // the store name should be the name of the store as defined by the Materialized instance
* ReadOnlyKeyValueStore<K, ValueAndTimestamp<VOut>> localStore = streams.store(queryableStoreName, QueryableStoreTypes.<K, ValueAndTimestamp<VOut>> timestampedKeyValueStore());
diff --git a/streams/src/main/java/org/apache/kafka/streams/kstream/SlidingWindows.java b/streams/src/main/java/org/apache/kafka/streams/kstream/SlidingWindows.java
index 285c7c5..394b58f 100644
--- a/streams/src/main/java/org/apache/kafka/streams/kstream/SlidingWindows.java
+++ b/streams/src/main/java/org/apache/kafka/streams/kstream/SlidingWindows.java
@@ -88,7 +88,7 @@ public final class SlidingWindows {
* @param timeDifference the max time difference (inclusive) between two records in a window
* @param grace the grace period to admit out-of-order events to a window
* @return a new window definition
- * @throws IllegalArgumentException if the specified window size is < 0 or grace < 0, or either can't be represented as {@code long milliseconds}
+ * @throws IllegalArgumentException if the specified window size is < 0 or grace < 0, or either can't be represented as {@code long milliseconds}
*/
public static SlidingWindows withTimeDifferenceAndGrace(final Duration timeDifference, final Duration grace) throws IllegalArgumentException {
final String msgPrefixSize = prepareMillisCheckFailMsgPrefix(timeDifference, "timeDifference");
diff --git a/streams/src/main/java/org/apache/kafka/streams/processor/StateStore.java b/streams/src/main/java/org/apache/kafka/streams/processor/StateStore.java
index 570bb62..76d1ab4 100644
--- a/streams/src/main/java/org/apache/kafka/streams/processor/StateStore.java
+++ b/streams/src/main/java/org/apache/kafka/streams/processor/StateStore.java
@@ -65,7 +65,7 @@ public interface StateStore {
*
* @throws IllegalStateException If store gets registered after initialized is already finished
* @throws StreamsException if the store's change log does not contain the partition
- * @deprecated Since 2.7.0. Callers should invoke {@link this#init(StateStoreContext, StateStore)} instead.
+ * @deprecated Since 2.7.0. Callers should invoke {@link #init(StateStoreContext, StateStore)} instead.
* Implementers may choose to implement this method for backward compatibility or to throw an
* informative exception instead.
*/
diff --git a/streams/src/main/java/org/apache/kafka/streams/processor/api/Record.java b/streams/src/main/java/org/apache/kafka/streams/processor/api/Record.java
index ab8844c..225b95f 100644
--- a/streams/src/main/java/org/apache/kafka/streams/processor/api/Record.java
+++ b/streams/src/main/java/org/apache/kafka/streams/processor/api/Record.java
@@ -52,7 +52,7 @@ public class Record<K, V> {
* @param value The value of the record. May be null.
* @param timestamp The timestamp of the record. May not be negative.
* @param headers The headers of the record. May be null, which will cause subsequent calls
- * to {@link this#headers()} to return a non-null, empty, {@link Headers} collection.
+ * to {@link #headers()} to return a non-null, empty, {@link Headers} collection.
* @throws IllegalArgumentException if the timestamp is negative.
* @see ProcessorContext#forward(Record)
*/
@@ -71,7 +71,7 @@ public class Record<K, V> {
/**
* Convenience constructor in case you do not wish to specify any headers.
- * Subsequent calls to {@link this#headers()} will return a non-null, empty, {@link Headers} collection.
+ * Subsequent calls to {@link #headers()} will return a non-null, empty, {@link Headers} collection.
*
* @param key The key of the record. May be null.
* @param value The value of the record. May be null.