Class FindAndReplaceOptions

java.lang.Object

org.springframework.data.mongodb.core.ReplaceOptions

org.springframework.data.mongodb.core.FindAndReplaceOptions

public class FindAndReplaceOptions
extends ReplaceOptions

Options for findOneAndReplace.
Defaults to

returnNew

false

upsert

false

Since:

2.1

Author:

Mark Paluch, Christoph Strobl

Constructor Summary

Constructors

Constructor	Description
FindAndReplaceOptions()

Method Summary

Modifier and Type	Method	Description
static FindAndReplaceOptions	empty()	Static factory method to create a FindAndReplaceOptions instance with returnNew false upsert false
boolean	isReturnNew()	Get the bit indicating to return the replacement document.
static FindAndReplaceOptions	none()	Static factory method returning an unmodifiable FindAndReplaceOptions instance.
static FindAndReplaceOptions	options()	Static factory method to create a FindAndReplaceOptions instance.
FindAndReplaceOptions	returnNew()	Return the replacement document.
FindAndReplaceOptions	upsert()	Insert a new document if not exists.

Methods inherited from class ReplaceOptions

isUpsert, replaceOptions

Methods inherited from class Object

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

Constructor Details

FindAndReplaceOptions

public FindAndReplaceOptions()

Method Details

options

public static FindAndReplaceOptions options()

Static factory method to create a FindAndReplaceOptions instance.

returnNew

false

upsert

false

Returns:

new instance of FindAndReplaceOptions.

none

public static FindAndReplaceOptions none()

Static factory method returning an unmodifiable FindAndReplaceOptions instance.

Returns:

unmodifiable FindAndReplaceOptions instance.

Since:

2.2

empty

public static FindAndReplaceOptions empty()

Static factory method to create a FindAndReplaceOptions instance with

returnNew

false

upsert

false

Returns:

new instance of FindAndReplaceOptions.

returnNew

@Contract("-> this")
public FindAndReplaceOptions returnNew()

Return the replacement document.

Returns:

this.

upsert

@Contract("-> this")
public FindAndReplaceOptions upsert()

Insert a new document if not exists.

Overrides:

upsert in class ReplaceOptions

Returns:

this.

isReturnNew

public boolean isReturnNew()

Get the bit indicating to return the replacement document.

Returns:

true if set.