root
/
kafka
mirror of https://github.com/apache/kafka.git
1
0
Fork 0
Code Issues Actions 3 Packages Projects Releases Wiki Activity

MINOR: Fix QueryResult Javadocs (#12404) 

Fixes the QueryResult javadocs.

Reviewer: Bruno Cadonna <cadonna@apache.org>
This commit is contained in:
Levani Kokhreidze 2022-07-18 14:39:34 +03:00 committed by GitHub
parent ab9aaea3ce
commit edad31811c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
streams/src/main/java/org/apache/kafka/streams/query/QueryResult.java
View File

@ -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,