Module spring.data.mongodb

Package org.springframework.data.mongodb.core.aggregation

Class VariableOperators.Let

java.lang.Object

org.springframework.data.mongodb.core.aggregation.VariableOperators.Let

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

VariableOperators

public static class VariableOperators.Let
extends Object
implements AggregationExpression

AggregationExpression for $let that binds AggregationExpression to variables for use in the specified in expression, and returns the result of the expression.

Since:

1.10

Author:

Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VariableOperators.Let.ExpressionVariable
static interface	VariableOperators.Let.LetBuilder

Method Summary

Modifier and Type	Method	Description
static VariableOperators.Let.LetBuilder	define(Collection<VariableOperators.Let.ExpressionVariable> variables)	Start creating new VariableOperators.Let by defining the variables for $vars.
static VariableOperators.Let.LetBuilder	define(VariableOperators.Let.ExpressionVariable... variables)	Start creating new VariableOperators.Let by defining the variables for $vars.
static VariableOperators.Let	just(VariableOperators.Let.ExpressionVariable... variables)	Create a new VariableOperators.Let holding just the given variables.
org.bson.Document	toDocument(AggregationOperationContext context)	Turns the AggregationExpression into a Document within the given AggregationOperationContext.

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.AggregationExpression

toDocument

Method Details

just

public static VariableOperators.Let just(VariableOperators.Let.ExpressionVariable... variables)

Create a new VariableOperators.Let holding just the given variables.

Parameters:

variables - must not be null.

Returns:

new instance of VariableOperators.Let.

Since:

4.1

define

public static VariableOperators.Let.LetBuilder define(Collection<VariableOperators.Let.ExpressionVariable> variables)

Start creating new VariableOperators.Let by defining the variables for $vars.

Parameters:

variables - must not be null.

Returns:

define

public static VariableOperators.Let.LetBuilder define(VariableOperators.Let.ExpressionVariable... variables)

Start creating new VariableOperators.Let by defining the variables for $vars.

Parameters:

variables - must not be null.

Returns:

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

Parameters:

context - must not be null.

Returns:

the MongoDB native (Document) form of the expression.