FindOperation (mongo-java-driver 3.6.0 API)

java.lang.Object
- com.mongodb.operation.FindOperation<T>

Type Parameters:

T - the operations result type.

All Implemented Interfaces:

AsyncReadOperation<AsyncBatchCursor<T>>, ReadOperation<BatchCursor<T>>
```
public class FindOperation<T>
extends java.lang.Object
implements AsyncReadOperation<AsyncBatchCursor<T>>, ReadOperation<BatchCursor<T>>
```
An operation that queries a collection using the provided criteria.

Since:

3.0

Constructor Summary

Constructors
Constructor and Description

FindOperation(MongoNamespace namespace, Decoder<T> decoder)
Construct a new instance.

Constructors
Constructor and Description
`FindOperation(MongoNamespace namespace, Decoder<T> decoder)` Construct a new instance.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ReadOperation<BsonDocument>`	`asExplainableOperation(ExplainVerbosity explainVerbosity)` Gets an operation whose execution explains this operation.
`AsyncReadOperation<BsonDocument>`	`asExplainableOperationAsync(ExplainVerbosity explainVerbosity)` Gets an operation whose execution explains this operation.
`FindOperation<T>`	`batchSize(int batchSize)` Sets the number of documents to return per batch.
`FindOperation<T>`	`collation(Collation collation)` Sets the collation options
`FindOperation<T>`	`comment(java.lang.String comment)` Sets the comment to the query.
`FindOperation<T>`	`cursorType(CursorType cursorType)` Sets the cursor type.
`BatchCursor<T>`	`execute(ReadBinding binding)` General execute which can return anything of type T
`void`	`executeAsync(AsyncReadBinding binding, SingleResultCallback<AsyncBatchCursor<T>> callback)` General execute which can return anything of type T
`FindOperation<T>`	`filter(BsonDocument filter)` Sets the query filter to apply to the query.
`int`	`getBatchSize()` Gets the number of documents to return per batch.
`Collation`	`getCollation()` Returns the collation options
`java.lang.String`	`getComment()` Returns the comment to send with the query.
`CursorType`	`getCursorType()` Get the cursor type.
`Decoder<T>`	`getDecoder()` Gets the decoder used to decode the result documents.
`BsonDocument`	`getFilter()` Gets the query filter.
`BsonDocument`	`getHint()` Returns the hint for which index to use.
`int`	`getLimit()` Gets the limit to apply.
`BsonDocument`	`getMax()` Returns the exclusive upper bound for a specific index.
`long`	`getMaxAwaitTime(java.util.concurrent.TimeUnit timeUnit)` The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.
`long`	`getMaxScan()` Returns the maximum number of documents or index keys to scan when executing the query.
`long`	`getMaxTime(java.util.concurrent.TimeUnit timeUnit)` Gets the maximum execution time on the server for this operation.
`BsonDocument`	`getMin()` Returns the minimum inclusive lower bound for a specific index.
`BsonDocument`	`getModifiers()` Gets the query modifiers to apply to this operation.
`MongoNamespace`	`getNamespace()` Gets the namespace.
`BsonDocument`	`getProjection()` Gets a document describing the fields to return for all matching documents.
`ReadConcern`	`getReadConcern()` Gets the read concern
`int`	`getSkip()` Gets the number of documents to skip.
`BsonDocument`	`getSort()` Gets the sort criteria to apply to the query.
`FindOperation<T>`	`hint(BsonDocument hint)` Sets the hint for which index to use.
`boolean`	`isNoCursorTimeout()` Returns true if cursor timeout has been turned off.
`boolean`	`isOplogReplay()` Internal replication use only.
`boolean`	`isPartial()` Returns true if can get partial results from a mongos if some shards are down.
`boolean`	`isReturnKey()` Returns the returnKey.
`boolean`	`isShowRecordId()` Returns the showRecordId.
`boolean`	`isSlaveOk()` Returns true if set to allowed to query non-primary replica set members.
`boolean`	`isSnapshot()` Returns the snapshot.
`FindOperation<T>`	`limit(int limit)` Sets the limit to apply.
`FindOperation<T>`	`max(BsonDocument max)` Sets the exclusive upper bound for a specific index.
`FindOperation<T>`	`maxAwaitTime(long maxAwaitTime, java.util.concurrent.TimeUnit timeUnit)` Sets the maximum await execution time on the server for this operation.
`FindOperation<T>`	`maxScan(long maxScan)` Sets the maximum number of documents or index keys to scan when executing the query.
`FindOperation<T>`	`maxTime(long maxTime, java.util.concurrent.TimeUnit timeUnit)` Sets the maximum execution time on the server for this operation.
`FindOperation<T>`	`min(BsonDocument min)` Sets the minimum inclusive lower bound for a specific index.
`FindOperation<T>`	`modifiers(BsonDocument modifiers)` Deprecated. use the individual setters instead
`FindOperation<T>`	`noCursorTimeout(boolean noCursorTimeout)` Sets if the cursor timeout should be turned off.
`FindOperation<T>`	`oplogReplay(boolean oplogReplay)` Internal replication use only.
`FindOperation<T>`	`partial(boolean partial)` Sets if partial results from a mongos if some shards are down are allowed
`FindOperation<T>`	`projection(BsonDocument projection)` Sets a document describing the fields to return for all matching documents.
`FindOperation<T>`	`readConcern(ReadConcern readConcern)` Sets the read concern
`FindOperation<T>`	`returnKey(boolean returnKey)` Sets the returnKey.
`FindOperation<T>`	`showRecordId(boolean showRecordId)` Sets the showRecordId.
`FindOperation<T>`	`skip(int skip)` Sets the number of documents to skip.
`FindOperation<T>`	`slaveOk(boolean slaveOk)` Sets if allowed to query non-primary replica set members.
`FindOperation<T>`	`snapshot(boolean snapshot)` Sets the snapshot.
`FindOperation<T>`	`sort(BsonDocument sort)` Sets the sort criteria to apply to the query.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FindOperation
```
public FindOperation(MongoNamespace namespace,
                     Decoder<T> decoder)
