ObjectOperators.MergeObjects (Spring Data MongoDB 2.1.0.RELEASE API)

java.lang.Object
- org.springframework.data.mongodb.core.aggregation.ObjectOperators.MergeObjects

All Implemented Interfaces:

AggregationExpression

Enclosing class:

ObjectOperators
```
public static class ObjectOperators.MergeObjects
extends Object
```
AggregationExpression for $mergeObjects that combines multiple documents into a single document.
NOTE: Requires MongoDB 4.0 or later.

Since:

2.1

Author:

Christoph Strobl

See Also:

https://docs.mongodb.com/manual/reference/operator/aggregation/mergeObjects/

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected List<Object>`	`append(Object value)`
`protected Map<String,Object>`	`append(String key, Object value)`
`protected Map<String,Object>`	`argumentMap()` Get the argument map.
`protected static List<Field>`	`asFields(String... fieldRefs)`
`protected boolean`	`contains(Object key)` Check if the given key is available.
`protected <T> T`	`get(int index)` Get the value at a given index.
`protected <T> T`	`get(Object key)` Get the value for a given key.
`protected String`	`getMongoMethod()`
`static ObjectOperators.MergeObjects`	`merge(Object... values)` Creates new `aggregation expression` that takes given values and combines them into a single document.
`static ObjectOperators.MergeObjects`	`mergeValuesOf(AggregationExpression... expressions)` Creates new `aggregation expression` that takes the result of the given `expressions` and combines them into a single document.
`static ObjectOperators.MergeObjects`	`mergeValuesOf(String... fieldReferences)` Creates new `aggregation expression` that takes the given `field references` and combines them into a single document.
`ObjectOperators.MergeObjects`	`mergeWith(Object... values)` Creates new `aggregation expression` by adding the given values (documents or mapped objects).
`ObjectOperators.MergeObjects`	`mergeWithValuesOf(AggregationExpression... expression)` Creates new `aggregation expression` by adding the given `expressions`.
`ObjectOperators.MergeObjects`	`mergeWithValuesOf(String... fieldReferences)` Creates new `aggregation expression` by adding the given `field references`.
`org.bson.Document`	`toDocument(AggregationOperationContext context)` Turns the `AggregationExpression` into a `Document` within the given `AggregationOperationContext`.
`org.bson.Document`	`toDocument(Object value, AggregationOperationContext context)`
`protected List<Object>`	`values()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - merge
```
public static ObjectOperators.MergeObjects merge(Object... values)
```
    Creates new aggregation expression that takes given values and combines them into a single document.
    
    Parameters:
    
    values - must not be null.
    
    Returns:
    
    new instance of ObjectOperators.MergeObjects.
  - mergeValuesOf
```
public static ObjectOperators.MergeObjects mergeValuesOf(String... fieldReferences)
```
    Creates new aggregation expression that takes the given field references and combines them into a single document.
    
    Parameters:
    
    fieldReferences - must not be null.
    
    Returns:
    
    new instance of ObjectOperators.MergeObjects.
  - mergeValuesOf
```
public static ObjectOperators.MergeObjects mergeValuesOf(AggregationExpression... expressions)
```
    Creates new aggregation expression that takes the result of the given expressions and combines them into a single document.
    
    Parameters:
    
    expressions - must not be null.
    
    Returns:
    
    new instance of ObjectOperators.MergeObjects.
  - mergeWithValuesOf
```
public ObjectOperators.MergeObjects mergeWithValuesOf(String... fieldReferences)
```
    Creates new aggregation expression by adding the given field references.
    
    Parameters:
    
    fieldReferences - must not be null.
    
    Returns:
    
    new instance of ObjectOperators.MergeObjects.
  - mergeWithValuesOf
```
public ObjectOperators.MergeObjects mergeWithValuesOf(AggregationExpression... expression)
```
    Creates new aggregation expression by adding the given expressions.
    
    Parameters:
    
    expression - must not be null.
    
    Returns:
    
    new instance of ObjectOperators.MergeObjects.
  - mergeWith
```
public ObjectOperators.MergeObjects mergeWith(Object... values)
```
    Creates new aggregation expression by adding the given values (documents or mapped objects).
    
    Parameters:
    
    values - must not be null.
    
    Returns:
    
    new instance of ObjectOperators.MergeObjects.
  - toDocument
```
public org.bson.Document toDocument(Object value,
                                    AggregationOperationContext context)
```
  - getMongoMethod
```
protected String getMongoMethod()
```
  - toDocument
```
public org.bson.Document toDocument(AggregationOperationContext context)
```
    Description copied from interface: AggregationExpression
    
    Turns the AggregationExpression into a Document within the given AggregationOperationContext.
    
    Specified by:
    
    toDocument in interface AggregationExpression
    
    Returns:
  - asFields
```
protected static List<Field> asFields(String... fieldRefs)
```
  - append
```
protected List<Object> append(Object value)
```
  - append
```
protected Map<String,Object> append(String key,
                                    Object value)
```
  - values
```
protected List<Object> values()
```
  - get
```
protected <T> T get(int index)
```
    Get the value at a given index.
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    index -
    
    Returns:
    
    Since:
    
    2.1
  - get
```
protected <T> T get(Object key)
```
    Get the value for a given key.
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    key -
    
    Returns:
    
    Since:
    
    2.1
  - argumentMap
```
protected Map<String,Object> argumentMap()
```
    Get the argument map.
    
    Returns:
    
    Since:
    
    2.1
  - contains
```
protected boolean contains(Object key)
```
    Check if the given key is available.
    
    Parameters:
    
    key -
    
    Returns:
    
    Since:
    
    2.1

Class ObjectOperators.MergeObjects

Method Summary

Methods inherited from class java.lang.Object

Method Detail

merge

mergeValuesOf

mergeValuesOf

mergeWithValuesOf

mergeWithValuesOf

mergeWith

toDocument

getMongoMethod

toDocument

asFields

append

append

values

get

get

argumentMap

contains