com.mongodb

Class FindIterableImpl<TDocument,TResult>

java.lang.Object

com.mongodb.MongoIterableImpl<TResult>

com.mongodb.FindIterableImpl<TDocument,TResult>

All Implemented Interfaces:

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

final class FindIterableImpl<TDocument,TResult>
extends MongoIterableImpl<TResult>
implements FindIterable<TResult>

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
FindIterableImpl(ClientSession clientSession, 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
protected ReadOperation<BatchCursor<TResult>>	asReadOperation()
FindIterable<TResult>	batchSize(int batchSize) Sets the number of documents to return per batch.
FindIterable<TResult>	collation(Collation collation) Sets the collation options
FindIterable<TResult>	comment(java.lang.String comment) Sets the comment to the query.
private FindOperation<TResult>	createQueryOperation()
FindIterable<TResult>	cursorType(CursorType cursorType) Sets the cursor type.
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.
FindIterable<TResult>	hint(Bson hint) Sets the hint for which index to use.
FindIterable<TResult>	limit(int limit) Sets the limit to apply.
FindIterable<TResult>	max(Bson max) Sets the exclusive upper bound for a specific index.
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>	maxScan(long maxScan) Sets the maximum number of documents or index keys to scan when executing the query.
FindIterable<TResult>	maxTime(long maxTime, java.util.concurrent.TimeUnit timeUnit) Sets the maximum execution time on the server for this operation.
FindIterable<TResult>	min(Bson min) Sets the minimum inclusive lower bound for a specific index.
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>	returnKey(boolean returnKey) Sets the returnKey.
FindIterable<TResult>	showRecordId(boolean showRecordId) Sets the showRecordId.
FindIterable<TResult>	skip(int skip) Sets the number of documents to skip.
FindIterable<TResult>	snapshot(boolean snapshot) Sets the snapshot.
FindIterable<TResult>	sort(Bson sort) Sets the sort criteria to apply to the query.

Methods inherited from class com.mongodb.MongoIterableImpl

forEach, getBatchSize, getClientSession, getExecutor, getReadConcern, getReadPreference, into, iterator, map, toBsonDocumentOrNull, toBsonDocumentOrNull

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mongodb.client.MongoIterable

forEach, into, iterator, map

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

codecRegistry

private final CodecRegistry codecRegistry

findOptions

private final FindOptions findOptions

filter

private Bson filter

Constructor Detail

FindIterableImpl

FindIterableImpl(ClientSession clientSession,
                 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: MongoIterable

Sets the number of documents to return per batch.

Specified by:

batchSize in interface FindIterable<TResult>

Specified by:

batchSize in interface MongoIterable<TResult>

Overrides:

batchSize in class MongoIterableImpl<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

comment

public FindIterable<TResult> comment(java.lang.String comment)

Description copied from interface: FindIterable

Sets the comment to the query. A null value means no comment is set.

Specified by:

comment in interface FindIterable<TResult>

Parameters:

comment - the comment

Returns:

this

hint

public FindIterable<TResult> hint(Bson hint)

Description copied from interface: FindIterable

Sets the hint for which index to use. A null value means no hint is set.

Specified by:

hint in interface FindIterable<TResult>

Parameters:

hint - the hint

Returns:

this

max

public FindIterable<TResult> max(Bson max)

Description copied from interface: FindIterable

Sets the exclusive upper bound for a specific index. A null value means no max is set.

Specified by:

max in interface FindIterable<TResult>

Parameters:

max - the max

Returns:

this

min

public FindIterable<TResult> min(Bson min)

Description copied from interface: FindIterable

Sets the minimum inclusive lower bound for a specific index. A null value means no max is set.

Specified by:

min in interface FindIterable<TResult>

Parameters:

min - the min

Returns:

this

maxScan

public FindIterable<TResult> maxScan(long maxScan)

Description copied from interface: FindIterable

Sets the maximum number of documents or index keys to scan when executing the query. A zero value or less will be ignored, and indicates that the driver should respect the server's default value.

Specified by:

maxScan in interface FindIterable<TResult>

Parameters:

maxScan - the maxScan

Returns:

this

returnKey

public FindIterable<TResult> returnKey(boolean returnKey)

Description copied from interface: FindIterable

Sets the returnKey. If true the find operation will return only the index keys in the resulting documents.

Specified by:

returnKey in interface FindIterable<TResult>

Parameters:

returnKey - the returnKey

Returns:

this

showRecordId

public FindIterable<TResult> showRecordId(boolean showRecordId)

Description copied from interface: FindIterable

Sets the showRecordId. Set to true to add a field $recordId to the returned documents.

Specified by:

showRecordId in interface FindIterable<TResult>

Parameters:

showRecordId - the showRecordId

Returns:

this

snapshot

public FindIterable<TResult> snapshot(boolean snapshot)

Description copied from interface: FindIterable

Sets the snapshot. If true it prevents the cursor from returning a document more than once because of an intervening write operation.

Specified by:

snapshot in interface FindIterable<TResult>

Parameters:

snapshot - the snapshot

Returns:

this

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>

Overrides:

first in class MongoIterableImpl<TResult>

Returns:

T the first item or null.

asReadOperation

protected ReadOperation<BatchCursor<TResult>> asReadOperation()

Specified by:

asReadOperation in class MongoIterableImpl<TResult>

createQueryOperation

private FindOperation<TResult> createQueryOperation()