Package com.mongodb.operation

Class FindAndUpdateOperation<T>

java.lang.Object
com.mongodb.operation.BaseFindAndModifyOperation<T>
com.mongodb.operation.FindAndUpdateOperation<T>
Type Parameters:
T - the operations result type.
All Implemented Interfaces:
AsyncWriteOperation<T>, WriteOperation<T>
@Deprecated public class FindAndUpdateOperation<T> extends BaseFindAndModifyOperation<T>
Deprecated.
An operation that atomically finds and updates a single document.
Since:
3.0

  • Constructor Details

    • FindAndUpdateOperation

      @Deprecated public FindAndUpdateOperation(MongoNamespace namespace, Decoder<T> decoder, BsonDocument update)
      Deprecated.
      use FindAndUpdateOperation(MongoNamespace, WriteConcern, boolean, Decoder, BsonDocument) instead
      Construct a new instance.
      Parameters:
      namespace - the database and collection namespace for the operation.
      decoder - the decoder for the result documents.
      update - the document containing update operators.

    • FindAndUpdateOperation

      @Deprecated public FindAndUpdateOperation(MongoNamespace namespace, WriteConcern writeConcern, Decoder<T> decoder, BsonDocument update)
      Deprecated.
      use FindAndUpdateOperation(MongoNamespace, WriteConcern, boolean, Decoder, BsonDocument) instead
      Construct a new instance.
      Parameters:
      namespace - the database and collection namespace for the operation.
      writeConcern - the writeConcern for the operation
      decoder - the decoder for the result documents.
      update - the document containing update operators.
      Since:
      3.2

    • FindAndUpdateOperation

      public FindAndUpdateOperation(MongoNamespace namespace, WriteConcern writeConcern, boolean retryWrites, Decoder<T> decoder, BsonDocument update)
      Deprecated.
      Construct a new instance.
      Parameters:
      namespace - the database and collection namespace for the operation.
      writeConcern - the writeConcern for the operation
      retryWrites - if writes should be retried if they fail due to a network error.
      decoder - the decoder for the result documents.
      update - the document containing update operators.
      Since:
      3.6

    • FindAndUpdateOperation

      public FindAndUpdateOperation(MongoNamespace namespace, WriteConcern writeConcern, boolean retryWrites, Decoder<T> decoder, List<BsonDocument> update)
      Deprecated.
      Construct a new instance.
      Parameters:
      namespace - the database and collection namespace for the operation.
      writeConcern - the writeConcern for the operation
      retryWrites - if writes should be retried if they fail due to a network error.
      decoder - the decoder for the result documents.
      update - the pipeline containing update operators.
      Since:
      3.11

  • Method Details

    • getUpdate

      @Nullable public BsonDocument getUpdate()
      Deprecated.
      Gets the document containing update operators
      Returns:
      the update document

    • getUpdatePipeline

      @Nullable public List<BsonDocument> getUpdatePipeline()
      Deprecated.
      Gets the pipeline containing update operators
      Returns:
      the update pipeline
      Since:
      3.11

    • getFilter

      public BsonDocument getFilter()
      Deprecated.
      Gets the query filter.
      Returns:
      the query filter

    • filter

      public FindAndUpdateOperation<T> filter(BsonDocument filter)
      Deprecated.
      Sets the filter to apply to the query.
      Parameters:
      filter - the filter, which may be null.
      Returns:
      this

    • getProjection

      public BsonDocument getProjection()
      Deprecated.
      Gets a document describing the fields to return for all matching documents.
      Returns:
      the project document, which may be null

    • projection

      public FindAndUpdateOperation<T> projection(BsonDocument projection)
      Deprecated.
      Sets a document describing the fields to return for all matching documents.
      Parameters:
      projection - the project document, which may be null.
      Returns:
      this

    • getMaxTime

      public long getMaxTime(TimeUnit timeUnit)
      Deprecated.
      Gets the maximum execution time on the server for this operation. The default is 0, which places no limit on the execution time.
      Parameters:
      timeUnit - the time unit to return the result in
      Returns:
      the maximum execution time in the given time unit

    • maxTime

      public FindAndUpdateOperation<T> maxTime(long maxTime, TimeUnit timeUnit)
      Deprecated.
      Sets the maximum execution time on the server for this operation.
      Parameters:
      maxTime - the max time
      timeUnit - the time unit, which may not be null
      Returns:
      this

    • getSort

      public BsonDocument getSort()
      Deprecated.
      Gets the sort criteria to apply to the query. The default is null, which means that the documents will be returned in an undefined order.
      Returns:
      a document describing the sort criteria

    • sort

      public FindAndUpdateOperation<T> sort(BsonDocument sort)
      Deprecated.
      Sets the sort criteria to apply to the query.
      Parameters:
      sort - the sort criteria, which may be null.
      Returns:
      this

    • isReturnOriginal

      public boolean isReturnOriginal()
      Deprecated.
      When false, returns the updated document rather than the original. The default is false.
      Returns:
      true if the original document should be returned

    • returnOriginal

      public FindAndUpdateOperation<T> returnOriginal(boolean returnOriginal)
      Deprecated.
      Set to false if the updated document rather than the original should be returned.
      Parameters:
      returnOriginal - set to false if the updated document rather than the original should be returned
      Returns:
      this

    • isUpsert

      public boolean isUpsert()
      Deprecated.
      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 FindAndUpdateOperation<T> upsert(boolean upsert)
      Deprecated.
      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

      public Boolean getBypassDocumentValidation()
      Deprecated.
      Gets the bypass document level validation flag
      Returns:
      the bypass document level validation flag
      Since:
      3.2

    • bypassDocumentValidation

      public FindAndUpdateOperation<T> bypassDocumentValidation(Boolean bypassDocumentValidation)
      Deprecated.
      Sets the bypass document level validation flag.
      Parameters:
      bypassDocumentValidation - If true, allows the write to opt-out of document level validation.
      Returns:
      this
      Since:
      3.2

    • getCollation

      public Collation getCollation()
      Deprecated.
      Returns the collation options
      Returns:
      the collation options
      Since:
      3.4

    • collation

      public FindAndUpdateOperation<T> collation(Collation collation)
      Deprecated.
      Sets the collation options

      A null value represents the server default.

      Parameters:
      collation - the collation options to use
      Returns:
      this
      Since:
      3.4

    • arrayFilters

      public FindAndUpdateOperation<T> arrayFilters(List<BsonDocument> arrayFilters)
      Deprecated.
      Sets the array filters option
      Parameters:
      arrayFilters - the array filters, which may be null
      Returns:
      this
      Since:
      3.6

    • getArrayFilters

      public List<BsonDocument> getArrayFilters()
      Deprecated.
      Returns the array filters option
      Returns:
      the array filters, which may be null
      Since:
      3.6