com.allanbank.mongodb.builder

Class Count

java.lang.Object

com.allanbank.mongodb.builder.Count

public class Count
extends Object

Count provides an immutable container for all of the options for a query to count documents.

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	Count.Builder Helper for creating immutable Count queries.

Field Summary

Fields

Modifier and Type	Field and Description
static Document	ALL An (empty) query document to find all documents.
static Version	MAX_TIMEOUT_VERSION The first version of MongoDB to support the count command with the ability to limit the execution time on the server.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Count(Count.Builder builder) Creates a new Count.

Method Summary

Methods

Modifier and Type	Method and Description
static Count.Builder	builder() Creates a new builder for a Count.
long	getMaximumTimeMilliseconds() Returns the maximum amount of time to allow the query to run on the Server before it is aborted.
Document	getQuery() Returns the query document.
ReadPreference	getReadPreference() Returns the preference for the servers to retrieve the results from.

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.

MAX_TIMEOUT_VERSION

public static final Version MAX_TIMEOUT_VERSION

The first version of MongoDB to support the count command with the ability to limit the execution time on the server.

Constructor Detail

Count

protected Count(Count.Builder builder)

Creates a new Count.

Parameters:

builder - The builder to copy the query fields from.

Method Detail

builder

public static Count.Builder builder()

Creates a new builder for a Count.

Returns:

The builder to construct a Count.

getMaximumTimeMilliseconds

public long getMaximumTimeMilliseconds()

Returns the maximum amount of time to allow the query to run on the Server before it is aborted.

Returns:

The maximum amount of time to allow the query to run on the Server before it is aborted.

Since:

MongoDB 2.6

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.