Find.Builder (mongodb-async-driver 2.0.1 API)

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

Enclosing class:

Find
```
public static class Find.Builder
extends Object
```
Helper for creating immutable Find queries.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`myAwaitData` If set to true requests for data will block, waiting for data.
`protected int`	`myBatchSize` The number of documents to be returned in each batch of results.
`protected Document`	`myHint` The hint for which index to use.
`protected String`	`myHintName` The hint for which index to use.
`protected boolean`	`myImmortalCursor` If set to true the cursor returned from the query will not timeout or die automatically, e.g., immortal.
`protected int`	`myLimit` The total number of documents to be returned.
`protected long`	`myMaximumDocumentsToScan` If set then controls the maximum number of documents that will be scanned for results.
`protected Document`	`myMaximumRange` If set then controls the maximum value for the range within the used index.
`protected long`	`myMaximumTimeMilliseconds` The maximum amount of time to allow the query to run.
`protected Document`	`myMinimumRange` If set then controls the minimum value for the range within the used index.
`protected int`	`myNumberToSkip` The number of documents to skip before returning the first document.
`protected boolean`	`myPartialOk` If true then an error in the query should return any partial results.
`protected Document`	`myProjection` The fields to be returned from the matching documents.
`protected Document`	`myQuery` The query document.
`protected ReadPreference`	`myReadPreference` The preference for which servers to use to retrieve the results.
`protected boolean`	`myReturnIndexKeysOnly` If set to true then only the index keys will be returned.
`protected boolean`	`myShowDiskLocation` If set to true then a "$diskLoc" entry will be added to every returned document with the disk location information.
`protected boolean`	`mySnapshot` If set to true then use snapshot mode to ensure document are only returned once.
`protected Document`	`mySort` The fields to order the document on.
`protected boolean`	`myTailable` If set to true the cursor returned from the query will be tailable.

Constructor Summary

Constructors
Constructor and Description

Find.Builder()
Creates a new Builder.

Find.Builder(DocumentAssignable query)
Creates a new Builder.

Constructors
Constructor and Description
`Find.Builder()` Creates a new Builder.
`Find.Builder(DocumentAssignable query)` Creates a new Builder.

Method Summary

