Package com.mongodb.client.model

Class DBCollectionFindAndModifyOptions

java.lang.Object
com.mongodb.client.model.DBCollectionFindAndModifyOptions
public final class DBCollectionFindAndModifyOptions extends Object
The oprtions for find and modify operations.
Since:
3.4

  • Constructor Details

    • DBCollectionFindAndModifyOptions

      public DBCollectionFindAndModifyOptions()
      Construct a new instance

  • Method Details

    • getProjection

      @Nullable public com.mongodb.DBObject getProjection()
      Returns the projection
      Returns:
      the projection

    • projection

      public DBCollectionFindAndModifyOptions projection(@Nullable com.mongodb.DBObject projection)
      Sets the projection
      Parameters:
      projection - the projection
      Returns:
      this

    • getSort

      @Nullable public com.mongodb.DBObject getSort()
      Returns the sort
      Returns:
      the sort

    • sort

      public DBCollectionFindAndModifyOptions sort(@Nullable com.mongodb.DBObject sort)
      Sets the sort
      Parameters:
      sort - the sort
      Returns:
      this

    • isRemove

      public boolean isRemove()
      Returns the remove
      Returns:
      the remove

    • remove

      public DBCollectionFindAndModifyOptions remove(boolean remove)
      Sets the remove
      Parameters:
      remove - the remove
      Returns:
      this

    • getUpdate

      @Nullable public com.mongodb.DBObject getUpdate()
      Returns the update
      Returns:
      the update

    • update

      public DBCollectionFindAndModifyOptions update(@Nullable com.mongodb.DBObject update)
      Sets the update
      Parameters:
      update - the update
      Returns:
      this

    • isUpsert

      public boolean isUpsert()
      Returns the upsert
      Returns:
      the upsert

    • upsert

      public DBCollectionFindAndModifyOptions upsert(boolean upsert)
      Sets the upsert
      Parameters:
      upsert - the upsert
      Returns:
      this

    • returnNew

      public boolean returnNew()
      Returns the returnNew
      Returns:
      the returnNew

    • returnNew

      public DBCollectionFindAndModifyOptions returnNew(boolean returnNew)
      Sets the returnNew
      Parameters:
      returnNew - the returnNew
      Returns:
      this

    • getBypassDocumentValidation

      public Boolean getBypassDocumentValidation()
      Returns the bypassDocumentValidation
      Returns:
      the bypassDocumentValidation

    • bypassDocumentValidation

      public DBCollectionFindAndModifyOptions bypassDocumentValidation(Boolean bypassDocumentValidation)
      Sets the bypassDocumentValidation
      Parameters:
      bypassDocumentValidation - the bypassDocumentValidation
      Returns:
      this

    • getMaxTime

      public long getMaxTime(TimeUnit timeUnit)
      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
      MongoDB documentation
      Max Time

    • maxTime

      public DBCollectionFindAndModifyOptions maxTime(long maxTime, TimeUnit timeUnit)
      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
      MongoDB documentation
      Max Time

    • getWriteConcern

      @Nullable public com.mongodb.WriteConcern getWriteConcern()
      Returns the writeConcern
      Returns:
      the writeConcern
      Since server release
      3.2

    • writeConcern

      public DBCollectionFindAndModifyOptions writeConcern(@Nullable com.mongodb.WriteConcern writeConcern)
      Sets the writeConcern
      Parameters:
      writeConcern - the writeConcern
      Returns:
      this
      Since server release
      3.2

    • getCollation

      public com.mongodb.client.model.Collation getCollation()
      Returns the collation options
      Returns:
      the collation options
      Since server release
      3.4

    • collation

      public DBCollectionFindAndModifyOptions collation(com.mongodb.client.model.Collation collation)
      Sets the collation
      Parameters:
      collation - the collation
      Returns:
      this
      Since server release
      3.4

    • arrayFilters

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