Interface RemoteMongoIterable<ResultT>
-
- Type Parameters:
ResultT
- The type that this iterable will decode documents to.
- All Known Subinterfaces:
RemoteAggregateIterable<ResultT>
,RemoteFindIterable<ResultT>
,SyncAggregateIterable<ResultT>
,SyncFindIterable<ResultT>
- All Known Implementing Classes:
RemoteAggregateIterableImpl
,RemoteFindIterableImpl
,RemoteMongoIterableImpl
,SyncFindIterableImpl
public interface RemoteMongoIterable<ResultT>
The RemoteMongoIterable is the results from an operation, such as a query.
-
-
Method Summary
Modifier and Type Method Description Task<ResultT>
first()
Helper to return the first item in the iterator or null.Task<Void>
forEach(Block<? super ResultT> block)
Iterates over all documents in the view, applying the given block to each.<A extends Collection<? super ResultT>>
Task<A>into(A target)
Iterates over all the documents, adding each to the given target.Task<RemoteMongoCursor<ResultT>>
iterator()
Returns a cursor of the operation represented by this iterable.<U> RemoteMongoIterable<U>
map(Function<ResultT,U> mapper)
Maps this iterable from the source document type to the target document type.
-
-
-
Method Detail
-
iterator
@NonNull Task<RemoteMongoCursor<ResultT>> iterator()
Returns a cursor of the operation represented by this iterable.- Returns:
- a cursor of the operation represented by this iterable.
-
first
@NonNull Task<ResultT> first()
Helper to return the first item in the iterator or null.- Returns:
- a task containing the first item or null.
-
map
<U> RemoteMongoIterable<U> map(Function<ResultT,U> mapper)
Maps this iterable from the source document type to the target document type.- Type Parameters:
U
- the target document type- Parameters:
mapper
- a function that maps from the source to the target document type- Returns:
- an iterable which maps T to U
-
forEach
Task<Void> forEach(Block<? super ResultT> block)
Iterates over all documents in the view, applying the given block to each.Similar to
map
but the function is fully encapsulated with no returned result.- Parameters:
block
- the block to apply to each document of type T.- Returns:
- a task that completes when the iteration over all documents has completed.
-
into
<A extends Collection<? super ResultT>> Task<A> into(A target)
Iterates over all the documents, adding each to the given target.- Type Parameters:
A
- the collection type- Parameters:
target
- the collection to insert into- Returns:
- a task containing the target.
-
-