Package com.mongodb.client.model

Class FindOneAndDeleteOptions

  • public class FindOneAndDeleteOptions
extends java.lang.Object
    The options to apply to an operation that atomically finds a document and deletes it.
    Since:
    3.0

    • Constructor Detail

      • FindOneAndDeleteOptions

        public FindOneAndDeleteOptions()

    • Method Detail

      • getProjection

        @Nullable
public Bson getProjection()
        Gets a document describing the fields to return for all matching documents.
        Returns:
        the project document, which may be null

      • projection

        public FindOneAndDeleteOptions projection​(@Nullable
                                          Bson projection)
        Sets a document describing the fields to return for all matching documents.
        Parameters:
        projection - the project document, which may be null.
        Returns:
        this

      • getSort

        @Nullable
public Bson getSort()
        Gets the sort criteria to apply to the query. The default is null, which means that the documents will be returned in an undefined order.
        Returns:
        a document describing the sort criteria

      • sort

        public FindOneAndDeleteOptions sort​(@Nullable
                                    Bson sort)
        Sets the sort criteria to apply to the query.
        Parameters:
        sort - the sort criteria, which may be null.
        Returns:
        this

      • maxTime

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

      • getMaxTime

        public long getMaxTime​(java.util.concurrent.TimeUnit timeUnit)
        Gets the maximum execution time for the find one and delete operation.
        Parameters:
        timeUnit - the time unit for the result
        Returns:
        the max time

      • getCollation

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

      • collation

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

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object