Package com.mongodb.client.model

Class ReplaceOptions

java.lang.Object

com.mongodb.client.model.ReplaceOptions

public class ReplaceOptions
extends Object

The options to apply when replacing documents.

Since:

3.7

MongoDB documentation

Updates

Update Operators

Update Command

Constructor Summary

Constructors

Constructor	Description
ReplaceOptions()

Method Summary

Modifier and Type	Method	Description
ReplaceOptions	bypassDocumentValidation(Boolean bypassDocumentValidation)	Sets the bypass document level validation flag.
ReplaceOptions	collation(Collation collation)	Sets the collation options
Boolean	getBypassDocumentValidation()	Gets the the bypass document level validation flag
Collation	getCollation()	Returns the collation options
Bson	getHint()	Returns the hint for which index to use.
String	getHintString()	Gets the hint string to apply.
ReplaceOptions	hint(Bson hint)	Sets the hint for which index to use.
ReplaceOptions	hintString(String hint)	Sets the hint to apply.
boolean	isUpsert()	Returns true if a new document should be inserted if there are no matches to the query filter.
String	toString()
ReplaceOptions	upsert(boolean upsert)	Set to true if a new document should be inserted if there are no matches to the query filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplaceOptions

public ReplaceOptions()

Method Detail

isUpsert

public boolean isUpsert()

Returns true if a new document should be inserted if there are no matches to the query filter. The default is false.

Returns:

true if a new document should be inserted if there are no matches to the query filter

upsert

public ReplaceOptions upsert(boolean upsert)

Set to true if a new document should be inserted if there are no matches to the query filter.

Parameters:

upsert - true if a new document should be inserted if there are no matches to the query filter

Returns:

this

getBypassDocumentValidation

@Nullable
public Boolean getBypassDocumentValidation()

Gets the the bypass document level validation flag

Returns:

the bypass document level validation flag

Since server release

3.2

bypassDocumentValidation

public ReplaceOptions bypassDocumentValidation(@Nullable
                                               Boolean bypassDocumentValidation)

Sets the bypass document level validation flag.

Parameters:

bypassDocumentValidation - If true, allows the write to opt-out of document level validation.

Returns:

this

Since server release

3.2

getCollation

@Nullable
public Collation getCollation()

Returns the collation options

Returns:

the collation options

Since server release

3.4

collation

public ReplaceOptions collation(@Nullable
                                Collation collation)

Sets the collation options

A null value represents the server default.

Parameters:

collation - the collation options to use

Returns:

this

Since server release

3.4

getHint

@Nullable
public Bson getHint()

Returns the hint for which index to use. The default is not to set a hint.

Returns:

the hint

Since:

4.1

hint

public ReplaceOptions hint(@Nullable
                           Bson hint)

Sets the hint for which index to use. A null value means no hint is set.

Parameters:

hint - the hint

Returns:

this

Since:

4.1

getHintString

@Nullable
public String getHintString()

Gets the hint string to apply.

Returns:

the hint string, which should be the name of an existing index

Since:

4.1

hintString

public ReplaceOptions hintString(@Nullable
                                 String hint)

Sets the hint to apply.

Parameters:

hint - the name of the index which should be used for the operation

Returns:

this

Since:

4.1

toString

public String toString()

Overrides:

toString in class Object