com.mongodb

Class FindIterableImpl<TDocument,TResult>

java.lang.Object

com.mongodb.FindIterableImpl<TDocument,TResult>

All Implemented Interfaces:

FindIterable<TResult>, MongoIterable<TResult>, java.lang.Iterable<TResult>

final class FindIterableImpl<TDocument,TResult>
extends java.lang.Object
implements FindIterable<TResult>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	FindIterableImpl.FindOperationIterable

Field Summary

Fields

Modifier and Type	Field and Description
private CodecRegistry	codecRegistry
private java.lang.Class<TDocument>	documentClass
private OperationExecutor	executor
private Bson	filter
private FindOptions	findOptions
private MongoNamespace	namespace
private ReadConcern	readConcern
private ReadPreference	readPreference
private java.lang.Class<TResult>	resultClass

Constructor Summary

Constructors

Constructor and Description
FindIterableImpl(MongoNamespace namespace, java.lang.Class<TDocument> documentClass, java.lang.Class<TResult> resultClass, CodecRegistry codecRegistry, ReadPreference readPreference, ReadConcern readConcern, OperationExecutor executor, Bson filter, FindOptions findOptions)

Method Summary

Modifier and Type	Method and Description
FindIterable<TResult>	batchSize(int batchSize) Sets the number of documents to return per batch.
FindIterable<TResult>	collation(Collation collation) Sets the collation options
private FindOperation<TResult>	createQueryOperation()
FindIterable<TResult>	cursorType(CursorType cursorType) Sets the cursor type.
private MongoIterable<TResult>	execute()
FindIterable<TResult>	filter(Bson filter) Sets the query filter to apply to the query.
TResult	first() Helper to return the first item in the iterator or null.
void	forEach(Block<? super TResult> block) Iterates over all documents in the view, applying the given block to each.
<A extends java.util.Collection<? super TResult>> A	into(A target) Iterates over all the documents, adding each to the given target.
MongoCursor<TResult>	iterator()
FindIterable<TResult>	limit(int limit) Sets the limit to apply.
<U> MongoIterable<U>	map(Function<TResult,U> mapper) Maps this iterable from the source document type to the target document type.
FindIterable<TResult>	maxAwaitTime(long maxAwaitTime, java.util.concurrent.TimeUnit timeUnit) The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.
FindIterable<TResult>	maxTime(long maxTime, java.util.concurrent.TimeUnit timeUnit) Sets the maximum execution time on the server for this operation.
FindIterable<TResult>	modifiers(Bson modifiers) Sets the query modifiers to apply to this operation.
FindIterable<TResult>	noCursorTimeout(boolean noCursorTimeout) The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use.
FindIterable<TResult>	oplogReplay(boolean oplogReplay) Users should not set this under normal circumstances.
FindIterable<TResult>	partial(boolean partial) Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).
FindIterable<TResult>	projection(Bson projection) Sets a document describing the fields to return for all matching documents.
FindIterable<TResult>	skip(int skip) Sets the number of documents to skip.
FindIterable<TResult>	sort(Bson sort) Sets the sort criteria to apply to the query.
private BsonDocument	toBsonDocument(Bson document)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

namespace

private final MongoNamespace namespace

documentClass

private final java.lang.Class<TDocument> documentClass

resultClass

private final java.lang.Class<TResult> resultClass

readPreference

private final ReadPreference readPreference

readConcern

private final ReadConcern readConcern

codecRegistry

private final CodecRegistry codecRegistry

executor

private final OperationExecutor executor

findOptions

private final FindOptions findOptions

filter

private Bson filter

Constructor Detail

FindIterableImpl

FindIterableImpl(MongoNamespace namespace,
                 java.lang.Class<TDocument> documentClass,
                 java.lang.Class<TResult> resultClass,
                 CodecRegistry codecRegistry,
                 ReadPreference readPreference,
                 ReadConcern readConcern,
                 OperationExecutor executor,
                 Bson filter,
                 FindOptions findOptions)

Method Detail

filter

public FindIterable<TResult> filter(Bson filter)

Description copied from interface: FindIterable

Sets the query filter to apply to the query.

Specified by:

filter in interface FindIterable<TResult>

Parameters:

filter - the filter, which may be null.

Returns:

this

limit

public FindIterable<TResult> limit(int limit)

Description copied from interface: FindIterable

Sets the limit to apply.

Specified by:

limit in interface FindIterable<TResult>

Parameters:

limit - the limit, which may be null

Returns:

this

skip

public FindIterable<TResult> skip(int skip)

Description copied from interface: FindIterable

Sets the number of documents to skip.

Specified by:

skip in interface FindIterable<TResult>

Parameters:

skip - the number of documents to skip

Returns:

this

maxTime

public FindIterable<TResult> maxTime(long maxTime,
                                     java.util.concurrent.TimeUnit timeUnit)

