Package com.mongodb.client.model

Class CountOptions

java.lang.Object

com.mongodb.client.model.CountOptions

public class CountOptions
extends Object

The options for a count operation.

Since:

3.0

MongoDB documentation

Count

Constructor Summary

Constructors

Constructor	Description
CountOptions()

Method Summary

Modifier and Type	Method	Description
CountOptions	collation(Collation collation)	Sets the collation options
Collation	getCollation()	Returns the collation options
Bson	getHint()	Gets the hint to apply.
String	getHintString()	Gets the hint string to apply.
int	getLimit()	Gets the limit to apply.
long	getMaxTime(TimeUnit timeUnit)	Gets the maximum execution time on the server for this operation.
int	getSkip()	Gets the number of documents to skip.
CountOptions	hint(Bson hint)	Sets the hint to apply.
CountOptions	hintString(String hint)	Sets the hint to apply.
CountOptions	limit(int limit)	Sets the limit to apply.
CountOptions	maxTime(long maxTime, TimeUnit timeUnit)	Sets the maximum execution time on the server for this operation.
CountOptions	skip(int skip)	Sets the number of documents to skip.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CountOptions

public CountOptions()

Method Detail

getHint

@Nullable
public Bson getHint()

Gets the hint to apply.

Returns:

the hint, which should describe an existing

getHintString

@Nullable
public String getHintString()

Gets the hint string to apply.

Returns:

the hint string, which should be the name of an existing index

hint

public CountOptions hint(@Nullable
                         Bson hint)

Sets the hint to apply.

Parameters:

hint - a document describing the index which should be used for this operation.

Returns:

this

hintString

public CountOptions hintString(@Nullable
                               String hint)

Sets the hint to apply.

Note: If hint(Bson) is set that will be used instead of any hint string.

Parameters:

hint - the name of the index which should be used for the operation

Returns:

this

getLimit

public int getLimit()

Gets the limit to apply. The default is 0, which means there is no limit.

Returns:

the limit

MongoDB documentation

Limit

limit

public CountOptions limit(int limit)

Sets the limit to apply.

Parameters:

limit - the limit

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

MongoDB documentation

Skip

skip

public CountOptions 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

maxTime

public CountOptions 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

getCollation

@Nullable
public Collation getCollation()

Returns the collation options

Returns:

the collation options

Since:

3.4

Since server release

3.4

collation

public CountOptions collation(@Nullable
                              Collation collation)

Sets the collation options

A null value represents the server default.

Parameters:

collation - the collation options to use

Returns:

this

Since:

3.4

Since server release

3.4

toString

public String toString()

Overrides:

toString in class Object