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
-
Field Summary
Fields inherited from interface org.springframework.data.mongodb.core.aggregation.AggregationVariable
PREFIX
-
Method Summary
Modifier and TypeMethodDescriptionboolean
static boolean
isVariable
(Field field) Check if the given field may be variable.referringTo
(String property) Create aField
reference to a given property prefixed with theArrayOperators.Reduce.Variable
identifier.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 interface org.springframework.data.mongodb.core.aggregation.AggregationVariable
getName, isAliased
-
Enum Constant Details
-
THIS
-
VALUE
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
isInternal
public boolean isInternal()- Specified by:
isInternal
in interfaceAggregationVariable
- Specified by:
isInternal
in interfaceField
- Returns:
- true if the field name references a local value such as
$$this
.
-
referringTo
Create aField
reference to a given property prefixed with theArrayOperators.Reduce.Variable
identifier. eg.$$value.product
- Parameters:
property
- must not be null.- Returns:
- never null.
-
isVariable
Description copied from interface:AggregationVariable
Check if the given field may be variable.- Parameters:
field
- can be null.- Returns:
- true if given
field
is anAggregationVariable
or if its value is avariable
.
-