org.springframework.data.mongodb.core.aggregation

Enum AggregationFunctionExpressions

java.lang.Object

java.lang.Enum<AggregationFunctionExpressions>

org.springframework.data.mongodb.core.aggregation.AggregationFunctionExpressions

All Implemented Interfaces:

Serializable, Comparable<AggregationFunctionExpressions>

public enum AggregationFunctionExpressions
extends Enum<AggregationFunctionExpressions>

An enum of supported AggregationExpressions in aggregation pipeline stages.

Since:

1.10

Author:

Thomas Darimont, Oliver Gierke

Enum Constant Summary

Enum Constants

Enum Constant and Description
SIZE

Method Summary

Modifier and Type	Method and Description
AggregationExpression	of(Object... parameters) Returns an AggregationExpression build from the current Enum name and the given parameters.
static AggregationFunctionExpressions	valueOf(String name) Returns the enum constant of this type with the specified name.
static AggregationFunctionExpressions[]	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

SIZE

public static final AggregationFunctionExpressions SIZE

Method Detail

values

public static AggregationFunctionExpressions[] 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 (AggregationFunctionExpressions c : AggregationFunctionExpressions.values())
    System.out.println(c);

Returns:

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

valueOf

public static AggregationFunctionExpressions 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

of

public AggregationExpression of(Object... parameters)

Returns an AggregationExpression build from the current Enum name and the given parameters.

Parameters:

parameters - must not be null

Returns: