io.requery.query

Interface Result<E>

Type Parameters:

E - type of element.

All Superinterfaces:

AutoCloseable, CloseableIterable<E>, Iterable<E>

All Known Subinterfaces:

MutableResult<E>

All Known Implementing Classes:

BaseResult, ModifiableResult, ReactiveResult, ReactorResult, ResultDelegate, RxResult

public interface Result<E>
extends CloseableIterable<E>, AutoCloseable

Represents a set of results from a query operation. These are terminal operations on the query which will cause the query to get executed. Note this class is not thread safe and the caller should call close() after the result is no longer needed. Entities created from the result are still valid and can still be referenced and used. This result is active that calls to methods return the underlying data e.g. Iterable.iterator(), toList() will cause the query to be executed.

Method Summary

Modifier and Type	Method and Description
void	close() Close this result and any resources it holds.
<C extends Collection<E>> C	collect(C collection) Fill the given collection with all elements from this result set.
void	each(Consumer<? super E> action) Consume the results with the given Consumer.
E	first() Gets the first element of this result set.
E	firstOr(E defaultElement) Gets the first element or a default value.
E	firstOr(Supplier<E> supplier) Gets the first element or a default value from a Supplier.
E	firstOrNull() Gets the first element or a default null value.
CloseableIterator<E>	iterator()
CloseableIterator<E>	iterator(int skip, int take) Creates a AutoCloseable Iterator over a window of the elements in this result.
Stream<E>	stream()
List<E>	toList() Converts this result into a list.
<K> Map<K,E>	toMap(Expression<K> key) Map the results into a new map using an expression of the result element as a key.
<K> Map<K,E>	toMap(Expression<K> key, Map<K,E> map) Map the results into the given map using an expression of the result element as a key.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

iterator

CloseableIterator<E> iterator()

Specified by:

iterator in interface CloseableIterable<E>

Specified by:

iterator in interface Iterable<E>

Returns:

A AutoCloseable Iterator over the elements in this result.

iterator

CloseableIterator<E> iterator(int skip,
                              int take)

Creates a AutoCloseable Iterator over a window of the elements in this result.

Parameters:

skip - number of elements to skip over

take - number of elements to receive

Returns:

iterator over the given window.

close

void close()

Close this result and any resources it holds.

Specified by:

close in interface AutoCloseable

stream

@CheckReturnValue
Stream<E> stream()

Returns:

Stream instance over the result set. Java 8 only.

collect

<C extends Collection<E>> C collect(C collection)

Fill the given collection with all elements from this result set.

Type Parameters:

C - collection to fill

Parameters:

collection - to fill

Returns:

the filled collection.

first

@CheckReturnValue
E first()
                   throws NoSuchElementException

Gets the first element of this result set.

Returns:

first element of this result set.

Throws:

NoSuchElementException - if there is no first element (empty result).

firstOr

@CheckReturnValue
E firstOr(E defaultElement)

Gets the first element or a default value.

Parameters:

defaultElement - default value for when there is no first element.

Returns:

First element or defaultElement if there is none.

firstOr

@CheckReturnValue
E firstOr(Supplier<E> supplier)

Gets the first element or a default value from a Supplier.

Parameters:

supplier - value supplier for when there is no first element.

Returns:

First element or the supplier value if there is none.

firstOrNull

@CheckReturnValue
E firstOrNull()

Gets the first element or a default null value.

Returns:

First element or null if there is none.

each

void each(Consumer<? super E> action)

Consume the results with the given Consumer. In Java 8 use Iterable.forEach(java.util.function.Consumer<? super T>) instead.

Parameters:

action - to receive the elements in this result.

toList

@CheckReturnValue
List<E> toList()

Converts this result into a list.

Returns:

a new unmodifiable list with the contents of the result.

toMap

@CheckReturnValue
<K> Map<K,E> toMap(Expression<K> key)

Map the results into a new map using an expression of the result element as a key.

Type Parameters:

K - type of key

Parameters:

key - expression key, must be present in all result elements

Returns:

map containing the results

toMap

@CheckReturnValue
<K> Map<K,E> toMap(Expression<K> key,
                                     Map<K,E> map)

Map the results into the given map using an expression of the result element as a key.

Type Parameters:

K - type of key

Parameters:

key - expression key, must be present in all result elements

map - map instance to be populated

Returns:

map containing the results.