Package com.mongodb.client.model

Class DBCollectionCountOptions

java.lang.Object
com.mongodb.client.model.DBCollectionCountOptions
public class DBCollectionCountOptions extends Object
The options for a count operation.
Since:
3.4
MongoDB documentation
Count

  • Constructor Details

    • DBCollectionCountOptions

      public DBCollectionCountOptions()
      Construct a new instance

  • Method Details

    • getHint

      @Nullable public com.mongodb.DBObject 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 DBCollectionCountOptions hint(@Nullable com.mongodb.DBObject hint)
      Sets the hint to apply.
      Parameters:
      hint - a document describing the index which should be used for this operation.
      Returns:
      this

    • hintString

      public DBCollectionCountOptions hintString(@Nullable String hint)
      Sets the hint to apply.
      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 DBCollectionCountOptions 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 DBCollectionCountOptions skip(int skip)
      Sets the number of documents to skip.
      Parameters:
      skip - the number of documents to skip
      Returns:
      this
      MongoDB documentation
      Skip

    • limit

      public DBCollectionCountOptions limit(long limit)
      Sets the limit to apply.
      Parameters:
      limit - the limit
      Returns:
      this
      MongoDB documentation
      Limit

    • skip

      public DBCollectionCountOptions skip(long 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 DBCollectionCountOptions 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

    • getReadPreference

      @Nullable public com.mongodb.ReadPreference getReadPreference()
      Returns the readPreference
      Returns:
      the readPreference

    • readPreference

      public DBCollectionCountOptions readPreference(@Nullable com.mongodb.ReadPreference readPreference)
      Sets the readPreference
      Parameters:
      readPreference - the readPreference
      Returns:
      this

    • getReadConcern

      @Nullable public com.mongodb.ReadConcern getReadConcern()
      Returns the readConcern
      Returns:
      the readConcern
      Since server release
      3.2

    • readConcern

      public DBCollectionCountOptions readConcern(@Nullable com.mongodb.ReadConcern readConcern)
      Sets the readConcern
      Parameters:
      readConcern - the readConcern
      Returns:
      this
      Since server release
      3.2

    • getCollation

      @Nullable public com.mongodb.client.model.Collation getCollation()
      Returns the collation options
      Returns:
      the collation options
      Since server release
      3.4

    • collation

      public DBCollectionCountOptions collation(@Nullable com.mongodb.client.model.Collation collation)
      Sets the collation
      Parameters:
      collation - the collation
      Returns:
      this
      Since server release
      3.4