Methods
Modifier and Type	Method and Description
`Find.Builder`	`batchSize(int batchSize)` Sets the value of the number of documents to be returned in each batch.
`Find`	`build()` Constructs a new `Find` object from the state of the builder.
`Find.Builder`	`hint(DocumentAssignable indexFields)` Sets the value of hint as to which index should be used to execute the query.
`Find.Builder`	`hint(Element... indexFields)` Sets the value of hint as to which index should be used to execute the query.
`Find.Builder`	`hint(String indexName)` Sets the value of hint as to which index should be used to execute the query.
`Find.Builder`	`immortalCursor()` Sets the cursor returned from the query to never timeout or die automatically, e.g., immortal.
`Find.Builder`	`immortalCursor(boolean immortal)` If set to true the cursor returned from the query will not timeout or die automatically, e.g., immortal.
`Find.Builder`	`limit(int limit)` Sets the value of the total number of documents to be returned.
`Find.Builder`	`max(DocumentAssignable maximumRange)` Sets the value of maximum range for the index used to the new value.
`Find.Builder`	`maximumTime(long timeLimit, TimeUnit timeLimitUnits)` Sets the maximum number of milliseconds to allow the query to run before aborting the request on the server.
`Find.Builder`	`maxScan(long maximumDocumentsToScan)` Sets the value of maximum number of documents that will be scanned for results to the new value.
`Find.Builder`	`min(DocumentAssignable minimumRange)` Sets the value of minimum range for the index used to the new value.
`Find.Builder`	`partialOk()` Sets that if there is an error then the query should return any partial results.
`Find.Builder`	`partialOk(boolean partialOk)` Sets the value of partial okay to the new value.
`Find.Builder`	`projection(DocumentAssignable projection)` Sets the value of the fields to be projected from the matching documents to the new value.
`Find.Builder`	`projection(String... fieldNames)` Sets the value of the fields to be returned from the matching documents to the new value.
`Find.Builder`	`query(DocumentAssignable query)` Sets the value of the query document to the new value.
`Find.Builder`	`readPreference(ReadPreference readPreference)` Sets the preference for the set of servers to retrieve the results from.
`Find.Builder`	`reset()` Resets the builder back to its initial state for reuse.
`Find.Builder`	`returnFields(DocumentAssignable returnFields)` Deprecated. Replaced with the MongoDB standardized name: `projection`. This method will be removed on or after the 1.4 release.
`Find.Builder`	`returnFields(String... fieldNames)` Deprecated. Replaced with the MongoDB standardized name: `projection`. This method will be removed on or after the 1.4 release.
`Find.Builder`	`returnKey()` Sets that only index keys should be returned.
`Find.Builder`	`returnKey(boolean returnIndexKeysOnly)` Sets the value for if only index keys should be returned to the new value.
`Find.Builder`	`setAwaitData(boolean awaitData)` If set to true requests for data will block, waiting for data.
`Find.Builder`	`setBatchSize(int batchSize)` Sets the value of the number of documents to be returned in each batch.
`Find.Builder`	`setHint(DocumentAssignable indexFields)` Sets the value of hint as to which index should be used to execute the query.
`Find.Builder`	`setHint(Element... indexFields)` Sets the value of hint as to which index should be used to execute the query.
`Find.Builder`	`setHint(String indexName)` Sets the value of hint as to which index should be used to execute the query.
`Find.Builder`	`setImmortalCursor(boolean immortal)` If set to true the cursor returned from the query will not timeout or die automatically, e.g., immortal.
`Find.Builder`	`setLimit(int limit)` Sets the value of the total number of documents to be returned.
`Find.Builder`	`setMaximumDocumentsToScan(long maximumDocumentsToScan)` Sets the value of maximum number of documents that will be scanned for results to the new value.
`Find.Builder`	`setMaximumRange(DocumentAssignable maximumRange)` Sets the value of maximum range for the index used to the new value.
`Find.Builder`	`setMaximumTimeMilliseconds(long maximumTimeMilliseconds)` Sets the maximum number of milliseconds to allow the query to run before aborting the request on the server.
`Find.Builder`	`setMinimumRange(DocumentAssignable minimumRange)` Sets the value of minimum range for the index used to the new value.
`Find.Builder`	`setNumberToSkip(int numberToSkip)` Sets the value of the number of documents to skip before returning the first document to the new value.
`Find.Builder`	`setPartialOk(boolean partialOk)` Sets the value of partial okay to the new value.
`Find.Builder`	`setProjection(DocumentAssignable projection)` Sets the value of the fields to be projected or returned from the matching documents to the new value.
`Find.Builder`	`setQuery(DocumentAssignable query)` Sets the value of the query document to the new value.
`Find.Builder`	`setReadPreference(ReadPreference readPreference)` Sets the preference for the set of servers to retrieve the results from.
`Find.Builder`	`setReturnFields(DocumentAssignable returnFields)` Deprecated. Replaced with the MongoDB standardized name: `projection`. This method will be removed on or after the 1.4 release.
`Find.Builder`	`setReturnIndexKeysOnly(boolean returnIndexKeysOnly)` Sets the value for if only index keys should be returned to the new value.
`Find.Builder`	`setShowDiskLocation(boolean showDiskLocation)` Sets the value if the disk location for each document should be returned to the new value.
`Find.Builder`	`setSnapshot(boolean snapshot)` Sets the value of snapshot to the new value.
`Find.Builder`	`setSort(DocumentAssignable sortFields)` Sets the value of the fields to to sort matching documents by.
`Find.Builder`	`setSort(IntegerElement... sortFields)` Sets the value of the fields to to sort matching documents by.
`Find.Builder`	`setTailable(boolean tailable)` If set to true the cursor returned from the query will be tailable.
`Find.Builder`	`showDiskLoc()` Sets that the disk location for each document should be returned.
`Find.Builder`	`showDiskLoc(boolean showDiskLocation)` Sets the value if the disk location for each document should be returned to the new value.
`Find.Builder`	`skip(int numberToSkip)` Sets the value of the number of documents to skip before returning the first document to the new value.
`Find.Builder`	`snapshot()` Sets that the query should ensure that documents are only returned once.
`Find.Builder`	`snapshot(boolean snapshot)` Sets the value of snapshot to the new value.
`Find.Builder`	`sort(DocumentAssignable sortFields)` Sets the value of the fields to to sort matching documents by.
`Find.Builder`	`sort(IntegerElement... sortFields)` Sets the value of the fields to to sort matching documents by.
`Find.Builder`	`tailable()` Sets the the cursor returned from the query to be `setTailable(true)` and `setAwaitData(true)`.

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

