Browse Source

Polish Javadoc for StatementFilterFunction

pull/30619/head
Sam Brannen 3 years ago
parent
commit
d61074268a
  1. 16
      spring-r2dbc/src/main/java/org/springframework/r2dbc/core/StatementFilterFunction.java

16
spring-r2dbc/src/main/java/org/springframework/r2dbc/core/StatementFilterFunction.java

@ -1,5 +1,5 @@ @@ -1,5 +1,5 @@
/*
* Copyright 2002-2020 the original author or authors.
* Copyright 2002-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -23,7 +23,7 @@ import org.reactivestreams.Publisher; @@ -23,7 +23,7 @@ import org.reactivestreams.Publisher;
import org.springframework.util.Assert;
/**
* Represents a function that filters an {@link ExecuteFunction execute function}.
* Represents a function that filters an {@link ExecuteFunction}.
*
* <p>The filter is executed when a {@link org.reactivestreams.Subscriber} subscribes
* to the {@link Publisher} returned by the {@link DatabaseClient}.
@ -47,18 +47,18 @@ public interface StatementFilterFunction { @@ -47,18 +47,18 @@ public interface StatementFilterFunction {
/**
* Apply this filter to the given {@link Statement} and {@link ExecuteFunction}.
* <p>The given {@link ExecuteFunction} represents the next entity in the chain,
* to be invoked via {@link ExecuteFunction#execute(Statement)} in
* order to proceed with the execution, or not invoked to shortcut the chain.
* <p>The given {@code ExecuteFunction} represents the next entity in the chain,
* to be invoked via {@link ExecuteFunction#execute(Statement)} in order to
* proceed with the execution, or not invoked to short-circuit the chain.
* @param statement the current {@link Statement}
* @param next the next execute function in the chain
* @param next the next {@code ExecuteFunction} in the chain
* @return the filtered {@link Result}s.
*/
Publisher<? extends Result> filter(Statement statement, ExecuteFunction next);
/**
* Return a composed filter function that first applies this filter, and then
* applies the given {@code "after"} filter.
* Return a composed filter function that first applies this filter and then
* applies the given {@code afterFilter}.
* @param afterFilter the filter to apply after this filter
* @return the composed filter.
*/

Loading…
Cancel
Save