com.allanbank.mongodb.builder

Class Count.Builder

java.lang.Object

com.allanbank.mongodb.builder.Count.Builder

Enclosing class:

Count

public static class Count.Builder
extends Object

Helper for creating immutable Count 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 long	myMaximumTimeMilliseconds The maximum amount of time to allow the query to run.
protected Document	myQuery The query document.
protected ReadPreference	myReadPreference The preference for which servers to use to retrieve the results.

Constructor Summary

Constructors

Constructor and Description
Count.Builder() Creates a new Builder.
Count.Builder(DocumentAssignable query) Creates a new Builder.

Method Summary

Methods

Modifier and Type	Method and Description
Count	build() Constructs a new Count object from the state of the builder.
Count.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.
Count.Builder	query(DocumentAssignable query) Sets the value of the query document to the new value.
Count.Builder	readPreference(ReadPreference readPreference) Sets the preference for the set of servers to retrieve the results from.
Count.Builder	reset() Resets the builder back to its initial state for reuse.
Count.Builder	setMaximumTimeMilliseconds(long maximumTimeMilliseconds) Sets the maximum number of milliseconds to allow the query to run before aborting the request on the server.
Count.Builder	setQuery(DocumentAssignable query) Sets the value of the query document to the new value.
Count.Builder	setReadPreference(ReadPreference readPreference) Sets the preference for the set of 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

myMaximumTimeMilliseconds

protected long myMaximumTimeMilliseconds

The maximum amount of time to allow the query to run.

myQuery

protected Document myQuery

The query document.

myReadPreference

protected ReadPreference myReadPreference

The preference for which servers to use to retrieve the results.

Constructor Detail

Count.Builder

public Count.Builder()

Creates a new Builder.

Count.Builder

public Count.Builder(DocumentAssignable query)

Creates a new Builder.

Parameters:

query - The query document.

Method Detail

build

public Count build()

Constructs a new Count object from the state of the builder.

Returns:

The new Count object.

maximumTime

public Count.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 Count.Builder for method call chaining.

Since:

MongoDB 2.6

query

public Count.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 Count.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 Count.Builder reset()

Resets the builder back to its initial state for reuse.

Returns:

This builder for chaining method calls.

setMaximumTimeMilliseconds

public Count.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 Count.Builder for method call chaining.

Since:

MongoDB 2.6

setQuery

public Count.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 Count.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.