Package com.mongodb.client.model

Class ReplaceOptions

  • public class ReplaceOptions
extends java.lang.Object
    The options to apply when replacing documents.
    Since:
    3.7

    • Constructor Detail

      • ReplaceOptions

        public ReplaceOptions()

    • Method Detail

      • createReplaceOptions

        @Deprecated
public static ReplaceOptions createReplaceOptions​(UpdateOptions updateOptions)
        Deprecated.
        there is no replacement for this method
        Creates replace options from updateOptions.
        Parameters:
        updateOptions - the updateOptions
        Returns:
        replace options

      • 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 java.lang.Boolean getBypassDocumentValidation()
        Gets the the bypass document level validation flag
        Returns:
        the bypass document level validation flag

      • bypassDocumentValidation

        public ReplaceOptions bypassDocumentValidation​(@Nullable
                                               java.lang.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

      • getCollation

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

      • 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

      • toString

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