This is an automated email from the ASF dual-hosted git repository.
mjsax 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 1314d356c2f MINOR: Fix Punctuator Javadocs for old and new
ProcessorContext reference (#22163)
1314d356c2f is described below
commit 1314d356c2fd083c5c44cdb3a755c725156d177f
Author: Gavin Wang <[email protected]>
AuthorDate: Thu May 7 19:15:31 2026 -0400
MINOR: Fix Punctuator Javadocs for old and new ProcessorContext reference
(#22163)
This PR fixes a few Javadoc issues in `Punctuator`.
The current documentation accidentally repeats references to the new
Processor API’s `ProcessorContext` where it appears to be trying to
distinguish between the old Processor API and the new Processor API.
Specifically, this PR updates the Javadocs to correctly reference:
- `org.apache.kafka.streams.processor.ProcessorContext` for the old
Processor API
- `org.apache.kafka.streams.processor.api.ProcessorContext` for the new
Processor API
- the old `ProcessorContext#forward(Object, Object)` method where the
documentation discusses forwarding without being able to set record
headers
- the new `ProcessorContext#forward(Record)` method where forwarding
with a `Record` is intended
Reviewers: Pratyaksh Sharma <[email protected]>, Matthias J. Sax
<[email protected]>
---
.../main/java/org/apache/kafka/streams/processor/Punctuator.java | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git
a/streams/src/main/java/org/apache/kafka/streams/processor/Punctuator.java
b/streams/src/main/java/org/apache/kafka/streams/processor/Punctuator.java
index eaed50c07be..ee655d29cf9 100644
--- a/streams/src/main/java/org/apache/kafka/streams/processor/Punctuator.java
+++ b/streams/src/main/java/org/apache/kafka/streams/processor/Punctuator.java
@@ -33,15 +33,15 @@ public interface Punctuator {
* Perform the scheduled periodic operation.
*
* <p> If this method accesses {@link
org.apache.kafka.streams.processor.api.ProcessorContext} or
- * {@link org.apache.kafka.streams.processor.api.ProcessorContext}, record
metadata like topic,
+ * {@link org.apache.kafka.streams.processor.ProcessorContext}, record
metadata like topic,
* partition, and offset or {@link
org.apache.kafka.streams.processor.api.RecordMetadata} won't
* be available.
*
* <p> Furthermore, for any record that is sent downstream via
* {@link
org.apache.kafka.streams.processor.api.ProcessorContext#forward(Record)}
- * or {@link
org.apache.kafka.streams.processor.api.ProcessorContext#forward(Record)}, there
+ * or {@link
org.apache.kafka.streams.processor.ProcessorContext#forward(Object, Object)},
there
* won't be any record metadata. If
- * {@link
org.apache.kafka.streams.processor.api.ProcessorContext#forward(Record)} is
used,
+ * {@link
org.apache.kafka.streams.processor.ProcessorContext#forward(Object, Object)} is
used,
* it's also not possible to set records headers.
*
* @param timestamp when the operation is being called, depending on
{@link PunctuationType}