```
    Construct a new instance.
    
    Parameters:
    
    namespace - the database and collection namespace for the operation.
    
    decoder - the decoder for the result documents.
- Method Detail
  - getNamespace
```
public MongoNamespace getNamespace()
```
    Gets the namespace.
    
    Returns:
    
    the namespace
  - getDecoder
```
public Decoder<T> getDecoder()
```
    Gets the decoder used to decode the result documents.
    
    Returns:
    
    the decoder
  - getFilter
```
public BsonDocument getFilter()
```
    Gets the query filter.
    
    Returns:
    
    the query filter
    
    MongoDB documentation
    
    Filter
  - filter
```
public FindOperation<T> filter(BsonDocument filter)
```
    Sets the query filter to apply to the query.
    
    Parameters:
    
    filter - the filter, which may be null.
    
    Returns:
    
    this
    
    MongoDB documentation
    
    Filter
  - getBatchSize
```
public int getBatchSize()
```
    Gets the number of documents to return per batch. Default to 0, which indicates that the server chooses an appropriate batch size.
    
    Returns:
    
    the batch size, which may be null
    
    MongoDB documentation
    
    Batch Size
  - batchSize
```
public FindOperation<T> batchSize(int batchSize)
```
    Sets the number of documents to return per batch.
    
    Parameters:
    
    batchSize - the batch size
    
    Returns:
    
    this
    
    MongoDB documentation
    
    Batch Size
  - getLimit
```
public int getLimit()
```
    Gets the limit to apply. The default is null.
    
    Returns:
    
    the limit
    
    MongoDB documentation
    
    Limit
  - limit
```
public FindOperation<T> limit(int limit)
```
    Sets the limit to apply.
    
    Parameters:
    
    limit - the limit, which may be null
    
    Returns:
    
    this
    
    MongoDB documentation
    
    Limit
  - getModifiers
```
public BsonDocument getModifiers()
```
    Gets the query modifiers to apply to this operation. The default is not to apply any modifiers.
    
    Returns:
    
    the query modifiers, which may be null
    
    MongoDB documentation
    
    Query Modifiers
  - modifiers
```
@Deprecated
public FindOperation<T> modifiers(BsonDocument modifiers)
```
    Deprecated. use the individual setters instead
    
    Sets the query modifiers to apply to this operation.
    
    Parameters:
    
    modifiers - the query modifiers to apply, which may be null.
    
    Returns:
    
    this
    
    MongoDB documentation
    
    Query Modifiers
  - getProjection
```
public BsonDocument getProjection()
```
    Gets a document describing the fields to return for all matching documents.
    
    Returns:
    
    the project document, which may be null
    
    MongoDB documentation
    
    Projection
  - projection
```
public FindOperation<T> projection(BsonDocument 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
  - getMaxTime
```
public long getMaxTime(java.util.concurrent.TimeUnit timeUnit)
```
    Gets the maximum execution time on the server for this operation. The default is 0, which places no limit on the execution time.
    
    Parameters:
    
    timeUnit - the time unit to return the result in
    
    Returns:
    
    the maximum execution time in the given time unit
  - maxTime
```
public FindOperation<T> maxTime(long maxTime,
                                java.util.concurrent.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
  - getMaxAwaitTime
```
public long getMaxAwaitTime(java.util.concurrent.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:
    
    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
  - maxAwaitTime
```
public FindOperation<T> maxAwaitTime(long maxAwaitTime,
                                     java.util.concurrent.TimeUnit timeUnit)
```
    Sets the maximum await execution time on the server for this operation.
    
    Parameters:
    
    maxAwaitTime - the max await time. A zero value will be ignored, and indicates that the driver should respect the server's default value
    
    timeUnit - the time unit, which may not be null
    
    Returns:
    
    this
    
    Since:
    
    3.2
    
    MongoDB documentation
    
    Max Time
  - getSkip
```
public int getSkip()
```
    Gets the number of documents to skip. The default is 0.
    
    Returns:
    
    the number of documents to skip, which may be null
    
    MongoDB documentation
    
    Skip
  - skip
```
public FindOperation<T> skip(int skip)
```
    Sets the number of documents to skip.
    
    Parameters:
    
    skip - the number of documents to skip
    
    Returns:
    
    this
    
    MongoDB documentation
    
    Skip
  - getSort
```
public BsonDocument getSort()
```
    Gets the sort criteria to apply to the query. The default is null, which means that the documents will be returned in an undefined order.
    
    Returns:
    
    a document describing the sort criteria
    
    MongoDB documentation
    
    Sort
  - sort
```
public FindOperation<T> sort(BsonDocument sort)
```
    Sets the sort criteria to apply to the query.
    
    Parameters:
    
    sort - the sort criteria, which may be null.
    
    Returns:
    
    this
    
    MongoDB documentation
    
    Sort
  - getCursorType
```
public CursorType getCursorType()
```
    Get the cursor type.
    
    Returns:
    
    the cursor type
  - cursorType
```
public FindOperation<T> cursorType(CursorType cursorType)
```
    Sets the cursor type.
    
    Parameters:
    
    cursorType - the cursor type
    
    Returns:
    
    this
  - isSlaveOk
```
public boolean isSlaveOk()
```
    Returns true if set to allowed to query non-primary replica set members.
    
    Returns:
    
    true if set to allowed to query non-primary replica set members.
    
    MongoDB documentation
    
    OP_QUERY
  - slaveOk
```
public FindOperation<T> slaveOk(boolean slaveOk)
```
    Sets if allowed to query non-primary replica set members.
    
    Parameters:
    
    slaveOk - true if allowed to query non-primary replica set members.
    
    Returns:
    
    this
    
    MongoDB documentation
    
    OP_QUERY
  - isOplogReplay
```
public boolean isOplogReplay()
```
    Internal replication use only. Driver users should ordinarily not use this.
    
    Returns:
    
    oplogReplay
    
    MongoDB documentation
    
    OP_QUERY
  - oplogReplay
```
public FindOperation<T> oplogReplay(boolean oplogReplay)
```
    Internal replication use only. Driver users should ordinarily not use this.
    
    Parameters:
    
    oplogReplay - the oplogReplay value
    
    Returns:
    
    this
    
    MongoDB documentation
    
    OP_QUERY
  - isNoCursorTimeout
```
public boolean isNoCursorTimeout()
```
    Returns true if cursor timeout has been turned off.
    The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use.
    
    Returns:
    
    if cursor timeout has been turned off
    
    MongoDB documentation
    
    OP_QUERY
  - noCursorTimeout
```
public FindOperation<T> noCursorTimeout(boolean noCursorTimeout)
```
    Sets if the cursor timeout should be turned off.
    
    Parameters:
    
    noCursorTimeout - true if the cursor timeout should be turned off.
    
    Returns:
    
    this
    
    MongoDB documentation
    
    OP_QUERY
  - isPartial
```
public boolean isPartial()
```
    Returns true if can get partial results from a mongos if some shards are down.
    
    Returns:
    
    if can get partial results from a mongos if some shards are down
    
    MongoDB documentation
    
    OP_QUERY
  - partial
```
public FindOperation<T> partial(boolean partial)
```
    Sets if partial results from a mongos if some shards are down are allowed
    
    Parameters:
    
    partial - allow partial results from a mongos if some shards are down
    
    Returns:
    
    this
    
    MongoDB documentation
    
    OP_QUERY
  - getReadConcern
```
public ReadConcern getReadConcern()
```
    Gets the read concern
    
    Returns:
    
    the read concern
    
    Since:
    
    3.2
    
    MongoDB documentation
    
    Read Concern
  - readConcern
```
public FindOperation<T> readConcern(ReadConcern readConcern)
```
    Sets the read concern
    
    Parameters:
    
    readConcern - the read concern
    
    Returns:
    
    this
    
    Since:
    
    3.2
    
    MongoDB documentation
    
    Read Concern
  - getCollation
```
public Collation getCollation()
```
    Returns the collation options
    
    Returns:
    
    the collation options
    
    Since:
    
    3.4
    
    Since server release
    
    3.4
  - collation
```
public FindOperation<T> collation(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
  - getComment
```
public java.lang.String getComment()
```
    Returns the comment to send with the query. The default is not to include a comment with the query.
    
    Returns:
    
    the comment
    
    Since:
    
    3.5
  - comment
```
public FindOperation<T> comment(java.lang.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
  - getHint
```
public BsonDocument getHint()
```
    Returns the hint for which index to use. The default is not to set a hint.
    
    Returns:
    
    the hint
    
    Since:
    
    3.5
  - hint
```
public FindOperation<T> hint(BsonDocument 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
  - getMax
```
public BsonDocument getMax()
```
    Returns the exclusive upper bound for a specific index. By default there is no max bound.
    
    Returns:
    
    the max
    
    Since:
    
    3.5
  - max
```
public FindOperation<T> max(BsonDocument 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
  - getMin
```
public BsonDocument getMin()
```
    Returns the minimum inclusive lower bound for a specific index. By default there is no min bound.
    
    Returns:
    
    the min
    
    Since:
    
    3.5
  - min
```
public FindOperation<T> min(BsonDocument 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
  - getMaxScan
```
public long getMaxScan()
```
    Returns 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.
    
    Returns:
    
    the maxScan
    
    Since:
    
    3.5
  - maxScan
```
public FindOperation<T> maxScan(long maxScan)
```
    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.
    
    Parameters:
    
    maxScan - the maxScan
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - isReturnKey
```
public boolean isReturnKey()
```
    Returns the returnKey. If true the find operation will return only the index keys in the resulting documents. Default value is false. If returnKey is true and the find command does not use an index, the returned documents will be empty.
    
    Returns:
    
    the returnKey
    
    Since:
    
    3.5
  - returnKey
```
public FindOperation<T> 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
  - isShowRecordId
```
public boolean isShowRecordId()
```
    Returns the showRecordId. Determines whether to return the record identifier for each document. If true, adds a field $recordId to the returned documents. The default is false.
    
    Returns:
    
    the showRecordId
    
    Since:
    
    3.5
  - showRecordId
```
public FindOperation<T> 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
  - isSnapshot
```
public boolean isSnapshot()
```
    Returns the snapshot. Prevents the cursor from returning a document more than once because of an intervening write operation. The default is false.
    
    Returns:
    
    the snapshot
    
    Since:
    
    3.5
  - snapshot
```
public FindOperation<T> snapshot(boolean snapshot)
```
    Sets the snapshot. If true it prevents the cursor from returning a document more than once because of an intervening write operation.
    
    Parameters:
    
    snapshot - the snapshot
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - execute
```
public BatchCursor<T> execute(ReadBinding binding)
```
    Description copied from interface: ReadOperation
    
    General execute which can return anything of type T
    
    Specified by:
    
    execute in interface ReadOperation<BatchCursor<T>>
    
    Parameters:
    
    binding - the binding to execute in the context of
    
    Returns:
    
    T, the result of the execution
  - executeAsync
```
public void executeAsync(AsyncReadBinding binding,
                         SingleResultCallback<AsyncBatchCursor<T>> callback)
```
    Description copied from interface: AsyncReadOperation
    
    General execute which can return anything of type T
    
    Specified by:
    
    executeAsync in interface AsyncReadOperation<AsyncBatchCursor<T>>
    
    Parameters:
    
    binding - the binding to execute in the context of
    
    callback - the callback to be called when the operation has been executed
  - asExplainableOperation
```
public ReadOperation<BsonDocument> asExplainableOperation(ExplainVerbosity explainVerbosity)
```
    Gets an operation whose execution explains this operation.
    
    Parameters:
    
    explainVerbosity - the explain verbosity
    
    Returns:
    
    a read operation that when executed will explain this operation
  - asExplainableOperationAsync
```
public AsyncReadOperation<BsonDocument> asExplainableOperationAsync(ExplainVerbosity explainVerbosity)
```
    Gets an operation whose execution explains this operation.
    
    Parameters:
    
    explainVerbosity - the explain verbosity
    
    Returns:
    
    a read operation that when executed will explain this operation

Class FindOperation<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FindOperation

Method Detail

getNamespace

getDecoder

getFilter

filter

getBatchSize

batchSize

getLimit

limit

getModifiers

modifiers

getProjection

projection

getMaxTime

maxTime

getMaxAwaitTime

maxAwaitTime

getSkip

skip

getSort

sort

getCursorType

cursorType

isSlaveOk

slaveOk

isOplogReplay

oplogReplay

isNoCursorTimeout

noCursorTimeout

isPartial

partial

getReadConcern

readConcern

getCollation

collation

getComment

comment

getHint

hint

getMax

max

getMin

min

getMaxScan

maxScan

isReturnKey

returnKey

isShowRecordId

showRecordId

isSnapshot

snapshot

execute

executeAsync

asExplainableOperation

asExplainableOperationAsync