org.springframework.r2dbc.core

Interface StatementFilterFunction

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface StatementFilterFunction

Represents a function that filters an execute function.

The filter is executed when a Subscriber subscribes to the Publisher returned by the DatabaseClient.

StatementFilterFunctions are typically used to specify additional details on the Statement objects such as fetchSize or key generation.

Since:

5.3

Author:

Mark Paluch, Juergen Hoeller

See Also:

ExecuteFunction

Field Summary

Fields

Modifier and Type	Field and Description
static StatementFilterFunction	EMPTY_FILTER An empty StatementFilterFunction that delegates to ExecuteFunction.

Method Summary

Modifier and Type	Method and Description
default StatementFilterFunction	andThen(StatementFilterFunction afterFilter) Return a composed filter function that first applies this filter, and then applies the given "after" filter.
org.reactivestreams.Publisher<? extends io.r2dbc.spi.Result>	filter(io.r2dbc.spi.Statement statement, ExecuteFunction next) Apply this filter to the given Statement and ExecuteFunction.

Field Detail

EMPTY_FILTER

static final StatementFilterFunction EMPTY_FILTER

An empty StatementFilterFunction that delegates to ExecuteFunction.

Method Detail

filter

org.reactivestreams.Publisher<? extends io.r2dbc.spi.Result> filter(io.r2dbc.spi.Statement statement,
                                                                    ExecuteFunction next)

Apply this filter to the given Statement and ExecuteFunction.

The given ExecuteFunction represents the next entity in the chain, to be invoked via ExecuteFunction.execute(Statement) invoked} in order to proceed with the execution, or not invoked to shortcut the chain.

Parameters:

statement - the current Statement

next - the next execute function in the chain

Returns:

the filtered Results.

andThen

default StatementFilterFunction andThen(StatementFilterFunction afterFilter)

Return a composed filter function that first applies this filter, and then applies the given "after" filter.

Parameters:

afterFilter - the filter to apply after this filter

Returns:

the composed filter.