Package dev.morphia.query

Class FindAndDeleteOptions

java.lang.Object

com.mongodb.client.model.FindOneAndDeleteOptions

dev.morphia.query.FindAndDeleteOptions

All Implemented Interfaces:

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

public class FindAndDeleteOptions
extends FindOneAndDeleteOptions
implements dev.morphia.internal.WriteConfigurable<FindAndDeleteOptions>, dev.morphia.internal.CollectionConfigurable<FindAndDeleteOptions>

Defines options to use for find and delete operations

Constructor Summary

Constructors

Constructor	Description
FindAndDeleteOptions()

Method Summary

Modifier and Type	Method	Description
FindAndDeleteOptions	collation(Collation collation)
String	collection()	Returns the alternate collection to use for the operation.
FindAndDeleteOptions	collection(String collection)	Sets the alternate collection to use for the operation.
FindAndDeleteOptions	comment(String comment)
FindAndDeleteOptions	comment(BsonValue comment)
FindAndDeleteOptions	hint(Bson hint)
FindAndDeleteOptions	hint(Document hint)
FindAndDeleteOptions	hintString(String hint)
FindAndDeleteOptions	let(Bson variables)
FindAndDeleteOptions	maxTime(long maxTime, TimeUnit timeUnit)
FindAndDeleteOptions	projection(Bson projection)
FindAndDeleteOptions	sort(Bson sort)
FindAndDeleteOptions	sort(Document sort)
WriteConcern	writeConcern()	The write concern to use.
FindAndDeleteOptions	writeConcern(WriteConcern writeConcern)	Sets the write concern

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

getCollation, getComment, getHint, getHintString, getLet, getMaxTime, getProjection, getSort, 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

FindAndDeleteOptions

public FindAndDeleteOptions()

Method Detail

collection

public FindAndDeleteOptions collection(String collection)

Description copied from interface: dev.morphia.internal.CollectionConfigurable

Sets the alternate collection to use for the operation.

Specified by:

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

Parameters:

collection - the name of the collection to use

Returns:

this

collection

public String collection()

Description copied from interface: dev.morphia.internal.CollectionConfigurable

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

Specified by:

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

Returns:

the collection name or null

comment

public FindAndDeleteOptions comment(String comment)

Overrides:

comment in class FindOneAndDeleteOptions

Returns:

this

Since:

2.3

comment

public FindAndDeleteOptions comment(BsonValue comment)

Overrides:

comment in class FindOneAndDeleteOptions

Returns:

this

Since:

2.3

hint

public FindAndDeleteOptions hint(Document hint)

Parameters:

hint - the hint to apply

Returns:

this

Since:

2.2

See Also:

hint(Bson)

projection

public FindAndDeleteOptions projection(@Nullable
                                       Bson projection)

Overrides:

projection in class FindOneAndDeleteOptions

sort

public FindAndDeleteOptions sort(@Nullable
                                 Bson sort)

Overrides:

sort in class FindOneAndDeleteOptions

maxTime

public FindAndDeleteOptions maxTime(long maxTime,
                                    TimeUnit timeUnit)

Overrides:

maxTime in class FindOneAndDeleteOptions

collation

public FindAndDeleteOptions collation(@Nullable
                                      Collation collation)

Overrides:

collation in class FindOneAndDeleteOptions

hint

public FindAndDeleteOptions hint(@Nullable
                                 Bson hint)

Overrides:

hint in class FindOneAndDeleteOptions

Returns:

this

Since:

2.2

hintString

public FindAndDeleteOptions hintString(@Nullable
                                       String hint)

Overrides:

hintString in class FindOneAndDeleteOptions

Returns:

this

Since:

2.2

let

public FindAndDeleteOptions let(Bson variables)

Overrides:

let in class FindOneAndDeleteOptions

Returns:

this

Since:

2.3

sort

public FindAndDeleteOptions sort(Document sort)

Parameters:

sort - the sort to apply

Returns:

this

writeConcern

public FindAndDeleteOptions writeConcern(@Nullable
                                         WriteConcern writeConcern)

Sets the write concern

Specified by:

writeConcern in interface dev.morphia.internal.WriteConfigurable<FindAndDeleteOptions>

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<FindAndDeleteOptions>

Returns:

the write concern to use