Description copied from interface: FindIterable

Sets the maximum execution time on the server for this operation.

Specified by:

maxTime in interface FindIterable<TResult>

Parameters:

maxTime - the max time

timeUnit - the time unit, which may not be null

Returns:

this

maxAwaitTime

public FindIterable<TResult> maxAwaitTime(long maxAwaitTime,
                                          java.util.concurrent.TimeUnit timeUnit)

Description copied from interface: FindIterable

The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query. This only applies to a TAILABLE_AWAIT cursor. When the cursor is not a TAILABLE_AWAIT cursor, this option is ignored. On servers >= 3.2, this option will be specified on the getMore command as "maxTimeMS". The default is no value: no "maxTimeMS" is sent to the server with the getMore command. On servers < 3.2, this option is ignored, and indicates that the driver should respect the server's default value A zero value will be ignored.

Specified by:

maxAwaitTime in interface FindIterable<TResult>

Parameters:

maxAwaitTime - the max await time

timeUnit - the time unit to return the result in

Returns:

the maximum await execution time in the given time unit

batchSize

public FindIterable<TResult> batchSize(int batchSize)

Description copied from interface: FindIterable

Sets the number of documents to return per batch.

Specified by:

batchSize in interface FindIterable<TResult>

Specified by:

batchSize in interface MongoIterable<TResult>

Parameters:

batchSize - the batch size

Returns:

this

collation

public FindIterable<TResult> collation(Collation collation)

Description copied from interface: FindIterable

Sets the collation options

A null value represents the server default.

Specified by:

collation in interface FindIterable<TResult>

Parameters:

collation - the collation options to use

Returns:

this

modifiers

public FindIterable<TResult> modifiers(Bson modifiers)

Description copied from interface: FindIterable

Sets the query modifiers to apply to this operation.

Specified by:

modifiers in interface FindIterable<TResult>

Parameters:

modifiers - the query modifiers to apply, which may be null.

Returns:

this

projection

public FindIterable<TResult> projection(Bson projection)

Description copied from interface: FindIterable

Sets a document describing the fields to return for all matching documents.

Specified by:

projection in interface FindIterable<TResult>

Parameters:

projection - the project document, which may be null.

Returns:

this

sort

public FindIterable<TResult> sort(Bson sort)

Description copied from interface: FindIterable

Sets the sort criteria to apply to the query.

Specified by:

sort in interface FindIterable<TResult>

Parameters:

sort - the sort criteria, which may be null.

Returns:

this

noCursorTimeout

public FindIterable<TResult> noCursorTimeout(boolean noCursorTimeout)

Description copied from interface: FindIterable

The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.

Specified by:

noCursorTimeout in interface FindIterable<TResult>

Parameters:

noCursorTimeout - true if cursor timeout is disabled

Returns:

this

oplogReplay

public FindIterable<TResult> oplogReplay(boolean oplogReplay)

Description copied from interface: FindIterable

Users should not set this under normal circumstances.

Specified by:

oplogReplay in interface FindIterable<TResult>

Parameters:

oplogReplay - if oplog replay is enabled

Returns:

this

partial

public FindIterable<TResult> partial(boolean partial)

Description copied from interface: FindIterable

Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).

Specified by:

partial in interface FindIterable<TResult>

Parameters:

partial - if partial results for sharded clusters is enabled

Returns:

this

cursorType

public FindIterable<TResult> cursorType(CursorType cursorType)

Description copied from interface: FindIterable

Sets the cursor type.

Specified by:

cursorType in interface FindIterable<TResult>

Parameters:

cursorType - the cursor type

Returns:

this

iterator

public MongoCursor<TResult> iterator()

Specified by:

iterator in interface MongoIterable<TResult>

Specified by:

iterator in interface java.lang.Iterable<TResult>

first

public TResult first()

Description copied from interface: MongoIterable

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

Specified by:

first in interface MongoIterable<TResult>

Returns:

T the first item or null.

map

public <U> MongoIterable<U> map(Function<TResult,U> mapper)

Description copied from interface: MongoIterable

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

Specified by:

map in interface MongoIterable<TResult>

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 void forEach(Block<? super TResult> block)

Description copied from interface: MongoIterable

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 MongoIterable<TResult>

Parameters:

block - the block to apply to each document of type T.

into

public <A extends java.util.Collection<? super TResult>> A into(A target)

Description copied from interface: MongoIterable

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

Specified by:

into in interface MongoIterable<TResult>

Type Parameters:

A - the collection type

Parameters:

target - the collection to insert into

Returns:

the target

execute

private MongoIterable<TResult> execute()

createQueryOperation

private FindOperation<TResult> createQueryOperation()

toBsonDocument

private BsonDocument toBsonDocument(Bson document)