[KAFKA-7430] Improve Transformer interface JavaDoc

• Type: Improvement
• Status: Resolved
• Priority: Trivial
• Resolution: Fixed
• Affects Version/s: 0.10.2.2, 0.11.0.3, 1.1.1, 2.0.0
• Fix Version/s: 2.1.0
• Component/s: streams
• Labels: stream
• Assignee: Eugen Feller
• Reporter: Eugen Feller
• Created: 21/Sep/18 18:42
• Updated: 24/Sep/18 16:26
• Resolved: 24/Sep/18 16:26

Description

Currently Transformer JavaDoc mentions that it is possible to use both ctx.forward() and returning a KeyValue(). It would be great if we could mention that returning a KeyValue is merely a convenience thing. In other words, everything can be achieved using ctx.forward():

"return new KeyValue()" and "ctx.forward(); return null;" are equivalent.

Issue Links

• links to: GitHub Pull Request #5675