Package com.mongodb.stitch.android.services.mongodb.remote.internal

Class RemoteMongoIterableImpl<ResultT>

java.lang.Object

com.mongodb.stitch.android.services.mongodb.remote.internal.RemoteMongoIterableImpl<ResultT>

All Implemented Interfaces:

RemoteMongoIterable<ResultT>

Direct Known Subclasses:

RemoteAggregateIterableImpl, RemoteFindIterableImpl, SyncFindIterableImpl

public class RemoteMongoIterableImpl<ResultT>
extends Object
implements RemoteMongoIterable<ResultT>

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

iterator

@NonNull
public Task<RemoteMongoCursor<ResultT>> iterator()

Description copied from interface: RemoteMongoIterable

Returns a cursor of the operation represented by this iterable.

Specified by:

iterator in interface RemoteMongoIterable<ResultT>

Returns:

a cursor of the operation represented by this iterable.

first

@NonNull
public Task<ResultT> first()

Description copied from interface: RemoteMongoIterable

Helper to return the first item in the iterator or null.

Specified by:

first in interface RemoteMongoIterable<ResultT>

Returns:

a task containing the first item or null.

map

public <U> RemoteMongoIterable<U> map(Function<ResultT,U> mapper)

Description copied from interface: RemoteMongoIterable

Maps this iterable from the source document type to the target document type.

Specified by:

map in interface RemoteMongoIterable<ResultT>

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

public Task<Void> forEach(Block<? super ResultT> block)

Description copied from interface: RemoteMongoIterable

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.

Specified by:

forEach in interface RemoteMongoIterable<ResultT>

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

public <A extends Collection<? super ResultT>> Task<A> into(A target)

Description copied from interface: RemoteMongoIterable

Iterates over all the documents, adding each to the given target.

Specified by:

into in interface RemoteMongoIterable<ResultT>

Type Parameters:

A - the collection type

Parameters:

target - the collection to insert into

Returns:

a task containing the target.