- Field Detail
  - myAwaitData
```
protected boolean myAwaitData
```
    If set to true requests for data will block, waiting for data. Useful with tailable() cursors.
  - myBatchSize
```
protected int myBatchSize
```
    The number of documents to be returned in each batch of results.
  - myHint
```
protected Document myHint
```
    The hint for which index to use.
  - myHintName
```
protected String myHintName
```
    The hint for which index to use.
  - myImmortalCursor
```
protected boolean myImmortalCursor
```
    If set to true the cursor returned from the query will not timeout or die automatically, e.g., immortal.
  - myLimit
```
protected int myLimit
```
    The total number of documents to be returned.
  - myMaximumDocumentsToScan
```
protected long myMaximumDocumentsToScan
```
    If set then controls the maximum number of documents that will be scanned for results.
  - myMaximumRange
```
protected Document myMaximumRange
```
    If set then controls the maximum value for the range within the used index.
  - myMaximumTimeMilliseconds
```
protected long myMaximumTimeMilliseconds
```
    The maximum amount of time to allow the query to run.
  - myMinimumRange
```
protected Document myMinimumRange
```
    If set then controls the minimum value for the range within the used index.
  - myNumberToSkip
```
protected int myNumberToSkip
```
    The number of documents to skip before returning the first document.
  - myPartialOk
```
protected boolean myPartialOk
```
    If true then an error in the query should return any partial results.
  - myProjection
```
protected Document myProjection
```
    The fields to be returned from the matching documents.
  - myQuery
```
protected Document myQuery
```
    The query document.
  - myReadPreference
```
protected ReadPreference myReadPreference
```
    The preference for which servers to use to retrieve the results.
  - myReturnIndexKeysOnly
```
protected boolean myReturnIndexKeysOnly
```
    If set to true then only the index keys will be returned.
  - myShowDiskLocation
```
protected boolean myShowDiskLocation
```
    If set to true then a "$diskLoc" entry will be added to every returned document with the disk location information.
  - mySnapshot
```
protected boolean mySnapshot
```
    If set to true then use snapshot mode to ensure document are only returned once.
  - mySort
```
protected Document mySort
```
    The fields to order the document on.
  - myTailable
```
protected boolean myTailable
```
    If set to true the cursor returned from the query will be tailable.
- Constructor Detail
  - Find.Builder
```
public Find.Builder()
```
    Creates a new Builder.
  - Find.Builder
```
public Find.Builder(DocumentAssignable query)
```
    Creates a new Builder.
    
    Parameters:
    query - The query document.
- Method Detail
  - batchSize
```
public Find.Builder batchSize(int batchSize)
```
    Sets the value of the number of documents to be returned in each batch.
    This method delegates to setBatchSize(int).
    
    Parameters:
    batchSize - The new value for the number of documents to be returned in each batch.
    
    Returns:
    This builder for chaining method calls.
  - build
```
public Find build()
```
    Constructs a new Find object from the state of the builder.
    
    Returns:
    The new Find object.
  - hint
```
public Find.Builder hint(DocumentAssignable indexFields)
```
    Sets the value of hint as to which index should be used to execute the query.
    This method delegates to setHint(DocumentAssignable).
    
    Parameters:
    indexFields - The new value for the fields of the index to use to execute the query.
    
    Returns:
    This builder for chaining method calls.
  - hint
