com.mongodb

Enum AggregationOptions.OutputMode

java.lang.Object

java.lang.Enum<AggregationOptions.OutputMode>

com.mongodb.AggregationOptions.OutputMode

All Implemented Interfaces:

Serializable, Comparable<AggregationOptions.OutputMode>

Enclosing class:

AggregationOptions

public static enum AggregationOptions.OutputMode
extends Enum<AggregationOptions.OutputMode>

Enumeration to define where the results of the aggregation will be output.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CURSOR The output of the aggregate operation is returned using a cursor.
INLINE The output of the aggregate operation is returned inline.

Method Summary

Modifier and Type	Method and Description
static AggregationOptions.OutputMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static AggregationOptions.OutputMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INLINE

public static final AggregationOptions.OutputMode INLINE

The output of the aggregate operation is returned inline.

CURSOR

public static final AggregationOptions.OutputMode CURSOR

The output of the aggregate operation is returned using a cursor.

Since server release

2.6

Method Detail

values

public static AggregationOptions.OutputMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AggregationOptions.OutputMode c : AggregationOptions.OutputMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AggregationOptions.OutputMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null