Module spring.data.mongodb

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

Enum Class ArrayOperators.Reduce.Variable

java.lang.Object

java.lang.Enum<ArrayOperators.Reduce.Variable>

org.springframework.data.mongodb.core.aggregation.ArrayOperators.Reduce.Variable

All Implemented Interfaces:

Serializable, Comparable<ArrayOperators.Reduce.Variable>, Constable, AggregationVariable, Field

Enclosing class:

ArrayOperators.Reduce

public static enum ArrayOperators.Reduce.Variable
extends Enum<ArrayOperators.Reduce.Variable>
implements AggregationVariable

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
THIS
VALUE

Field Summary

Fields inherited from interface org.springframework.data.mongodb.core.aggregation.AggregationVariable

PREFIX

Method Summary

Modifier and Type	Method	Description
boolean	isInternal()
static boolean	isVariable(Field field)	Check if the given field may be variable.
Field	referringTo(String property)	Create a Field reference to a given property prefixed with the ArrayOperators.Reduce.Variable identifier.
static ArrayOperators.Reduce.Variable	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ArrayOperators.Reduce.Variable[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.data.mongodb.core.aggregation.AggregationVariable

getName, isAliased

Methods inherited from interface org.springframework.data.mongodb.core.aggregation.Field

getTarget

Enum Constant Details

THIS

public static final ArrayOperators.Reduce.Variable THIS

VALUE

public static final ArrayOperators.Reduce.Variable VALUE

Method Details

values

public static ArrayOperators.Reduce.Variable[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ArrayOperators.Reduce.Variable valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

isInternal

public boolean isInternal()

Specified by:

isInternal in interface AggregationVariable

Specified by:

isInternal in interface Field

Returns:

true if the field name references a local value such as $$this.

referringTo

public Field referringTo(String property)

Create a Field reference to a given property prefixed with the ArrayOperators.Reduce.Variable identifier. eg. $$value.product

Parameters:

property - must not be null.

Returns:

never null.

isVariable

public static boolean isVariable(Field field)

Description copied from interface: AggregationVariable

Check if the given field may be variable.

Parameters:

field - can be null.

Returns:

true if given field is an AggregationVariable or if its value is a variable.