Class ReplaceRootOperation.ReplaceRootDocumentOperation

java.lang.Object

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

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

All Implemented Interfaces:

AggregationOperation, FieldsExposingAggregationOperation

Enclosing class:

ReplaceRootOperation

public static class ReplaceRootOperation.ReplaceRootDocumentOperation
extends ReplaceRootOperation

Encapsulates the aggregation framework $replaceRoot-operation to result in a composable replacement document.
Instances of ReplaceRootOperation.ReplaceRootDocumentOperation yield empty upon construction and can be populated with single values and documents.

Since:

1.10

Author:

Mark Paluch

Nested Class Summary

Nested classes/interfaces inherited from class ReplaceRootOperation

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

Nested classes/interfaces inherited from interface FieldsExposingAggregationOperation

FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

Constructor Summary

Constructors

Modifier	Constructor	Description
	ReplaceRootDocumentOperation()	Creates an empty ReplaceRootOperation.ReplaceRootDocumentOperation.
protected	ReplaceRootDocumentOperation(ReplaceRootOperation.ReplaceRootDocumentOperation currentOperation, org.springframework.data.mongodb.core.aggregation.ReplaceRootOperation.ReplacementDocument extension)	Creates an extended ReplaceRootOperation.ReplaceRootDocumentOperation that combines ReplaceRootOperation.ReplacementDocuments from the currentOperation and extension operation.

Method Summary

Modifier and Type	Method	Description
ReplaceRootOperation.ReplaceRootDocumentOperationBuilder	and(AggregationExpression aggregationExpression)	Creates a new ReplaceRootOperation.ReplaceRootDocumentOperationBuilder to define a field for the AggregationExpression.
ReplaceRootOperation.ReplaceRootDocumentOperationBuilder	andValue(Object value)	Creates a new ReplaceRootOperation.ReplaceRootDocumentOperationBuilder to define a field for the value.
ReplaceRootOperation.ReplaceRootDocumentOperation	andValuesOf(Object value)	Creates a new ReplaceRootOperation.ReplaceRootDocumentOperation that merges all existing replacement values with values from value.

Methods inherited from class ReplaceRootOperation

builder, getFields, getOperator, getReplacement, toDocument

Methods inherited from class Object

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

Methods inherited from interface AggregationOperation

toPipelineStages

Methods inherited from interface FieldsExposingAggregationOperation

inheritsFields

Constructor Details

ReplaceRootDocumentOperation

public ReplaceRootDocumentOperation()

Creates an empty ReplaceRootOperation.ReplaceRootDocumentOperation.

ReplaceRootDocumentOperation

protected ReplaceRootDocumentOperation(ReplaceRootOperation.ReplaceRootDocumentOperation currentOperation,
 org.springframework.data.mongodb.core.aggregation.ReplaceRootOperation.ReplacementDocument extension)

Creates an extended ReplaceRootOperation.ReplaceRootDocumentOperation that combines ReplaceRootOperation.ReplacementDocuments from the currentOperation and extension operation.

Parameters:

currentOperation - must not be null.

extension - must not be null.

Method Details

and

public ReplaceRootOperation.ReplaceRootDocumentOperationBuilder and(AggregationExpression aggregationExpression)

Creates a new ReplaceRootOperation.ReplaceRootDocumentOperationBuilder to define a field for the AggregationExpression.

Parameters:

aggregationExpression - must not be null.

Returns:

the ReplaceRootOperation.ReplaceRootDocumentOperationBuilder.

andValue

public ReplaceRootOperation.ReplaceRootDocumentOperationBuilder andValue(Object value)

Creates a new ReplaceRootOperation.ReplaceRootDocumentOperationBuilder to define a field for the value.

Parameters:

value - must not be null.

Returns:

the ReplaceRootOperation.ReplaceRootDocumentOperationBuilder.

andValuesOf

public ReplaceRootOperation.ReplaceRootDocumentOperation andValuesOf(Object value)

Creates a new ReplaceRootOperation.ReplaceRootDocumentOperation that merges all existing replacement values with values from value. Existing replacement values are overwritten.

Parameters:

value - must not be null.

Returns:

the ReplaceRootOperation.ReplaceRootDocumentOperation.