Package org.springframework.data.repository.query

Interface FluentQuery.ReactiveFluentQuery<T>

All Superinterfaces:

FluentQuery<T>

Enclosing interface:

FluentQuery<T>

public static interface FluentQuery.ReactiveFluentQuery<T>
extends FluentQuery<T>

Reactive extension FluentQuery allowing to materialize results from the underlying query.

Since:

2.6

Author:

Mark Paluch

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.repository.query.FluentQuery

FluentQuery.FetchableFluentQuery<T>, FluentQuery.ReactiveFluentQuery<T>

Method Summary

Modifier and Type	Method	Description
reactor.core.publisher.Flux<T>	all()	Get all matching elements.
<R> FluentQuery.ReactiveFluentQuery<R>	as(Class<R> resultType)	Define the target type the result should be mapped to.
reactor.core.publisher.Mono<Long>	count()	Get the number of matching elements.
reactor.core.publisher.Mono<Boolean>	exists()	Check for the presence of matching elements.
reactor.core.publisher.Mono<T>	first()	Get the first or no result.
default FluentQuery.ReactiveFluentQuery<T>	limit(int limit)	Define the query limit.
reactor.core.publisher.Mono<T>	one()	Get exactly zero or one result.
reactor.core.publisher.Mono<Page<T>>	page(Pageable pageable)	Get a page of matching elements for Pageable.
default FluentQuery.ReactiveFluentQuery<T>	project(String... properties)	Define which properties or property paths to include in the query.
FluentQuery.ReactiveFluentQuery<T>	project(Collection<String> properties)	Define which properties or property paths to include in the query.
default reactor.core.publisher.Mono<Window<T>>	scroll(ScrollPosition scrollPosition)	Get all matching elements as Window to start result scrolling or resume scrolling at scrollPosition.
FluentQuery.ReactiveFluentQuery<T>	sortBy(Sort sort)	Define the sort order.

Method Details

sortBy

@Contract("_ -> new")
@CheckReturnValue
FluentQuery.ReactiveFluentQuery<T> sortBy(Sort sort)

Description copied from interface: FluentQuery

Define the sort order.

Specified by:

sortBy in interface FluentQuery<T>

Parameters:

sort - the Sort specification to sort the results by, may be Sort.unsorted(), must not be null.

Returns:

a new instance of FluentQuery.

limit

@Contract("_ -> new")
@CheckReturnValue
default FluentQuery.ReactiveFluentQuery<T> limit(int limit)

Description copied from interface: FluentQuery

Define the query limit.

Specified by:

limit in interface FluentQuery<T>

Parameters:

limit - the limit to apply to the query to limit results. Must not be negative.

Returns:

a new instance of FluentQuery.

as

@Contract("_ -> new")
@CheckReturnValue
<R> FluentQuery.ReactiveFluentQuery<R> as(Class<R> resultType)

Description copied from interface: FluentQuery

Define the target type the result should be mapped to. Skip this step if you are only interested in the original domain type.

Specified by:

as in interface FluentQuery<T>

Type Parameters:

R - result type.

Parameters:

resultType - must not be null.

Returns:

a new instance of FluentQuery.

project

@Contract("_ -> new")
@CheckReturnValue
default FluentQuery.ReactiveFluentQuery<T> project(String... properties)

Description copied from interface: FluentQuery

Define which properties or property paths to include in the query.

Specified by:

project in interface FluentQuery<T>

Parameters:

properties - must not be null.

Returns:

a new instance of FluentQuery.

project

@Contract("_ -> new")
@CheckReturnValue
FluentQuery.ReactiveFluentQuery<T> project(Collection<String> properties)

Description copied from interface: FluentQuery

Define which properties or property paths to include in the query.

Specified by:

project in interface FluentQuery<T>

Parameters:

properties - must not be null.

Returns:

a new instance of FluentQuery.

one

reactor.core.publisher.Mono<T> one()

Get exactly zero or one result.

Returns:

null if no match found.

Throws:

IncorrectResultSizeDataAccessException - if more than one match found.

first

reactor.core.publisher.Mono<T> first()

Get the first or no result.

Returns:

null if no match found.

all

reactor.core.publisher.Flux<T> all()

Get all matching elements.

scroll

default reactor.core.publisher.Mono<Window<T>> scroll(ScrollPosition scrollPosition)

Get all matching elements as Window to start result scrolling or resume scrolling at scrollPosition.

Parameters:

scrollPosition - must not be null.

Throws:

IllegalArgumentException - if scrollPosition is null.

UnsupportedOperationException - if not supported by the underlying implementation.

Since:

3.1

page

reactor.core.publisher.Mono<Page<T>> page(Pageable pageable)

Get a page of matching elements for Pageable.

Parameters:

pageable - the pageable to request a paged result, can be Pageable.unpaged(), must not be null. The given Pageable will override any previously specified sort if the Sort object is not Sort.isUnsorted(). Any potentially specified limit(int) will be overridden by Pageable.getPageSize().

count

reactor.core.publisher.Mono<Long> count()

Get the number of matching elements.

Returns:

total number of matching elements.

exists

reactor.core.publisher.Mono<Boolean> exists()

Check for the presence of matching elements.

Returns:

true if at least one matching element exists.