Package com.mongodb.client.model

Class DBCollectionCountOptions

  • public class DBCollectionCountOptions
extends java.lang.Object
    The options for a count operation.
    Since:
    3.4

    • Constructor Detail

      • DBCollectionCountOptions

        public DBCollectionCountOptions()
        Construct a new instance

    • Method Detail

      • getHint

        @Nullable
public DBObject getHint()
        Gets the hint to apply.
        Returns:
        the hint, which should describe an existing

      • getHintString

        @Nullable
public java.lang.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
                                     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
                                           java.lang.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

      • limit

        public DBCollectionCountOptions limit​(int limit)
        Sets the limit to apply.
        Parameters:
        limit - the limit
        Returns:
        this

      • getSkip

        public int getSkip()
        Gets the number of documents to skip. The default is 0.
        Returns:
        the number of documents to skip

      • skip

        public DBCollectionCountOptions skip​(int skip)
        Sets the number of documents to skip.
        Parameters:
        skip - the number of documents to skip
        Returns:
        this

      • limit

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

      • skip

        public DBCollectionCountOptions skip​(long skip)
        Sets the number of documents to skip.
        Parameters:
        skip - the number of documents to skip
        Returns:
        this

      • getMaxTime

        public long getMaxTime​(java.util.concurrent.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,
                                        java.util.concurrent.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 ReadPreference getReadPreference()
        Returns the readPreference
        Returns:
        the readPreference

      • readPreference

        public DBCollectionCountOptions readPreference​(@Nullable
                                               ReadPreference readPreference)
        Sets the readPreference
        Parameters:
        readPreference - the readPreference
        Returns:
        this

      • getReadConcern

        @Nullable
public ReadConcern getReadConcern()
        Returns the readConcern
        Returns:
        the readConcern

      • readConcern

        public DBCollectionCountOptions readConcern​(@Nullable
                                            ReadConcern readConcern)
        Sets the readConcern
        Parameters:
        readConcern - the readConcern
        Returns:
        this

      • getCollation

        @Nullable
public Collation getCollation()
        Returns the collation options
        Returns:
        the collation options