Class DBCollectionUpdateOptions

    • 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 Boolean getBypassDocumentValidation()
        Gets the the bypass document level validation flag
        Returns:
        the bypass document level validation flag
        Since server release
        3.2
      • bypassDocumentValidation

        public DBCollectionUpdateOptions 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
      • 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
        Since server release
        3.4
      • arrayFilters

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

        @Nullable
        public List<? extends DBObject> getArrayFilters()
        Returns the array filters option
        Returns:
        the array filters, which may be null
        Since:
        3.6
        Since server release
        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.
      • getEncoder

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