Package dev.morphia

Class ModifyOptions

  • All Implemented Interfaces:
    dev.morphia.internal.SessionConfigurable<ModifyOptions>, dev.morphia.internal.WriteConfigurable<ModifyOptions>
    Direct Known Subclasses:
    FindAndModifyOptions
    public class ModifyOptions
extends com.mongodb.client.model.FindOneAndUpdateOptions
implements dev.morphia.internal.SessionConfigurable<ModifyOptions>, dev.morphia.internal.WriteConfigurable<ModifyOptions>
    Defines the options for a "find and modify" operation.
    Since:
    2.0

    • Constructor Detail

      • ModifyOptions

        public ModifyOptions()

    • Method Detail

      • clientSession

        public ModifyOptions clientSession​(com.mongodb.client.ClientSession clientSession)
        Description copied from interface: dev.morphia.internal.SessionConfigurable
        Set the client session to use for the insert.
        Specified by:
        clientSession in interface dev.morphia.internal.SessionConfigurable<ModifyOptions>
        Parameters:
        clientSession - the client session
        Returns:
        this

      • clientSession

        public com.mongodb.client.ClientSession clientSession()
        Description copied from interface: dev.morphia.internal.SessionConfigurable
        The client session to use for the insertion.
        Specified by:
        clientSession in interface dev.morphia.internal.SessionConfigurable<ModifyOptions>
        Returns:
        the client session

      • projection

        public ModifyOptions projection​(org.bson.conversions.Bson projection)
        Overrides:
        projection in class com.mongodb.client.model.FindOneAndUpdateOptions

      • sort

        public ModifyOptions sort​(org.bson.conversions.Bson sort)
        Overrides:
        sort in class com.mongodb.client.model.FindOneAndUpdateOptions

      • upsert

        public ModifyOptions upsert​(boolean upsert)
        Overrides:
        upsert in class com.mongodb.client.model.FindOneAndUpdateOptions

      • returnDocument

        public ModifyOptions returnDocument​(com.mongodb.client.model.ReturnDocument returnDocument)
        Overrides:
        returnDocument in class com.mongodb.client.model.FindOneAndUpdateOptions

      • maxTime

        public ModifyOptions maxTime​(long maxTime,
                             TimeUnit timeUnit)
        Overrides:
        maxTime in class com.mongodb.client.model.FindOneAndUpdateOptions

      • bypassDocumentValidation

        public ModifyOptions bypassDocumentValidation​(Boolean bypassDocumentValidation)
        Overrides:
        bypassDocumentValidation in class com.mongodb.client.model.FindOneAndUpdateOptions

      • collation

        public ModifyOptions collation​(com.mongodb.client.model.Collation collation)
        Overrides:
        collation in class com.mongodb.client.model.FindOneAndUpdateOptions

      • arrayFilters

        public ModifyOptions arrayFilters​(List<? extends org.bson.conversions.Bson> arrayFilters)
        Overrides:
        arrayFilters in class com.mongodb.client.model.FindOneAndUpdateOptions

      • writeConcern

        public ModifyOptions writeConcern​(com.mongodb.WriteConcern writeConcern)
        Description copied from interface: dev.morphia.internal.WriteConfigurable
        Set the write concern to use.
        Specified by:
        writeConcern in interface dev.morphia.internal.WriteConfigurable<ModifyOptions>
        Parameters:
        writeConcern - the write concern
        Returns:
        this

      • writeConcern

        public com.mongodb.WriteConcern writeConcern()
        Description copied from interface: dev.morphia.internal.WriteConfigurable
        The write concern to use. By default the write concern configured for the MongoCollection instance will be used.
        Specified by:
        writeConcern in interface dev.morphia.internal.WriteConfigurable<ModifyOptions>
        Returns:
        the write concern to use