Skip to content

MINOR: Fix Punctuator Javadocs for old and new ProcessorContext reference#22163

Merged
mjsax merged 1 commit intoapache:trunkfrom
suzhiking:correct_punctuator_doc
May 7, 2026
Merged

MINOR: Fix Punctuator Javadocs for old and new ProcessorContext reference#22163
mjsax merged 1 commit intoapache:trunkfrom
suzhiking:correct_punctuator_doc

Conversation

@suzhiking
Copy link
Copy Markdown
Contributor

@suzhiking suzhiking commented Apr 28, 2026

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 pratyaksh13@gmail.com, Matthias J. Sax
matthias@confluent.io

@github-actions github-actions Bot added triage PRs from the community streams small Small PRs labels Apr 28, 2026
Copy link
Copy Markdown

@pratyakshsharma pratyakshsharma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Thank you.

@github-actions github-actions Bot removed the triage PRs from the community label Apr 30, 2026
Copy link
Copy Markdown
Member

@mjsax mjsax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great catch!

@mjsax mjsax merged commit 1314d35 into apache:trunk May 7, 2026
26 checks passed
@mjsax
Copy link
Copy Markdown
Member

mjsax commented May 7, 2026

Thanks for the PR. Merged to trunk.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants