Type Parameters:

TResult - The type of the result.

All Superinterfaces:

Iterable<TResult>, MongoIterable<TResult>
```
public interface FindIterable<TResult>
extends MongoIterable<TResult>
```
Iterable for find.

Since:

3.0

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`FindIterable<TResult>`	`allowDiskUse(Boolean allowDiskUse)`	Enables writing to temporary files on the server.
`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(String comment)`	Sets the comment to the query.
`FindIterable<TResult>`	`cursorType(CursorType cursorType)`	Sets the cursor type.
`Document`	`explain()`	Explain the execution plan for this operation with the server's default verbosity level
`Document`	`explain(ExplainVerbosity verbosity)`	Explain the execution plan for this operation with the given verbosity level
`<E> E`	`explain(Class<E> explainResultClass)`	Explain the execution plan for this operation with the server's default verbosity level
`<E> E`	`explain(Class<E> explainResultClass, ExplainVerbosity verbosity)`	Explain the execution plan for this operation with the given verbosity level
`FindIterable<TResult>`	`filter(Bson filter)`	Sets the query filter to apply to the query.
`FindIterable<TResult>`	`hint(Bson hint)`	Sets the hint for which index to use.
`FindIterable<TResult>`	`hintString(String hint)`	Sets the hint to apply.
`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, 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, 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>`	`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)`	Deprecated. oplogReplay has been deprecated in MongoDB 4.4.
`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>`	`sort(Bson sort)`	Sets the sort criteria to apply to the query.

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface com.mongodb.client.MongoIterable
cursor, first, into, iterator, map

- Method Detail
  - filter
```
FindIterable<TResult> filter(@Nullable
                             Bson filter)
```
    Sets the query filter to apply to the query.
    
    Parameters:
    
    filter - the filter, which may be null.
    
    Returns:
    
    this
    
    MongoDB documentation
    Filter
  - limit
```
FindIterable<TResult> limit(int limit)
```
    Sets the limit to apply.
    
    Parameters:
    
    limit - the limit, which may be 0
    
    Returns:
    
    this
    
    MongoDB documentation
    Limit
  - skip
```
FindIterable<TResult> skip(int skip)
```
    Sets the number of documents to skip.
    
    Parameters:
    
    skip - the number of documents to skip
    
    Returns:
    
    this
    
    MongoDB documentation
    Skip
  - maxTime
```
FindIterable<TResult> maxTime(long maxTime,
                              TimeUnit timeUnit)
```
    Sets the maximum execution time on the server for this operation.
    
    Parameters:
    
    maxTime - the max time
    
    timeUnit - the time unit, which may not be null
    
    Returns:
    
    this
    
    MongoDB documentation
    Max Time
  - maxAwaitTime
```
FindIterable<TResult> maxAwaitTime(long maxAwaitTime,
                                   TimeUnit timeUnit)
```
    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.
    
    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
    
    Since:
    
    3.2
    
    MongoDB documentation
    Max Time
  - projection
```
FindIterable<TResult> projection(@Nullable
                                 Bson projection)
```
    Sets a document describing the fields to return for all matching documents.
    
    Parameters:
    
    projection - the project document, which may be null.
    
    Returns:
    
    this
    
    MongoDB documentation
    Projection
  - sort
```
FindIterable<TResult> sort(@Nullable
                           Bson sort)
```
    Sets the sort criteria to apply to the query.
    
    Parameters:
    
    sort - the sort criteria, which may be null.
    
    Returns:
    
    this
    
    MongoDB documentation
    Sort
  - noCursorTimeout
```
FindIterable<TResult> noCursorTimeout(boolean noCursorTimeout)
```
    The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.
    
    Parameters:
    
    noCursorTimeout - true if cursor timeout is disabled
    
    Returns:
    
    this
  - oplogReplay
```
@Deprecated
FindIterable<TResult> oplogReplay(boolean oplogReplay)
```
    Deprecated.
    oplogReplay has been deprecated in MongoDB 4.4.
    
    Users should not set this under normal circumstances.
    
    Parameters:
    
    oplogReplay - if oplog replay is enabled
    
    Returns:
    
    this
  - partial
```
FindIterable<TResult> partial(boolean partial)
```
    Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).
    
    Parameters:
    
    partial - if partial results for sharded clusters is enabled
    
    Returns:
    
    this
  - cursorType
```
FindIterable<TResult> cursorType(CursorType cursorType)
```
    Sets the cursor type.
    
    Parameters:
    
    cursorType - the cursor type
    
    Returns:
    
    this
  - batchSize
