Package com.mongodb.client.model

Class DBCollectionUpdateOptions

  • public class DBCollectionUpdateOptions
extends java.lang.Object
    The options to apply when updating documents in the DBCollection
    Since:
    3.4

    • Constructor Detail

      • DBCollectionUpdateOptions

        public DBCollectionUpdateOptions()
        Construct a new instance

    • 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 DBCollectionUpdateOptions upsert​(boolean isUpsert)
        Set to true if a new document should be inserted if there are no matches to the query filter.
        Parameters:
        isUpsert - 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 DBCollectionUpdateOptions 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

      • multi

        public DBCollectionUpdateOptions multi​(boolean multi)
        Sets whether all documents matching the query filter will be removed.
        Parameters:
        multi - true if all documents matching the query filter will be removed
        Returns:
        this

      • isMulti

        public boolean isMulti()
        Gets whether all documents matching the query filter will be removed. The default is true.
        Returns:
        whether all documents matching the query filter will be removed

      • getCollation

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

      • arrayFilters

        public DBCollectionUpdateOptions arrayFilters​(@Nullable
                                              java.util.List<? extends DBObject> arrayFilters)
        Sets the array filters option
        Parameters:
        arrayFilters - the array filters, which may be null
        Returns:
        this
        Since:
        3.6

      • getArrayFilters

        @Nullable
public java.util.List<? extends DBObject> getArrayFilters()
        Returns the array filters option
        Returns:
        the array filters, which may be null
        Since:
        3.6

      • getWriteConcern

        @Nullable
public WriteConcern getWriteConcern()
        The write concern to use for the insertion. By default the write concern configured for the DBCollection instance will be used.
        Returns:
        the write concern, or null if the default will be used.

      • writeConcern

        public DBCollectionUpdateOptions writeConcern​(@Nullable
                                              WriteConcern writeConcern)
        Sets the write concern
        Parameters:
        writeConcern - the write concern
        Returns:
        this

      • getEncoder

        @Nullable
public DBEncoder getEncoder()
        Returns the encoder
        Returns:
        the encoder