Module spring.data.mongodb

Package org.springframework.data.mongodb.core

Class FindAndModifyOptions

java.lang.Object

org.springframework.data.mongodb.core.FindAndModifyOptions

public class FindAndModifyOptions
extends Object

Author:

Mark Pollak, Oliver Gierke, Christoph Strobl

Constructor Summary

Constructors

Constructor	Description
FindAndModifyOptions()

Method Summary

Modifier and Type	Method	Description
FindAndModifyOptions	collation(Collation collation)	Define the Collation specifying language-specific rules for string comparison.
Optional<Collation>	getCollation()	Get the Collation specifying language-specific rules for string comparison.
boolean	isRemove()
boolean	isReturnNew()
boolean	isUpsert()
static FindAndModifyOptions	none()	Static factory method returning an unmodifiable FindAndModifyOptions instance.
static FindAndModifyOptions	of(FindAndModifyOptions source)	Create new FindAndModifyOptions based on option of given source.
static FindAndModifyOptions	options()	Static factory method to create a FindAndModifyOptions instance
FindAndModifyOptions	remove(boolean remove)
FindAndModifyOptions	returnNew(boolean returnNew)
FindAndModifyOptions	upsert(boolean upsert)

Methods inherited from class java.lang.Object

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

Constructor Details

FindAndModifyOptions

public FindAndModifyOptions()

Method Details

options

public static FindAndModifyOptions options()

Static factory method to create a FindAndModifyOptions instance

Returns:

new instance of FindAndModifyOptions.

none

public static FindAndModifyOptions none()

Static factory method returning an unmodifiable FindAndModifyOptions instance.

Returns:

unmodifiable FindAndModifyOptions instance.

Since:

2.2

of

public static FindAndModifyOptions of(@Nullable
 FindAndModifyOptions source)

Create new FindAndModifyOptions based on option of given source.

Parameters:

source - can be null.

Returns:

new instance of FindAndModifyOptions.

Since:

2.0

returnNew

public FindAndModifyOptions returnNew(boolean returnNew)

upsert

public FindAndModifyOptions upsert(boolean upsert)

remove

public FindAndModifyOptions remove(boolean remove)

collation

public FindAndModifyOptions collation(@Nullable
 Collation collation)

Define the Collation specifying language-specific rules for string comparison.

Parameters:

collation - can be null.

Returns:

this.

Since:

2.0

isReturnNew

public boolean isReturnNew()

isUpsert

public boolean isUpsert()

isRemove

public boolean isRemove()

getCollation

public Optional<Collation> getCollation()

Get the Collation specifying language-specific rules for string comparison.

Returns:

never null.

Since:

2.0