Package dev.morphia

Class ModifyOptions

java.lang.Object

com.mongodb.client.model.FindOneAndUpdateOptions

dev.morphia.ModifyOptions

All Implemented Interfaces:

dev.morphia.internal.CollectionConfigurable<ModifyOptions>, dev.morphia.internal.CollectionConfiguration, dev.morphia.internal.WriteConfigurable<ModifyOptions>

Direct Known Subclasses:

FindAndModifyOptions

public class ModifyOptions
extends FindOneAndUpdateOptions
implements dev.morphia.internal.WriteConfigurable<ModifyOptions>, dev.morphia.internal.CollectionConfigurable<ModifyOptions>

Defines the options for a "find and modify" operation.

Since:

2.0

Constructor Summary

Constructors

Constructor	Description
ModifyOptions()

Method Summary

Modifier and Type	Method	Description
ModifyOptions	arrayFilters(List<? extends Bson> arrayFilters)
ModifyOptions	bypassDocumentValidation(Boolean bypassDocumentValidation)
ModifyOptions	collation(Collation collation)
String	collection()	Returns the alternate collection to use for the operation.
ModifyOptions	collection(String collection)	Sets the alternate collection to use for the operation.
ModifyOptions	comment(String comment)
ModifyOptions	comment(BsonValue comment)
ModifyOptions	hint(Bson hint)
ModifyOptions	hint(Document hint)
ModifyOptions	hintString(String hint)
ModifyOptions	let(Bson variables)
ModifyOptions	maxTime(long maxTime, TimeUnit timeUnit)
ModifyOptions	projection(Bson projection)
ModifyOptions	returnDocument(ReturnDocument returnDocument)
ModifyOptions	sort(Bson sort)
ModifyOptions	upsert(boolean upsert)
WriteConcern	writeConcern()	The write concern to use.
ModifyOptions	writeConcern(WriteConcern writeConcern)	Set the write concern to use.

Methods inherited from class com.mongodb.client.model.FindOneAndUpdateOptions

getArrayFilters, getBypassDocumentValidation, getCollation, getComment, getHint, getHintString, getLet, getMaxTime, getProjection, getReturnDocument, getSort, isUpsert, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface dev.morphia.internal.CollectionConfigurable

prepare

Methods inherited from interface dev.morphia.internal.WriteConfigurable

configure, getWriteConcern

Constructor Detail

ModifyOptions

public ModifyOptions()

Method Detail

collection

public ModifyOptions collection(String collection)

Sets the alternate collection to use for the operation.

Specified by:

collection in interface dev.morphia.internal.CollectionConfigurable<ModifyOptions>

Parameters:

collection - the name of the collection to use

Returns:

this

collection

public String collection()

Returns the alternate collection to use for the operation. Might return null.

Specified by:

collection in interface dev.morphia.internal.CollectionConfigurable<ModifyOptions>

Returns:

the collection name or null

hint

public ModifyOptions hint(Document hint)

Parameters:

hint - the hint to apply

Returns:

this

Since:

2.2

See Also:

hint(Bson)

projection

public ModifyOptions projection(@Nullable
                                Bson projection)

Overrides:

projection in class FindOneAndUpdateOptions

sort

public ModifyOptions sort(@Nullable
                          Bson sort)

Overrides:

sort in class FindOneAndUpdateOptions

upsert

public ModifyOptions upsert(boolean upsert)

Overrides:

upsert in class FindOneAndUpdateOptions

returnDocument

public ModifyOptions returnDocument(ReturnDocument returnDocument)

Overrides:

returnDocument in class FindOneAndUpdateOptions

maxTime

public ModifyOptions maxTime(long maxTime,
                             TimeUnit timeUnit)

Overrides:

maxTime in class FindOneAndUpdateOptions

bypassDocumentValidation

public ModifyOptions bypassDocumentValidation(@Nullable
                                              Boolean bypassDocumentValidation)

Overrides:

bypassDocumentValidation in class FindOneAndUpdateOptions

collation

public ModifyOptions collation(@Nullable
                               Collation collation)

Overrides:

collation in class FindOneAndUpdateOptions

arrayFilters

public ModifyOptions arrayFilters(@Nullable
                                  List<? extends Bson> arrayFilters)

Overrides:

arrayFilters in class FindOneAndUpdateOptions

hint

public ModifyOptions hint(@Nullable
                          Bson hint)

Overrides:

hint in class FindOneAndUpdateOptions

Since:

2.2

See Also:

FindOneAndUpdateOptions.hint(Bson)

hintString

public ModifyOptions hintString(@Nullable
                                String hint)

Overrides:

hintString in class FindOneAndUpdateOptions

Returns:

this

Since:

2.2

See Also:

FindOneAndUpdateOptions.hintString(String)

comment

public ModifyOptions comment(String comment)

Overrides:

comment in class FindOneAndUpdateOptions

Returns:

this

Since:

2.3

comment

public ModifyOptions comment(BsonValue comment)

Overrides:

comment in class FindOneAndUpdateOptions

Returns:

this

Since:

2.3

let

public ModifyOptions let(Bson variables)

Overrides:

let in class FindOneAndUpdateOptions

Returns:

this

Since:

2.3

writeConcern

public ModifyOptions writeConcern(@Nullable
                                  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

@Nullable
public 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