```
FindIterable<TResult> batchSize(int batchSize)
```
    Sets the number of documents to return per batch.
    
    Specified by:
    
    batchSize in interface MongoIterable<TResult>
    
    Parameters:
    
    batchSize - the batch size
    
    Returns:
    
    this
    
    MongoDB documentation
    Batch Size
  - collation
```
FindIterable<TResult> collation(@Nullable
                                Collation collation)
```
    Sets the collation options
    A null value represents the server default.
    
    Parameters:
    
    collation - the collation options to use
    
    Returns:
    
    this
    
    Since:
    
    3.4
    
    Since server release
    3.4
  - comment
```
FindIterable<TResult> comment(@Nullable
                              String comment)
```
    Sets the comment to the query. A null value means no comment is set.
    
    Parameters:
    
    comment - the comment
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - hint
```
FindIterable<TResult> hint(@Nullable
                           Bson hint)
```
    Sets the hint for which index to use. A null value means no hint is set.
    
    Parameters:
    
    hint - the hint
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - hintString
```
FindIterable<TResult> hintString(@Nullable
                                 String hint)
```
    Sets the hint to apply.
    Note: If hint(Bson) is set that will be used instead of any hint string.
    
    Parameters:
    
    hint - the name of the index which should be used for the operation
    
    Returns:
    
    this
    
    Since:
    
    3.12
  - max
```
FindIterable<TResult> max(@Nullable
                          Bson max)
```
    Sets the exclusive upper bound for a specific index. A null value means no max is set.
    
    Parameters:
    
    max - the max
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - min
```
FindIterable<TResult> min(@Nullable
                          Bson min)
```
    Sets the minimum inclusive lower bound for a specific index. A null value means no max is set.
    
    Parameters:
    
    min - the min
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - returnKey
```
FindIterable<TResult> returnKey(boolean returnKey)
```
    Sets the returnKey. If true the find operation will return only the index keys in the resulting documents.
    
    Parameters:
    
    returnKey - the returnKey
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - showRecordId
```
FindIterable<TResult> showRecordId(boolean showRecordId)
```
    Sets the showRecordId. Set to true to add a field $recordId to the returned documents.
    
    Parameters:
    
    showRecordId - the showRecordId
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - allowDiskUse
```
FindIterable<TResult> allowDiskUse(@Nullable
                                   Boolean allowDiskUse)
```
    Enables writing to temporary files on the server. When set to true, the server can write temporary data to disk while executing the find operation.
    This option is sent only if the caller explicitly sets it to true.
    
    Parameters:
    
    allowDiskUse - the allowDiskUse
    
    Returns:
    
    this
    
    Since:
    
    4.1
    
    Since server release
    4.4
  - explain
```
Document explain()
```
    Explain the execution plan for this operation with the server's default verbosity level
    
    Returns:
    
    the execution plan
    
    Since:
    
    4.2
    
    MongoDB documentation
    reference/command/explain/
    Since server release
    3.2
  - explain
```
Document explain(ExplainVerbosity verbosity)
```
    Explain the execution plan for this operation with the given verbosity level
    
    Parameters:
    
    verbosity - the verbosity of the explanation
    
    Returns:
    
    the execution plan
    
    Since:
    
    4.2
    
    MongoDB documentation
    reference/command/explain/
    Since server release
    3.2
  - explain
```
<E> E explain(Class<E> explainResultClass)
```
    Explain the execution plan for this operation with the server's default verbosity level
    
    Type Parameters:
    
    E - the type of the document class
    
    Parameters:
    
    explainResultClass - the document class to decode into
    
    Returns:
    
    the execution plan
    
    Since:
    
    4.2
    
    MongoDB documentation
    reference/command/explain/
    Since server release
    3.2
  - explain
```
<E> E explain(Class<E> explainResultClass,
              ExplainVerbosity verbosity)
```
    Explain the execution plan for this operation with the given verbosity level
    
    Type Parameters:
    
    E - the type of the document class
    
    Parameters:
    
    explainResultClass - the document class to decode into
    
    verbosity - the verbosity of the explanation
    
    Returns:
    
    the execution plan
    
    Since:
    
    4.2
    
    MongoDB documentation
    reference/command/explain/
    Since server release
    3.2

Interface FindIterable<TResult>

Method Summary

Methods inherited from interface java.lang.Iterable

Methods inherited from interface com.mongodb.client.MongoIterable

Method Detail

filter

limit

skip

maxTime

maxAwaitTime

projection

sort

noCursorTimeout

oplogReplay

partial

cursorType

batchSize

collation

comment

hint

hintString

max

min

returnKey

showRecordId

allowDiskUse

explain

explain

explain

explain