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

Class RedactOperation.RedactOperationBuilder

java.lang.Object

org.springframework.data.mongodb.core.aggregation.RedactOperation.RedactOperationBuilder

Enclosing class:

RedactOperation

public static class RedactOperation.RedactOperationBuilder
extends Object

Builder to create new instance of RedactOperation.

Author:

Christoph Strobl

Method Summary

Modifier and Type	Method	Description
RedactOperation	build()
RedactOperation.RedactOperationBuilder	otherwise(Object otherwise)	Define the outcome (anything that resolves to $$DESCEND, $$PRUNE, or $$KEEP) when the condition is not met.
RedactOperation.RedactOperationBuilder	otherwiseDescend()	Return fields at the current document level and exclude embedded ones if the condition is not met.
RedactOperation.RedactOperationBuilder	otherwiseKeep()	Return/Keep all fields at the current document/embedded level if the condition is not met.
RedactOperation.RedactOperationBuilder	otherwisePrune()	Exclude all fields at this current document/embedded level if the condition is not met.
RedactOperation.RedactOperationBuilder	then(Object then)	Define the outcome (anything that resolves to $$DESCEND, $$PRUNE, or $$KEEP) when the condition is met.
RedactOperation.RedactOperationBuilder	thenDescend()	Return fields at the current document level and exclude embedded ones if the condition is met.
RedactOperation.RedactOperationBuilder	thenKeep()	Return/Keep all fields at the current document/embedded level if the condition is met.
RedactOperation.RedactOperationBuilder	thenPrune()	Exclude all fields at this current document/embedded level if the condition is met.
RedactOperation.RedactOperationBuilder	when(org.bson.Document condition)	Specify the evaluation condition.
RedactOperation.RedactOperationBuilder	when(AggregationExpression condition)	Specify the evaluation condition.
RedactOperation.RedactOperationBuilder	when(CriteriaDefinition criteria)	Specify the evaluation condition.

Methods inherited from class java.lang.Object

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

Method Details

when

public RedactOperation.RedactOperationBuilder when(CriteriaDefinition criteria)

Specify the evaluation condition.

Parameters:

criteria - must not be null.

Returns:

this.

when

public RedactOperation.RedactOperationBuilder when(AggregationExpression condition)

Specify the evaluation condition.

Parameters:

condition - must not be null.

Returns:

this.

when

public RedactOperation.RedactOperationBuilder when(org.bson.Document condition)

Specify the evaluation condition.

Parameters:

condition - must not be null.

Returns:

this.

thenDescend

public RedactOperation.RedactOperationBuilder thenDescend()

Return fields at the current document level and exclude embedded ones if the condition is met.

Returns:

this.

thenKeep

public RedactOperation.RedactOperationBuilder thenKeep()

Return/Keep all fields at the current document/embedded level if the condition is met.

Returns:

this.

thenPrune

public RedactOperation.RedactOperationBuilder thenPrune()

Exclude all fields at this current document/embedded level if the condition is met.

Returns:

this.

then

public RedactOperation.RedactOperationBuilder then(Object then)

Define the outcome (anything that resolves to $$DESCEND, $$PRUNE, or $$KEEP) when the condition is met.

Parameters:

then - must not be null.

Returns:

this.

otherwiseDescend

public RedactOperation.RedactOperationBuilder otherwiseDescend()

Return fields at the current document level and exclude embedded ones if the condition is not met.

Returns:

this.

otherwiseKeep

public RedactOperation.RedactOperationBuilder otherwiseKeep()

Return/Keep all fields at the current document/embedded level if the condition is not met.

Returns:

this.

otherwisePrune

public RedactOperation.RedactOperationBuilder otherwisePrune()

Exclude all fields at this current document/embedded level if the condition is not met.

Returns:

this.

otherwise

public RedactOperation.RedactOperationBuilder otherwise(Object otherwise)

Define the outcome (anything that resolves to $$DESCEND, $$PRUNE, or $$KEEP) when the condition is not met.

Parameters:

otherwise - must not be null.

Returns:

this.

build

public RedactOperation build()

Returns:

new instance of RedactOperation.