```
public Find.Builder hint(Element... indexFields)
```
    Sets the value of hint as to which index should be used to execute the query.
    This method delegates to setHint(Element...).
    
    This method is intended to be used with the Index class's static methods:
    import static com.allanbank.mongodb.builder.Index.asc; import static com.allanbank.mongodb.builder.Index.desc; Find.Builder builder = new Find.Builder(); builder.setHint( asc("f"), desc("g") ); ...
    Parameters:
    indexFields - The new value for the fields of the index to use to execute the query.
    
    Returns:
    This builder for chaining method calls.
  - hint
```
public Find.Builder hint(String indexName)
```
    Sets the value of hint as to which index should be used to execute the query.
    This method delegates to the setHint(String) method.
    
    Parameters:
    indexName - The new value for the name of the index to use to execute the query.
    
    Returns:
    This builder for chaining method calls.
  - immortalCursor
```
public Find.Builder immortalCursor()
```
    Sets the cursor returned from the query to never timeout or die automatically, e.g., immortal.
    This method delegates to setImmortalCursor(true). See its JavaDoc for important usage guidelines.
    
    Returns:
    This builder for chaining method calls.
  - immortalCursor
```
public Find.Builder immortalCursor(boolean immortal)
```
    If set to true the cursor returned from the query will not timeout or die automatically, e.g., immortal.
    This method delegates to setImmortalCursor(boolean). See its JavaDoc important usage guidelines.
    
    Parameters:
    immortal - True if the cursor returned from the query should be immortal.
    
    Returns:
    This builder for chaining method calls.
  - limit
```
public Find.Builder limit(int limit)
```
    Sets the value of the total number of documents to be returned.
    This method delegates to setLimit(int).
    
    Parameters:
    limit - The new value for the total number of documents to be returned.
    
    Returns:
    This builder for chaining method calls.
  - max
```
public Find.Builder max(DocumentAssignable maximumRange)
```
    Sets the value of maximum range for the index used to the new value.
    This method delegates to setMaximumRange(DocumentAssignable) .
    
    Parameters:
    maximumRange - The new value for the maximum range for the index used.
    
    Returns:
    This builder for chaining method calls.
  - maximumTime
