Find (mongodb-async-driver 1.2.2 API)

java.lang.Object
- com.allanbank.mongodb.builder.Find

```
public class Find
extends Object
```
Find provides an immutable container for all of the options for a query.

API Notice:

This class is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2012-2013, Allanbank Consulting, Inc., All Rights Reserved

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Find.Builder
Helper for creating immutable Find queries.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Find.Builder` Helper for creating immutable `Find` queries.

Field Summary

Fields
Modifier and Type Field and Description

static Document ALL
An (empty) query document to find all documents.

Fields
Modifier and Type	Field and Description
`static Document`	`ALL` An (empty) query document to find all documents.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Find(Find.Builder builder)
Creates a new Find.

Constructors
Modifier	Constructor and Description
`protected`	`Find(Find.Builder builder)` Creates a new Find.

Method Summary

Methods
Modifier and Type	Method and Description
`static Find.Builder`	`builder()` Creates a new builder for a `Find`.
`int`	`getBatchSize()` Returns the number of documents to be returned in each batch of results.
`Document`	`getHint()` Returns the hint for which index to use.
`String`	`getHintName()` Returns the hint for which index to use by name.
`int`	`getLimit()` Returns the total number of documents to be returned.
`long`	`getMaximumDocumentsToScan()` Returns a value greater than zero to controls the maximum number of documents that will be scanned for results.
`Document`	`getMaximumRange()` Returns a non-null value to controls the maximum value for the range within the used index.
`Document`	`getMinimumRange()` Returns a non-null value to controls the minimum value for the range within the used index.
`int`	`getNumberToSkip()` Returns the number of documents to skip before returning the first document.
`Document`	`getQuery()` Returns the query document.
`ReadPreference`	`getReadPreference()` Returns the preference for the servers to retrieve the results from.
`Document`	`getReturnFields()` Returns the fields to be returned from the matching documents.
`Document`	`getSort()` Returns the fields to order document by.
`boolean`	`isAwaitData()` Returns true if the cursor returned from the query will block or wait for data.
`boolean`	`isImmortalCursor()` Returns true if the cursor returned from the query will not timeout or die automatically, e.g., immortal, false otherwise.
`boolean`	`isPartialOk()` Returns the partial okay value.
`boolean`	`isReturnIndexKeysOnly()` Returns true if only the index keys will be returned.
`boolean`	`isShowDiskLocation()` Returns true if a "$diskLoc" entry will be added to every returned document with the disk location information.
`boolean`	`isSnapshot()` If returns true then use snapshot mode to ensure document are only returned once.
`boolean`	`isTailable()` Returns true if the cursor returned from the query will be tailable, false otherwise.
`Document`	`toQueryRequest(boolean explain)` This method is not intended for applications to use.
`Document`	`toQueryRequest(boolean explain, ReadPreference readPreference)` This method is not intended for applications to use.

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

- Field Detail
  - ALL
```
public static final Document ALL
```
    An (empty) query document to find all documents.
- Constructor Detail
  - Find
```
protected Find(Find.Builder builder)
```
    Creates a new Find.
    
    Parameters:
    builder - The builder to copy the query fields from.
- Method Detail
  - builder
```
public static Find.Builder builder()
```
    Creates a new builder for a Find.
    
    Returns:
    The builder to construct a Find.
  - getBatchSize
```
public int getBatchSize()
```
    Returns the number of documents to be returned in each batch of results.
    
    Returns:
    The number of documents to be returned in each batch of results.
  - getHint
```
public Document getHint()
```
    Returns the hint for which index to use.
    
    Returns:
    The hint for which index to use.
  - getHintName
```
public String getHintName()
```
    Returns the hint for which index to use by name.
    
    Returns:
    The hint for which index to use by name.
  - getLimit
```
public int getLimit()
```
    Returns the total number of documents to be returned.
    
    Returns:
    The total number of documents to be returned.
  - getMaximumDocumentsToScan
```
public long getMaximumDocumentsToScan()
```
    Returns a value greater than zero to controls the maximum number of documents that will be scanned for results.
    
    Returns:
    A value greater than zero to controls the maximum number of documents that will be scanned for results.
    See Also:
    $maxScan Documentation
  - getMaximumRange
```
public Document getMaximumRange()
```
    Returns a non-null value to controls the maximum value for the range within the used index.
    
    Returns:
    A non-null value to controls the maximum value for the range within the used index.
    See Also:
    $max Documentation
  - getMinimumRange
```
public Document getMinimumRange()
```
    Returns a non-null value to controls the minimum value for the range within the used index.
    
    Returns:
    A non-null value to controls the minimum value for the range within the used index.
    See Also:
    $min Documentation
  - getNumberToSkip
```
public int getNumberToSkip()
```
    Returns the number of documents to skip before returning the first document.
    
    Returns:
    The number of documents to skip before returning the first document.
  - getQuery
```
public Document getQuery()
```
    Returns the query document.
    
    Returns:
    The query document.
  - getReadPreference
```
public ReadPreference getReadPreference()
```
    Returns the preference for the servers to retrieve the results from. May be null in which case the default read preference should be used.
    
    Returns:
    The preference for the servers to retrieve the results from.
  - getReturnFields
```
public Document getReturnFields()
```
    Returns the fields to be returned from the matching documents.
    
    Returns:
    The fields to be returned from the matching documents.
  - getSort
```
public Document getSort()
```
    Returns the fields to order document by.
    
    Returns:
    The fields to order document by.
  - isAwaitData
```
public boolean isAwaitData()
```
    Returns true if the cursor returned from the query will block or wait for data. This is mainly useful with Find.Builder.tailable() cursors.
    
    Returns:
    True if the cursor returned from the query will block or wait for data.
  - isImmortalCursor
```
public boolean isImmortalCursor()
```
    Returns true if the cursor returned from the query will not timeout or die automatically, e.g., immortal, false otherwise.
    
    Returns:
    True if the cursor returned from the query will not timeout or die automatically, e.g., immortal.
    See Also:
    Find.Builder.setimmortalCursor(boolean) for important usage information.
  - isPartialOk
```
public boolean isPartialOk()
```
    Returns the partial okay value. If true then an error in the query should return any partial results.
    
    Returns:
    The partial okay value. If true then an error in the query should return any partial results.
  - isReturnIndexKeysOnly
```
public boolean isReturnIndexKeysOnly()
```
    Returns true if only the index keys will be returned.
    
    Returns:
    True if only the index keys will be returned.
    See Also:
    $returnKey Documentation
  - isShowDiskLocation
```
public boolean isShowDiskLocation()
```
    Returns true if a "$diskLoc" entry will be added to every returned document with the disk location information.
    
    Returns:
    True if a "$diskLoc" entry will be added to every returned document with the disk location information.
    See Also:
    $showDiskLoc Documentation
  - isSnapshot
```
public boolean isSnapshot()
```
    If returns true then use snapshot mode to ensure document are only returned once.
    
    Returns:
    True then use snapshot mode to ensure document are only returned once.
  - isTailable
```
public boolean isTailable()
```
    Returns true if the cursor returned from the query will be tailable, false otherwise.
    
    Returns:
    True if the cursor returned from the query will be tailable, false otherwise.
    See Also:
    Find.Builder.setTailable(boolean) for important usage information.
  - toQueryRequest
```
public Document toQueryRequest(boolean explain)
```
    This method is not intended for applications to use. Applications should pass the Find object to the appropriate method on the MongoCollection interface. This method is used internally by the driver and is public for cross package access only.
    Converts the Find into a raw query request document to send to the MongoDB server.
    
    Parameters:
    explain - If true then explain the query procedure instead of returning results.
    
    Returns:
    The query request document to send to the MongoDB server.
  - toQueryRequest
```
public Document toQueryRequest(boolean explain,
                      ReadPreference readPreference)
```
    This method is not intended for applications to use. Applications should pass the Find object to the appropriate method on the MongoCollection interface. This method is used internally by the driver and is public for cross package access only.
    Converts the Find into a raw query request document to send to the MongoDB server including the provided read preferences.
    
    Parameters:
    explain - If true then explain the query procedure instead of returning results.
    readPreference - The read preference to include in the query request document.
    
    Returns:
    The query request document to send to the MongoDB server.

Class Find

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ALL

Constructor Detail

Find

Method Detail

builder

getBatchSize

getHint

getHintName

getLimit

getMaximumDocumentsToScan

getMaximumRange

getMinimumRange

getNumberToSkip

getQuery

getReadPreference

getReturnFields

getSort

isAwaitData

isImmortalCursor

isPartialOk

isReturnIndexKeysOnly

isShowDiskLocation

isSnapshot

isTailable

toQueryRequest

toQueryRequest