You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kafka.apache.org by ca...@apache.org on 2022/07/18 11:39:45 UTC
[kafka] branch trunk updated: MINOR: Fix QueryResult Javadocs (#12404)
This is an automated email from the ASF dual-hosted git repository.
cadonna 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 edad31811c MINOR: Fix QueryResult Javadocs (#12404)
edad31811c is described below
commit edad31811c49856cc1b8e76de6e3f3a6c02802cd
Author: Levani Kokhreidze <le...@transferwise.com>
AuthorDate: Mon Jul 18 14:39:34 2022 +0300
MINOR: Fix QueryResult Javadocs (#12404)
Fixes the QueryResult javadocs.
Reviewer: Bruno Cadonna <ca...@apache.org>
---
.../main/java/org/apache/kafka/streams/query/QueryResult.java | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)
diff --git a/streams/src/main/java/org/apache/kafka/streams/query/QueryResult.java b/streams/src/main/java/org/apache/kafka/streams/query/QueryResult.java
index 5dba681b92..045077609d 100644
--- a/streams/src/main/java/org/apache/kafka/streams/query/QueryResult.java
+++ b/streams/src/main/java/org/apache/kafka/streams/query/QueryResult.java
@@ -16,7 +16,6 @@
*/
package org.apache.kafka.streams.query;
-
import org.apache.kafka.streams.processor.StateStore;
import org.apache.kafka.streams.query.internals.FailedQueryResult;
import org.apache.kafka.streams.query.internals.SucceededQueryResult;
@@ -31,7 +30,7 @@ import java.util.List;
public interface QueryResult<R> {
/**
* Static factory method to create a result object for a successful query. Used by StateStores
- * to respond to a {@link StateStore#query(Query, PositionBound, boolean)}.
+ * to respond to a {@link StateStore#query(Query, PositionBound, QueryConfig)}.
*/
static <R> QueryResult<R> forResult(final R result) {
return new SucceededQueryResult<>(result);
@@ -39,7 +38,7 @@ public interface QueryResult<R> {
/**
* Static factory method to create a result object for a failed query. Used by StateStores to
- * respond to a {@link StateStore#query(Query, PositionBound, boolean)}.
+ * respond to a {@link StateStore#query(Query, PositionBound, QueryConfig)}.
*/
static <R> QueryResult<R> forFailure(
final FailureReason failureReason,
@@ -52,7 +51,7 @@ public interface QueryResult<R> {
* Static factory method to create a failed query result object to indicate that the store does
* not know how to handle the query.
* <p>
- * Used by StateStores to respond to a {@link StateStore#query(Query, PositionBound, boolean)}.
+ * Used by StateStores to respond to a {@link StateStore#query(Query, PositionBound, QueryConfig)}.
*/
static <R> QueryResult<R> forUnknownQueryType(
final Query<R> query,
@@ -69,7 +68,7 @@ public interface QueryResult<R> {
* Static factory method to create a failed query result object to indicate that the store has
* not yet caught up to the requested position bound.
* <p>
- * Used by StateStores to respond to a {@link StateStore#query(Query, PositionBound, boolean)}.
+ * Used by StateStores to respond to a {@link StateStore#query(Query, PositionBound, QueryConfig)}.
*/
static <R> QueryResult<R> notUpToBound(
final Position currentPosition,