```
public Find.Builder maximumTime(long timeLimit,
                       TimeUnit timeLimitUnits)
```
    Sets the maximum number of milliseconds to allow the query to run before aborting the request on the server.
    This method equivalent to setMaximumTimeMilliseconds(timeLimitUnits.toMillis(timeLimit).
    
    Parameters:
    timeLimit - The new maximum amount of time to allow the query to run.
    timeLimitUnits - The units for the maximum amount of time to allow the query to run.
    
    Returns:
    This Find.Builder for method call chaining.
    Since:
    
    MongoDB 2.6
  - maxScan
```
public Find.Builder maxScan(long maximumDocumentsToScan)
```
    Sets the value of maximum number of documents that will be scanned for results to the new value.
    This method Delegates to setMaximumDocumentsToScan(long).
    
    Parameters:
    maximumDocumentsToScan - The new value for the maximum number of documents that will be scanned for results.
    
    Returns:
    This builder for chaining method calls.
  - min
```
public Find.Builder min(DocumentAssignable minimumRange)
```
    Sets the value of minimum range for the index used to the new value.
    This method delegates to setMinimumRange(DocumentAssignable) .
    
    Parameters:
    minimumRange - The new value for the minimum range for the index used.
    
    Returns:
    This builder for chaining method calls.
  - partialOk
```
public Find.Builder partialOk()
```
    Sets that if there is an error then the query should return any partial results.
    This method delegates to setPartialOk(true).
    
    Returns:
    This builder for chaining method calls.
  - partialOk
```
public Find.Builder partialOk(boolean partialOk)
```
    Sets the value of partial okay to the new value. If true then an error in the query should return any partial results.
    This method delegates to setPartialOk(boolean).
    
    Parameters:
    partialOk - The new value for the partial okay.
    
    Returns:
    This builder for chaining method calls.
  - projection
```
public Find.Builder projection(DocumentAssignable projection)
```
    Sets the value of the fields to be projected from the matching documents to the new value.
    This method delegates to setProjection(DocumentAssignable) .
    
    Parameters:
    projection - The new value for the fields to be projected from the matching documents.
    
    Returns:
    This builder for chaining method calls.
  - projection
```
public Find.Builder projection(String... fieldNames)
```
    Sets the value of the fields to be returned from the matching documents to the new value.
    This method adds each field to a document with a value of 1 and then delegates to the setProjection(DocumentAssignable) method.
    
    Parameters:
    fieldNames - The names of the fields to be returned.
    
    Returns:
    This builder for chaining method calls.
  - query
```
public Find.Builder query(DocumentAssignable query)
```
    Sets the value of the query document to the new value.
    This method delegates to setQuery(DocumentAssignable).
    
    Parameters:
    query - The new value for the query document.
    
    Returns:
    This builder for chaining method calls.
  - readPreference
```
public Find.Builder readPreference(ReadPreference readPreference)
```
    Sets the preference for the set of servers to retrieve the results from.
    This method delegates to setReadPreference(ReadPreference).
    
    Parameters:
    readPreference - The new value for the preference of which server to return the results from.
    
    Returns:
    This builder for chaining method calls.
  - reset
```
public Find.Builder reset()
```
    Resets the builder back to its initial state for reuse.
    
    Returns:
    This builder for chaining method calls.
  - returnFields
```
@Deprecated
public Find.Builder returnFields(DocumentAssignable returnFields)
```
    Deprecated. Replaced with the MongoDB standardized name: projection. This method will be removed on or after the 1.4 release.
    
    Sets the value of the fields to be returned from the matching documents to the new value.
    This method delegates to projection(DocumentAssignable) .
    
    Parameters:
    returnFields - The new value for the fields to be returned from the matching documents.
    
    Returns:
    This builder for chaining method calls.
  - returnFields
```
@Deprecated
public Find.Builder returnFields(String... fieldNames)
```
    Deprecated. Replaced with the MongoDB standardized name: projection. This method will be removed on or after the 1.4 release.
    
    Sets the value of the fields to be returned from the matching documents to the new value.
    This method delegates to the projection(String[]) method.
    
    Parameters:
    fieldNames - The names of the fields to be returned.
    
    Returns:
    This builder for chaining method calls.
  - returnKey
```
public Find.Builder returnKey()
```
    Sets that only index keys should be returned.
    This method delegates to setReturnIndexKeysOnly(true)
    
    Returns:
    This builder for chaining method calls.
  - returnKey
```
public Find.Builder returnKey(boolean returnIndexKeysOnly)
```
    Sets the value for if only index keys should be returned to the new value.
    This method delegates to setReturnIndexKeysOnly(boolean)
    
    Parameters:
    returnIndexKeysOnly - The new value for if only index keys should be returned.
    
    Returns:
    This builder for chaining method calls.
    See Also:
    $returnKey Documentation
  - setAwaitData
```
public Find.Builder setAwaitData(boolean awaitData)
```
    If set to true requests for data will block, waiting for data. Useful with tailable() cursors.
    
    Parameters:
    awaitData - True if requests for data will block, waiting for data. Useful with tailable() cursors.
    
    Returns:
    This builder for chaining method calls.
  - setBatchSize
```
public Find.Builder setBatchSize(int batchSize)
```
    Sets the value of the number of documents to be returned in each batch.
    
    Parameters:
    batchSize - The new value for the number of documents to be returned in each batch.
    
    Returns:
    This builder for chaining method calls.
  - setHint
```
public Find.Builder setHint(DocumentAssignable indexFields)
```
    Sets the value of hint as to which index should be used to execute the query.
    
    Parameters:
    indexFields - The new value for the fields of the index to use to execute the query.
    
    Returns:
    This builder for chaining method calls.
    See Also:
    $hint Documentation
  - setHint
```
public Find.Builder setHint(Element... indexFields)
```
    Sets the value of hint as to which index should be used to execute the query.
    This method is intended to be used with the Index class's static methods:
    import static com.allanbank.mongodb.builder.Index.asc; import static com.allanbank.mongodb.builder.Index.desc; Find.Builder builder = new Find.Builder(); builder.setHint( asc("f"), desc("g") ); ...
    Parameters:
    indexFields - The new value for the fields of the index to use to execute the query.
    
    Returns:
    This builder for chaining method calls.
    See Also:
    $hint Documentation
  - setHint
```
public Find.Builder setHint(String indexName)
```
    Sets the value of hint as to which index should be used to execute the query.
    
    Parameters:
    indexName - The new value for the name of the index to use to execute the query.
    
    Returns:
    This builder for chaining method calls.
    See Also:
    $hint Documentation
  - setImmortalCursor
```
public Find.Builder setImmortalCursor(boolean immortal)
```
    If set to true the cursor returned from the query will not timeout or die automatically, e.g., immortal. The user must either exhaust the results of the query or explicitly close the MongoIterator or MongoCursorControl returned.
    Under normal circumstances using an immortal cursor is not needed and its repeated incorrect usage could cause a memory leak on the MongoDB server and impact performance. Extreme caution should be used to ensure the number of active cursors on the server does not grow without bounds.
    
    Parameters:
    immortal - True if the cursor returned from the query should be immortal.
    
    Returns:
    This builder for chaining method calls.
  - setLimit
```
public Find.Builder setLimit(int limit)
```
    Sets the value of the total number of documents to be returned.
    
    Parameters:
    limit - The new value for the total number of documents to be returned.
    
    Returns:
    This builder for chaining method calls.
  - setMaximumDocumentsToScan
```
public Find.Builder setMaximumDocumentsToScan(long maximumDocumentsToScan)
```
    Sets the value of maximum number of documents that will be scanned for results to the new value.
    If set to a value greater than zero then controls the maximum number of documents that will be scanned for results.
    
    Parameters:
    maximumDocumentsToScan - The new value for the maximum number of documents that will be scanned for results.
    
    Returns:
    This builder for chaining method calls.
    See Also:
    $maxScan Documentation
  - setMaximumRange
```
public Find.Builder setMaximumRange(DocumentAssignable maximumRange)
```
    Sets the value of maximum range for the index used to the new value.
    If set then controls the maximum value for the range within the used index.
    
    Parameters:
    maximumRange - The new value for the maximum range for the index used.
    
    Returns:
    This builder for chaining method calls.
    See Also:
    $max Documentation
  - setMaximumTimeMilliseconds
```
public Find.Builder setMaximumTimeMilliseconds(long maximumTimeMilliseconds)
```
    Sets the maximum number of milliseconds to allow the query to run before aborting the request on the server.
    
    Parameters:
    maximumTimeMilliseconds - The new maximum number of milliseconds to allow the query to run.
    
    Returns:
    This Find.Builder for method call chaining.
    Since:
    
    MongoDB 2.6
  - setMinimumRange
```
public Find.Builder setMinimumRange(DocumentAssignable minimumRange)
```
    Sets the value of minimum range for the index used to the new value.
    If set then controls the minimum value for the range within the used index.
    
    Parameters:
    minimumRange - The new value for the minimum range for the index used.
    
    Returns:
    This builder for chaining method calls.
    See Also:
    $min Documentation
  - setNumberToSkip
```
public Find.Builder setNumberToSkip(int numberToSkip)
```
    Sets the value of the number of documents to skip before returning the first document to the new value.
    
    Parameters:
    numberToSkip - The new value for the number of documents to skip before returning the first document.
    
    Returns:
    This builder for chaining method calls.
  - setPartialOk
```
public Find.Builder setPartialOk(boolean partialOk)
```
    Sets the value of partial okay to the new value. If true then an error in the query should return any partial results.
    
    Parameters:
    partialOk - The new value for the partial okay.
    
    Returns:
    This builder for chaining method calls.
  - setProjection
```
public Find.Builder setProjection(DocumentAssignable projection)
```
    Sets the value of the fields to be projected or returned from the matching documents to the new value.
    
    Parameters:
    projection - The new value for the fields to be projected from the matching documents.
    
    Returns:
    This builder for chaining method calls.
  - setQuery
```
public Find.Builder setQuery(DocumentAssignable query)
```
    Sets the value of the query document to the new value.
    
    Parameters:
    query - The new value for the query document.
    
    Returns:
    This builder for chaining method calls.
  - setReadPreference
```
public Find.Builder setReadPreference(ReadPreference readPreference)
```
    Sets the preference for the set of servers to retrieve the results from.
    
    Parameters:
    readPreference - The new value for the preference of which server to return the results from.
    
    Returns:
    This builder for chaining method calls.
  - setReturnFields
```
@Deprecated
public Find.Builder setReturnFields(DocumentAssignable returnFields)
```
    Deprecated. Replaced with the MongoDB standardized name: projection. This method will be removed on or after the 1.4 release.
    
    Sets the value of the fields to be returned from the matching documents to the new value.
    This method delegates to setProjection(DocumentAssignable) .
    
    Parameters:
    returnFields - The new value for the fields to be returned from the matching documents.
    
    Returns:
    This builder for chaining method calls.
  - setReturnIndexKeysOnly
```
public Find.Builder setReturnIndexKeysOnly(boolean returnIndexKeysOnly)
```
    Sets the value for if only index keys should be returned to the new value.
    If set to true then only the index keys will be returned.
    
    Parameters:
    returnIndexKeysOnly - The new value for if only index keys should be returned.
    
    Returns:
    This builder for chaining method calls.
    See Also:
    $returnKey Documentation
  - setShowDiskLocation
```
public Find.Builder setShowDiskLocation(boolean showDiskLocation)
```
    Sets the value if the disk location for each document should be returned to the new value.
    If set to true then a "$diskLoc" entry will be added to every returned document with the disk location information.
    
    Parameters:
    showDiskLocation - The new value for the if the disk location for each document should be returned.
    
    Returns:
    This builder for chaining method calls.
    See Also:
    $showDiskLoc Documentation
  - setSnapshot
```
public Find.Builder setSnapshot(boolean snapshot)
```
    Sets the value of snapshot to the new value. If set to true then use snapshot mode to ensure document are only returned once.
    
    Parameters:
    snapshot - The new value for the partial okay.
    
    Returns:
    This builder for chaining method calls.
    See Also:
    $snapshot Documentation
  - setSort
```
public Find.Builder setSort(DocumentAssignable sortFields)
```
    Sets the value of the fields to to sort matching documents by.
    
    Parameters:
    sortFields - The new value for the fields to sort matching documents by.
    
    Returns:
    This builder for chaining method calls.
    See Also:
    $orderby Documentation
  - setSort
```
public Find.Builder setSort(IntegerElement... sortFields)
```
    Sets the value of the fields to to sort matching documents by.
    This method is intended to be used with the Sort class's static methods:
    import static com.allanbank.mongodb.builder.Sort.asc; import static com.allanbank.mongodb.builder.Sort.desc; Find.Builder builder = new Find.Builder(); builder.setSort( asc("f"), desc("g") ); ...
    Parameters:
    sortFields - The new value for the fields to sort matching documents by.
    
    Returns:
    This builder for chaining method calls.
    See Also:
    $orderby Documentation
  - setTailable
```
public Find.Builder setTailable(boolean tailable)
```
    If set to true the cursor returned from the query will be tailable.
    Testing has shown that a tailable cursor on an empty collection will not setup a cursor on the MongoDB server and will immediately return false from Iterator.hasNext().
    
    When using a tailable cursor that has exhausted the available data will cause the Iterator.hasNext() calls to block until more data is available. The connection that is used to request more documents will also be blocked for short intervals (measured to be ~2.25 seconds with 2.0.7). Any requests submitted behind the cursors request will also be blocked.
    
    It is highly recommended that the number of connections within the MongoClientConfiguration be at least 1 more than the maximum number of active tailable cursors.
    
    Parameters:
    tailable - The new value for if the cursor returned from the query will be tailable.
    
    Returns:
    This builder for chaining method calls.
  - showDiskLoc
```
public Find.Builder showDiskLoc()
```
    Sets that the disk location for each document should be returned.
    This method delegates to setShowDiskLocation(true).
    
    Returns:
    This builder for chaining method calls.
  - showDiskLoc
```
public Find.Builder showDiskLoc(boolean showDiskLocation)
```
    Sets the value if the disk location for each document should be returned to the new value.
    This method delegates to setShowDiskLocation(boolean).
    
    Parameters:
    showDiskLocation - The new value for the if the disk location for each document should be returned.
    
    Returns:
    This builder for chaining method calls.
  - skip
```
public Find.Builder skip(int numberToSkip)
```
    Sets the value of the number of documents to skip before returning the first document to the new value.
    This method delegates to setNumberToSkip(int).
    
    Parameters:
    numberToSkip - The new value for the number of documents to skip before returning the first document.
    
    Returns:
    This builder for chaining method calls.
  - snapshot
```
public Find.Builder snapshot()
```
    Sets that the query should ensure that documents are only returned once.
    This method delegates to setSnapshot(true).
    
    Returns:
    This builder for chaining method calls.
  - snapshot
```
public Find.Builder snapshot(boolean snapshot)
```
    Sets the value of snapshot to the new value. If set to true then use snapshot mode to ensure document are only returned once.
    This method delegates to setSnapshot(boolean).
    
    Parameters:
    snapshot - The new value for the partial okay.
    
    Returns:
    This builder for chaining method calls.
  - sort
```
public Find.Builder sort(DocumentAssignable sortFields)
```
    Sets the value of the fields to to sort matching documents by.
    This method delegates to setSort(DocumentAssignable).
    
    Parameters:
    sortFields - The new value for the fields to sort matching documents by.
    
    Returns:
    This builder for chaining method calls.
  - sort
```
public Find.Builder sort(IntegerElement... sortFields)
```
    Sets the value of the fields to to sort matching documents by.
    This method delegates to setSort(IntegerElement...).
    
    This method is intended to be used with the Sort class's static methods:
    import static com.allanbank.mongodb.builder.Sort.asc; import static com.allanbank.mongodb.builder.Sort.desc; Find.Builder builder = new Find.Builder(); builder.sort( asc("f"), desc("g") ); ...
    Parameters:
    sortFields - The new value for the fields to sort matching documents by.
    
    Returns:
    This builder for chaining method calls.
  - tailable
```
public Find.Builder tailable()
```
    Sets the the cursor returned from the query to be setTailable(true) and setAwaitData(true).
    
    Returns:
    This builder for chaining method calls.
    See Also:
    setTailable(boolean) for important usage information.

Class Find.Builder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

myAwaitData

myBatchSize

myHint

myHintName

myImmortalCursor

myLimit

myMaximumDocumentsToScan

myMaximumRange

myMaximumTimeMilliseconds

myMinimumRange

myNumberToSkip

myPartialOk

myProjection

myQuery

myReadPreference

myReturnIndexKeysOnly

myShowDiskLocation

mySnapshot

mySort

myTailable

Constructor Detail

Find.Builder

Find.Builder

Method Detail

batchSize

build

hint

hint

hint

immortalCursor

immortalCursor

limit

max

maximumTime

maxScan

min

partialOk

partialOk

projection

projection

query

readPreference

reset

returnFields

returnFields

returnKey

returnKey

setAwaitData

setBatchSize

setHint

setHint

setHint

setImmortalCursor

setLimit

setMaximumDocumentsToScan

setMaximumRange

setMaximumTimeMilliseconds

setMinimumRange

setNumberToSkip

setPartialOk

setProjection

setQuery

setReadPreference

setReturnFields

setReturnIndexKeysOnly

setShowDiskLocation

setSnapshot

setSort

setSort

setTailable

showDiskLoc

showDiskLoc

skip

snapshot