org.springframework.data.repository.query

Interface FluentQuery<T>

All Known Subinterfaces:

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

public interface FluentQuery<T>

Fluent interface to define and run a query along with projection and sorting and. Instances of FluentQuery are immutable.

Since:

2.6

Author:

Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FluentQuery.FetchableFluentQuery<T> Fetchable extension FluentQuery allowing to materialize results from the underlying query.
static interface	FluentQuery.ReactiveFluentQuery<T> Reactive extension FluentQuery allowing to materialize results from the underlying query.

Method Summary

Modifier and Type	Method and Description
<R> FluentQuery<R>	as(Class<R> resultType) Define the target type the result should be mapped to.
FluentQuery<T>	project(Collection<String> properties) Define which properties or property paths to include in the query.
default FluentQuery<T>	project(String... properties) Define which properties or property paths to include in the query.
FluentQuery<T>	sortBy(Sort sort) Define the sort order.

Method Detail

sortBy

FluentQuery<T> sortBy(Sort sort)

Define the sort order.

Parameters:

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

Returns:

a new instance of FluentQuery.

Throws:

IllegalArgumentException - if resultType is null.

as

<R> FluentQuery<R> as(Class<R> resultType)

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

Type Parameters:

R - result type.

Parameters:

resultType - must not be null.

Returns:

a new instance of FluentQuery.

Throws:

IllegalArgumentException - if resultType is null.

project

default FluentQuery<T> project(String... properties)

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

Parameters:

properties - must not be null.

Returns:

a new instance of FluentQuery.

Throws:

IllegalArgumentException - if fields is null.

project

FluentQuery<T> project(Collection<String> properties)

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

Parameters:

properties - must not be null.

Returns:

a new instance of FluentQuery.

Throws:

IllegalArgumentException - if fields is null.