org.springframework.data.mongodb.core.aggregation

Class ReplaceWithOperation

java.lang.Object

org.springframework.data.mongodb.core.aggregation.ReplaceRootOperation

org.springframework.data.mongodb.core.aggregation.ReplaceWithOperation

All Implemented Interfaces:

AggregationOperation, FieldsExposingAggregationOperation

public class ReplaceWithOperation
extends ReplaceRootOperation

Encapsulates the aggregation framework $replaceRoot-operation.
The operation replaces all existing fields including the id field with @{code $replaceWith}. This way it is possible to promote an embedded document to the top-level or specify a new document.

Since:

3.0

Author:

Christoph Strobl

See Also:

MongoDB Aggregation Framework: $replaceWith

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.data.mongodb.core.aggregation.ReplaceRootOperation

ReplaceRootOperation.Replacement, ReplaceRootOperation.ReplaceRootDocumentOperation, ReplaceRootOperation.ReplaceRootDocumentOperationBuilder, ReplaceRootOperation.ReplaceRootOperationBuilder

Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.aggregation.FieldsExposingAggregationOperation

FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

Constructor Summary

Constructors

Constructor and Description
ReplaceWithOperation(ReplaceRootOperation.Replacement replacement) Creates new instance of ReplaceWithOperation.

Method Summary

Modifier and Type	Method and Description
static ReplaceWithOperation	replaceWithValue(Object value) Creates new instance of ReplaceWithOperation.
static ReplaceWithOperation	replaceWithValueOf(Object value) Creates new instance of ReplaceWithOperation treating a given String value as a field reference.
org.bson.Document	toDocument(AggregationOperationContext context) Turns the AggregationOperation into a Document by using the given AggregationOperationContext.

Methods inherited from class org.springframework.data.mongodb.core.aggregation.ReplaceRootOperation

builder, getFields, getOperator, getReplacement

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.mongodb.core.aggregation.FieldsExposingAggregationOperation

inheritsFields

Methods inherited from interface org.springframework.data.mongodb.core.aggregation.AggregationOperation

toPipelineStages

Constructor Detail

ReplaceWithOperation

public ReplaceWithOperation(ReplaceRootOperation.Replacement replacement)

Creates new instance of ReplaceWithOperation.

Parameters:

replacement - must not be null.

Method Detail

replaceWithValue

public static ReplaceWithOperation replaceWithValue(Object value)

Creates new instance of ReplaceWithOperation.

Parameters:

value - must not be null.

Returns:

new instance of ReplaceWithOperation.

replaceWithValueOf

public static ReplaceWithOperation replaceWithValueOf(Object value)

Creates new instance of ReplaceWithOperation treating a given String value as a field reference.

Parameters:

value - must not be null.

Returns:

new instance of ReplaceWithOperation.

toDocument

public org.bson.Document toDocument(AggregationOperationContext context)

Description copied from interface: AggregationOperation

Turns the AggregationOperation into a Document by using the given AggregationOperationContext.

Specified by:

toDocument in interface AggregationOperation

Overrides:

toDocument in class ReplaceRootOperation

Parameters:

context - the AggregationOperationContext to operate within. Must not be null.

Returns:

the Document