Class ReplaceOptions

    • Constructor Detail

      • ReplaceOptions

        public ReplaceOptions()
    • Method Detail

      • isUpsert

        public boolean isUpsert()
        Returns true if a new document should be inserted if there are no matches to the query filter. The default is false.
        Returns:
        true if a new document should be inserted if there are no matches to the query filter
      • upsert

        public ReplaceOptions upsert​(boolean upsert)
        Set to true if a new document should be inserted if there are no matches to the query filter.
        Parameters:
        upsert - true if a new document should be inserted if there are no matches to the query filter
        Returns:
        this
      • getBypassDocumentValidation

        @Nullable
        public Boolean getBypassDocumentValidation()
        Gets the the bypass document level validation flag
        Returns:
        the bypass document level validation flag
        Since server release
        3.2
      • bypassDocumentValidation

        public ReplaceOptions bypassDocumentValidation​(@Nullable
                                                       Boolean bypassDocumentValidation)
        Sets the bypass document level validation flag.
        Parameters:
        bypassDocumentValidation - If true, allows the write to opt-out of document level validation.
        Returns:
        this
        Since server release
        3.2
      • getCollation

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

        public ReplaceOptions 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 Bson getHint()
        Returns the hint for which index to use. The default is not to set a hint.
        Returns:
        the hint
        Since:
        4.1
      • hint

        public ReplaceOptions hint​(@Nullable
                                   Bson hint)
        Sets the hint for which index to use. A null value means no hint is set.
        Parameters:
        hint - the hint
        Returns:
        this
        Since:
        4.1
      • getHintString

        @Nullable
        public String getHintString()
        Gets the hint string to apply.
        Returns:
        the hint string, which should be the name of an existing index
        Since:
        4.1
      • hintString

        public ReplaceOptions 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
        Since:
        4.1