Package com.mongodb.client.model

Class FindOneAndReplaceOptions

java.lang.Object
com.mongodb.client.model.FindOneAndReplaceOptions
@Deprecated(since="2021-05-27") public class FindOneAndReplaceOptions extends Object
Deprecated.
Usage of this API is not supported in AEM as a Cloud Service.
The options to apply to an operation that atomically finds a document and replaces it.
Since:
3.0

  • Constructor Details

    • FindOneAndReplaceOptions

      public FindOneAndReplaceOptions()
      Deprecated.

  • Method Details

    • getProjection

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

    • projection

      public FindOneAndReplaceOptions projection(@Nullable Bson 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

    • getSort

      @Nullable public Bson 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 FindOneAndReplaceOptions sort(@Nullable Bson sort)
      Deprecated.
      Sets the sort criteria to apply to the query.
      Parameters:
      sort - the sort criteria, which may be null.
      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 FindOneAndReplaceOptions 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

    • getReturnDocument

      public ReturnDocument getReturnDocument()
      Deprecated.
      Gets the ReturnDocument value indicating whether to return the document before it was replaced or after
      Returns:
      ReturnDocument.BEFORE if returning the document before it was replaced otherwise return ReturnDocument.AFTER

    • returnDocument

      public FindOneAndReplaceOptions returnDocument(ReturnDocument returnDocument)
      Deprecated.
      Set whether to return the document before it was replaced or after
      Parameters:
      returnDocument - set whether to return the document before it was replaced or after
      Returns:
      this

    • maxTime

      public FindOneAndReplaceOptions 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

    • getMaxTime

      public long getMaxTime(TimeUnit timeUnit)
      Deprecated.
      Gets the maximum execution time for the find one and replace operation.
      Parameters:
      timeUnit - the time unit for the result
      Returns:
      the max time

    • getBypassDocumentValidation

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

    • bypassDocumentValidation

      public FindOneAndReplaceOptions bypassDocumentValidation(@Nullable 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

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

    • collation

      public FindOneAndReplaceOptions collation(@Nullable 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

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object