Package com.mongodb.client.model

Enum Class MergeOptions.WhenMatched

java.lang.Object

java.lang.Enum<MergeOptions.WhenMatched>

com.mongodb.client.model.MergeOptions.WhenMatched

All Implemented Interfaces:

Serializable, Comparable<MergeOptions.WhenMatched>, java.lang.constant.Constable

Enclosing class:

MergeOptions

public static enum MergeOptions.WhenMatched
extends Enum<MergeOptions.WhenMatched>

The behavior of $merge if a result document and an existing document in the collection have the same value for the specified on field(s).

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAIL	Stop and fail the aggregation operation.
KEEP_EXISTING	Keep the existing document in the output collection.
MERGE	Merge the matching documents
PIPELINE	An aggregation pipeline to update the document in the collection.
REPLACE	Replace the existing document in the output collection with the matching results document.

Method Summary

Modifier and Type	Method	Description
static MergeOptions.WhenMatched	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MergeOptions.WhenMatched[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REPLACE

public static final MergeOptions.WhenMatched REPLACE

Replace the existing document in the output collection with the matching results document.

KEEP_EXISTING

public static final MergeOptions.WhenMatched KEEP_EXISTING

Keep the existing document in the output collection.

MERGE

public static final MergeOptions.WhenMatched MERGE

Merge the matching documents

PIPELINE

public static final MergeOptions.WhenMatched PIPELINE

An aggregation pipeline to update the document in the collection.

See Also:

• MergeOptions.whenMatchedPipeline(List)

FAIL

public static final MergeOptions.WhenMatched FAIL

Stop and fail the aggregation operation. Any changes to the output collection from previous documents are not reverted.

Method Details

values

public static MergeOptions.WhenMatched[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MergeOptions.WhenMatched valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null