Class DeleteOptions


  • public class DeleteOptions
    extends java.lang.Object
    The options to apply when deleting documents.
    Since:
    3.4
    MongoDB documentation
    Remove documents
    Delete Command
    • Constructor Detail

      • DeleteOptions

        public DeleteOptions()
    • Method Detail

      • getCollation

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

        public DeleteOptions 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 server release
        3.4
      • getHint

        @Nullable
        public org.bson.conversions.Bson getHint()
        Gets the hint to apply.
        Returns:
        the hint, which should describe an existing index
        Since:
        4.1
        Since server release
        4.4
      • 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
        Since:
        4.1
        Since server release
        4.4
      • hint

        public DeleteOptions hint​(@Nullable
                                  org.bson.conversions.Bson hint)
        Sets the hint to apply.
        Parameters:
        hint - a document describing the index which should be used for this operation.
        Returns:
        this
        Since:
        4.1
        Since server release
        4.4
      • hintString

        public DeleteOptions hintString​(@Nullable
                                        java.lang.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
        Since:
        4.1
        Since server release
        4.4
      • toString

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