You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kafka.apache.org by mj...@apache.org on 2019/04/09 05:37:08 UTC
[kafka] branch trunk updated: MINOR: Correct KStream documentation
(#6552)
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 97bca4d MINOR: Correct KStream documentation (#6552)
97bca4d is described below
commit 97bca4d3f5507f326046c78695ead99b10883631
Author: cadonna <ca...@users.noreply.github.com>
AuthorDate: Mon Apr 8 22:36:46 2019 -0700
MINOR: Correct KStream documentation (#6552)
Reviewers: Bill Bejeck <bi...@confluent.io>, Matthias J. Sax <ma...@confluent.io>
---
.../java/org/apache/kafka/streams/kstream/KStream.java | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
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 d264390..7faba82 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
@@ -515,7 +515,7 @@ public interface KStream<K, V> {
* To trigger periodic actions via {@link org.apache.kafka.streams.processor.Punctuator#punctuate(long) punctuate()},
* a schedule must be registered.
* The {@link Transformer} must return a {@link KeyValue} type in {@link Transformer#transform(Object, Object)
- * transform()} and {@link org.apache.kafka.streams.processor.Punctuator#punctuate(long) punctuate()}.
+ * transform()}.
* The return value of {@link Transformer#transform(Object, Object) Transformer#transform()} may be {@code null},
* in which case no record is emitted.
* <pre>{@code
@@ -528,7 +528,7 @@ public interface KStream<K, V> {
* void init(ProcessorContext context) {
* this.context = context;
* this.state = context.getStateStore("myTransformState");
- * // punctuate each 1000ms; can access this.state
+ * // punctuate each second; can access this.state
* context.schedule(Duration.ofSeconds(1), PunctuationType.WALL_CLOCK_TIME, new Punctuator(..));
* }
*
@@ -553,7 +553,8 @@ public interface KStream<K, V> {
* (cf. {@link #transformValues(ValueTransformerSupplier, String...) transformValues()} )
* <p>
* Note that it is possible to emit multiple records for each input record by using
- * {@link ProcessorContext#forward(Object, Object) context#forward()} in {@link Transformer#transform(Object, Object) Transformer#transform()} and
+ * {@link ProcessorContext#forward(Object, Object) context#forward()} in
+ * {@link Transformer#transform(Object, Object) Transformer#transform()} and
* {@link org.apache.kafka.streams.processor.Punctuator#punctuate(long) Punctuator#punctuate()}.
* Be aware that a mismatch between the types of the emitted records and the type of the stream would only be
* detected at runtime.
@@ -619,7 +620,7 @@ public interface KStream<K, V> {
* void init(ProcessorContext context) {
* this.context = context;
* this.state = context.getStateStore("myTransformState");
- * // punctuate each 1000ms; can access this.state
+ * // punctuate each second; can access this.state
* context.schedule(Duration.ofSeconds(1), PunctuationType.WALL_CLOCK_TIME, new Punctuator(..));
* }
*
@@ -697,8 +698,7 @@ public interface KStream<K, V> {
* To trigger periodic actions via {@link org.apache.kafka.streams.processor.Punctuator#punctuate(long) punctuate()},
* a schedule must be registered.
* In contrast to {@link #transform(TransformerSupplier, String...) transform()}, no additional {@link KeyValue}
- * pairs should be emitted via {@link ProcessorContext#forward(Object, Object)
- * ProcessorContext.forward()}.
+ * pairs should be emitted via {@link ProcessorContext#forward(Object, Object) ProcessorContext.forward()}.
* <pre>{@code
* new ValueTransformerSupplier() {
* ValueTransformer get() {
@@ -707,7 +707,7 @@ public interface KStream<K, V> {
*
* void init(ProcessorContext context) {
* this.state = context.getStateStore("myValueTransformState");
- * // punctuate each 1000ms, can access this.state
+ * // punctuate each second, can access this.state
* context.schedule(Duration.ofSeconds(1), PunctuationType.WALL_CLOCK_TIME, new Punctuator(..));
* }
*
@@ -779,7 +779,7 @@ public interface KStream<K, V> {
*
* void init(ProcessorContext context) {
* this.state = context.getStateStore("myValueTransformState");
- * // punctuate each 1000ms, can access this.state
+ * // punctuate each second, can access this.state
* context.schedule(Duration.ofSeconds(1), PunctuationType.WALL_CLOCK_TIME, new Punctuator(..));
* }
*
@@ -848,7 +848,7 @@ public interface KStream<K, V> {
*
* void init(ProcessorContext context) {
* this.state = context.getStateStore("myProcessorState");
- * // punctuate each 1000ms, can access this.state
+ * // punctuate each second, can access this.state
* context.schedule(Duration.ofSeconds(1), PunctuationType.WALL_CLOCK_TIME, new Punctuator(..));
* }
*