FindOptions (Morphia 1.3 API)

java.lang.Object
- org.mongodb.morphia.query.FindOptions

```
public class FindOptions
extends Object
```
The options to apply to a find operation (also commonly referred to as a query).

Since:

1.3

MongoDB documentation

Find

OP_QUERY

Constructor Summary

Constructors
Constructor and Description

FindOptions()
Creates an empty options instance.

Constructors
Constructor and Description
`FindOptions()` Creates an empty options instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FindOptions`	`batchSize(int batchSize)` Sets the number of documents to return per batch.
`FindOptions`	`collation(Collation collation)` Sets the collation
`FindOptions`	`copy()` Makes a copy of these find options
`FindOptions`	`cursorType(CursorType cursorType)` Sets the cursor type.
`int`	`getBatchSize()` Gets the number of documents to return per batch.
`Collation`	`getCollation()` Returns the collation options
`CursorType`	`getCursorType()` Get the cursor type.
`int`	`getLimit()` Gets the limit to apply.
`long`	`getMaxAwaitTime(TimeUnit timeUnit)` The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.
`long`	`getMaxTime(TimeUnit timeUnit)` Gets the maximum execution time on the server for this operation.
`ReadConcern`	`getReadConcern()` Returns the readConcern
`ReadPreference`	`getReadPreference()` Returns the readPreference
`int`	`getSkip()` Gets the number of documents to skip.
`boolean`	`isNoCursorTimeout()` The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use.
`boolean`	`isOplogReplay()` Users should not set this under normal circumstances.
`boolean`	`isPartial()` Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).
`FindOptions`	`limit(int limit)` Sets the limit to apply.
`FindOptions`	`maxAwaitTime(long maxAwaitTime, TimeUnit timeUnit)` Sets the maximum await execution time on the server for this operation.
`FindOptions`	`maxTime(long maxTime, TimeUnit timeUnit)` Sets the maximum execution time on the server for this operation.
`FindOptions`	`modifier(String key, Object value)` Adds a modifier to the find operation
`FindOptions`	`noCursorTimeout(boolean noCursorTimeout)` The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use.
`FindOptions`	`oplogReplay(boolean oplogReplay)` Users should not set this under normal circumstances.
`FindOptions`	`partial(boolean partial)` Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).
`FindOptions`	`readConcern(ReadConcern readConcern)` Sets the readConcern
`FindOptions`	`readPreference(ReadPreference readPreference)` Sets the readPreference
`FindOptions`	`skip(int skip)` Sets the number of documents to skip.

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

- Constructor Detail
  - FindOptions
```
public FindOptions()
```
    Creates an empty options instance.
- Method Detail
  - copy
```
public FindOptions copy()
```
    Makes a copy of these find options
    
    Returns:
    
    the new copy
  - getLimit
```
public int getLimit()
```
    Gets the limit to apply. The default is null.
    
    Returns:
    
    the limit
    
    MongoDB documentation
    
    Limit
  - limit
```
public FindOptions limit(int limit)
```
    Sets the limit to apply.
    
    Parameters:
    
    limit - the limit, which may be null
    
    Returns:
    
    this
    
    MongoDB documentation
    
    Limit
  - 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 FindOptions skip(int skip)
```
    Sets the number of documents to skip.
    
    Parameters:
    
    skip - the number of documents to skip
    
    Returns:
    
    this
    
    MongoDB documentation
    
    Skip
  - getMaxTime
```
public long getMaxTime(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
    
    MongoDB documentation
    
    Max Time
  - maxTime
```
public FindOptions 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
  - getMaxAwaitTime
```
public long getMaxAwaitTime(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
    
    MongoDB documentation
    
    Max Time
  - maxAwaitTime
```
public FindOptions maxAwaitTime(long maxAwaitTime,
                                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
    
    MongoDB documentation
    
    Max Time
  - 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 FindOptions batchSize(int batchSize)
```
    Sets the number of documents to return per batch.
    
    Parameters:
    
    batchSize - the batch size
    
    Returns:
    
    this
    
    MongoDB documentation
    
    Batch Size
  - modifier
```
public FindOptions modifier(String key,
                            Object value)
```
    Adds a modifier to the find operation
    
    Parameters:
    
    key - the modifier name
    
    value - the modifier value
    
    Returns:
    
    this
  - isNoCursorTimeout
```
public boolean isNoCursorTimeout()
```
    The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. If true, that timeout is disabled.
    
    Returns:
    
    true if cursor timeout is disabled
  - noCursorTimeout
```
public FindOptions 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
  - isOplogReplay
```
public boolean isOplogReplay()
```
    Users should not set this under normal circumstances.
    
    Returns:
    
    if oplog replay is enabled
  - oplogReplay
```
public FindOptions oplogReplay(boolean oplogReplay)
```
    Users should not set this under normal circumstances.
    
    Parameters:
    
    oplogReplay - if oplog replay is enabled
    
    Returns:
    
    this
  - isPartial
```
public boolean isPartial()
```
    Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).
    
    Returns:
    
    if partial results for sharded clusters is enabled
  - partial
```
public FindOptions 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
  - getCursorType
```
public CursorType getCursorType()
```
    Get the cursor type.
    
    Returns:
    
    the cursor type
  - cursorType
```
public FindOptions cursorType(CursorType cursorType)
```
    Sets the cursor type.
    
    Parameters:
    
    cursorType - the cursor type
    
    Returns:
    
    this
  - getReadPreference
```
public ReadPreference getReadPreference()
```
    Returns the readPreference
    
    Returns:
    
    the readPreference
  - readPreference
```
public FindOptions readPreference(ReadPreference readPreference)
```
    Sets the readPreference
    
    Parameters:
    
    readPreference - the readPreference
    
    Returns:
    
    this
  - getReadConcern
```
public ReadConcern getReadConcern()
```
    Returns the readConcern
    
    Returns:
    
    the readConcern
    
    Since server release
    
    3.2
  - readConcern
```
public FindOptions readConcern(ReadConcern readConcern)
```
    Sets the readConcern
    
    Parameters:
    
    readConcern - the readConcern
    
    Returns:
    
    this
    
    Since server release
    
    3.2
  - getCollation
```
public Collation getCollation()
```
    Returns the collation options
    
    Returns:
    
    the collation options
    
    Since server release
    
    3.4
  - collation
```
public FindOptions collation(Collation collation)
```
    Sets the collation
    
    Parameters:
    
    collation - the collation
    
    Returns:
    
    this
    
    Since server release
    
    3.4

Class FindOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FindOptions

Method Detail

copy

getLimit

limit

getSkip

skip

getMaxTime

maxTime

getMaxAwaitTime

maxAwaitTime

getBatchSize

batchSize

modifier

isNoCursorTimeout

noCursorTimeout

isOplogReplay

oplogReplay

isPartial

partial

getCursorType

cursorType

getReadPreference

readPreference

getReadConcern

readConcern

getCollation

collation