com.allanbank.mongodb.builder.expression

Class LetBuilder

java.lang.Object

com.allanbank.mongodb.builder.expression.LetBuilder

public class LetBuilder
extends Object

LetBuilder provides a builder for a $let expression.

API Notice:

This class is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2014, Allanbank Consulting, Inc., All Rights Reserved

Method Summary

Methods

Modifier and Type	Method and Description
UnaryExpression	in(Expression letExpression) Creates the final $let expression to evaluate.
LetBuilder	let(String name, DocumentAssignable document) Adds a variable to the $let expression.
LetBuilder	let(String name, Expression expression) Adds a variable to the $let expression.

Methods inherited from class java.lang.Object

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

Method Detail

in

public UnaryExpression in(Expression letExpression)

Creates the final $let expression to evaluate.

Parameters:

letExpression - The expression to be evaluated with the variables within the $let expression.

Returns:

The UnaryExpression for the $let.

let

public LetBuilder let(String name,
             DocumentAssignable document)

Adds a variable to the $let expression.

Parameters:

name - The name of the variable to set.

document - The document to set the variable to.

Returns:

This builder for method call chaining.

let

public LetBuilder let(String name,
             Expression expression)

Adds a variable to the $let expression.

Parameters:

name - The name of the variable to set.

expression - The expression to compute the value for the variable.

Returns:

This builder for method call chaining.