Interface ExecutableFindOperation.TerminatingResults<T>

All Known Subinterfaces:

ExecutableFindOperation.ExecutableFind<T>, ExecutableFindOperation.FindWithCollection<T>, ExecutableFindOperation.FindWithProjection<T>, ExecutableFindOperation.FindWithQuery<T>, ExecutableFindOperation.TerminatingFind<T>

Enclosing interface:

ExecutableFindOperation

public static interface ExecutableFindOperation.TerminatingResults<T>

Trigger find execution by calling one of the terminating methods.

Since:

5.0

Author:

Christoph Strobl, Mark Paluch

Method Summary

Modifier and Type	Method	Description
List<T>	all()	Get all matching elements.
default Optional<T>	first()	Get the first or no result.
@Nullable T	firstValue()	Get the first or no result.
<R> ExecutableFindOperation.TerminatingResults<R>	map(QueryResultConverter<? super T, ? extends R> converter)	Map the query result to a different type using QueryResultConverter.
default Optional<T>	one()	Get exactly zero or one result.
@Nullable T	oneValue()	Get exactly zero or one result.
Window<T>	scroll(ScrollPosition scrollPosition)	Return a window of elements either starting or resuming at ScrollPosition.
Stream<T>	stream()	Stream all matching elements.

Method Details

map

@Contract("_ -> new")
<R> ExecutableFindOperation.TerminatingResults<R> map(QueryResultConverter<? super T, ? extends R> converter)

Map the query result to a different type using QueryResultConverter.

Type Parameters:

R - type of the result.

Parameters:

converter - the converter, must not be null.

Returns:

new instance of ExecutableFindOperation.TerminatingResults.

Throws:

IllegalArgumentException - if converter is null.

Since:

5.0

one

default Optional<T> one()

Get exactly zero or one result.

Returns:

Optional.empty() if no match found.

Throws:

IncorrectResultSizeDataAccessException - if more than one match found.

oneValue

@Nullable T oneValue()

Get exactly zero or one result.

Returns:

null if no match found.

Throws:

IncorrectResultSizeDataAccessException - if more than one match found.

first

default Optional<T> first()

Get the first or no result.

Returns:

Optional.empty() if no match found.

firstValue

@Nullable T firstValue()

Get the first or no result.

Returns:

null if no match found.

all

List<T> all()

Get all matching elements.

Returns:

never null.

stream

Stream<T> stream()

Stream all matching elements.

Returns:

the result Stream, containing mapped objects, needing to be closed once fully processed (e.g. through a try-with-resources clause).

scroll

Window<T> scroll(ScrollPosition scrollPosition)

Return a window of elements either starting or resuming at ScrollPosition.

When using KeysetScrollPosition, make sure to use non-nullable sort properties as MongoDB does not support criteria to reconstruct a query result from absent document fields or null values through $gt/$lt operators.

Parameters:

scrollPosition - the scroll position.

Returns:

a window of the resulting elements.

Since:

4.1

See Also:

• OffsetScrollPosition
• KeysetScrollPosition