org.springframework.data.mongodb.core.aggregation

Class AggregationOptions.Builder

java.lang.Object

org.springframework.data.mongodb.core.aggregation.AggregationOptions.Builder

Enclosing class:

AggregationOptions

public static class AggregationOptions.Builder
extends Object

A Builder for AggregationOptions.

Author:

Thomas Darimont

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AggregationOptions.Builder	allowDiskUse(boolean allowDiskUse) Defines whether to off-load intensive sort-operations to disk.
AggregationOptions	build() Returns a new AggregationOptions instance with the given configuration.
AggregationOptions.Builder	cursor(com.mongodb.DBObject cursor) Additional options to the aggregation.
AggregationOptions.Builder	explain(boolean explain) Defines whether to get the execution plan for the aggregation instead of the actual results.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

allowDiskUse

public AggregationOptions.Builder allowDiskUse(boolean allowDiskUse)

Defines whether to off-load intensive sort-operations to disk.

Parameters:

allowDiskUse -

Returns:

explain

public AggregationOptions.Builder explain(boolean explain)

Defines whether to get the execution plan for the aggregation instead of the actual results.

Parameters:

explain -

Returns:

cursor

public AggregationOptions.Builder cursor(com.mongodb.DBObject cursor)

Additional options to the aggregation.

Parameters:

cursor -

Returns:

build

public AggregationOptions build()

Returns a new AggregationOptions instance with the given configuration.

Returns: