com.mongodb.client.model

Enum MergeOptions.WhenMatched

java.lang.Object

java.lang.Enum<MergeOptions.WhenMatched>

com.mongodb.client.model.MergeOptions.WhenMatched

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MergeOptions.WhenMatched>

Enclosing class:

MergeOptions

public static enum MergeOptions.WhenMatched
extends java.lang.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).

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static MergeOptions.WhenMatched	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MergeOptions.WhenMatched[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

public static MergeOptions.WhenMatched[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MergeOptions.WhenMatched c : MergeOptions.WhenMatched.values())
    System.out.println(c);

Returns:

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

valueOf

public static MergeOptions.WhenMatched valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null