org.springframework.data.mongodb.core.aggregation

Class ConditionalOperators.IfNull

java.lang.Object

org.springframework.data.mongodb.core.aggregation.ConditionalOperators.IfNull

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

ConditionalOperators

public static class ConditionalOperators.IfNull
extends Object
implements AggregationExpression

Encapsulates the aggregation framework $ifNull operator. Replacement values can be either field references, expressions, values of simple MongoDB types or values that can be converted to a simple MongoDB type.

Author:

Mark Paluch

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ConditionalOperators.IfNull.IfNullBuilder
static interface	ConditionalOperators.IfNull.OrBuilder
static interface	ConditionalOperators.IfNull.ThenBuilder

Method Summary

Modifier and Type	Method and Description
static ConditionalOperators.IfNull.ThenBuilder	ifNull(AggregationExpression expression) Creates new ConditionalOperators.IfNull.
static ConditionalOperators.IfNull.ThenBuilder	ifNull(String fieldReference) Creates new ConditionalOperators.IfNull.
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

from, toDocument

Methods inherited from interface org.springframework.data.mongodb.MongoExpression

create, create

Method Detail

ifNull

public static ConditionalOperators.IfNull.ThenBuilder ifNull(String fieldReference)

Creates new ConditionalOperators.IfNull.

Parameters:

fieldReference - the field to check for a null value, field reference must not be null.

Returns:

never null.

ifNull

public static ConditionalOperators.IfNull.ThenBuilder ifNull(AggregationExpression expression)

Creates new ConditionalOperators.IfNull.

Parameters:

expression - the expression to check for a null value, field reference must not be null.

Returns:

never null.

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.