Class ArithmeticOperators.Mod
java.lang.Object
org.springframework.data.mongodb.core.aggregation.ArithmeticOperators.Mod
- All Implemented Interfaces:
AggregationExpression
,MongoExpression
- Enclosing class:
- ArithmeticOperators
AggregationExpression
for $mod
.- Author:
- Christoph Strobl
-
Method Summary
Modifier and TypeMethodDescriptionappend
(Object value, org.springframework.data.mongodb.core.aggregation.AbstractAggregationExpression.Expand expandList) Append the given key at the position in the underlyingLinkedHashMap
.Get the argument map.protected boolean
Check if the given key is available.protected <T> T
get
(int index) Get the value at a given index.protected <T> T
Get the value for a given key.protected String
protected boolean
Use the given value as mod base.Use the value stored at the given field as mod base.mod
(AggregationExpression expression) Use evaluated value of the givenAggregationExpression
as mod base.org.bson.Document
toDocument
(Object value, AggregationOperationContext context) org.bson.Document
toDocument
(AggregationOperationContext context) static ArithmeticOperators.Mod
Creates newArithmeticOperators.Mod
.static ArithmeticOperators.Mod
Creates newArithmeticOperators.Mod
.static ArithmeticOperators.Mod
valueOf
(AggregationExpression expression) Creates newArithmeticOperators.Mod
.values()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.springframework.data.mongodb.core.aggregation.AggregationExpression
toDocument
-
Method Details
-
getMongoMethod
-
valueOf
Creates newArithmeticOperators.Mod
.- Parameters:
fieldReference
- must not be null.- Returns:
- new instance of
ArithmeticOperators.Mod
.
-
valueOf
Creates newArithmeticOperators.Mod
.- Parameters:
expression
- must not be null.- Returns:
- new instance of
ArithmeticOperators.Mod
.
-
valueOf
Creates newArithmeticOperators.Mod
.- Parameters:
value
- must not be null.- Returns:
- new instance of
ArithmeticOperators.Mod
.
-
mod
Use the value stored at the given field as mod base.- Parameters:
fieldReference
- must not be null.- Returns:
- new instance of
ArithmeticOperators.Mod
.
-
mod
Use evaluated value of the givenAggregationExpression
as mod base.- Parameters:
expression
- must not be null.- Returns:
- new instance of
ArithmeticOperators.Mod
.
-
mod
Use the given value as mod base.- Parameters:
base
- must not be null.- Returns:
- new instance of
ArithmeticOperators.Mod
.
-
toDocument
Description copied from interface:AggregationExpression
- Specified by:
toDocument
in interfaceAggregationExpression
- Parameters:
context
- must not be null.- Returns:
- the MongoDB native (
Document
) form of the expression.
-
toDocument
-
asFields
-
append
-
append
-
append
-
appendTo
-
remove
-
appendAt
Append the given key at the position in the underlyingLinkedHashMap
.- Parameters:
index
-key
-value
-- Returns:
- Since:
- 3.1
-
values
-
get
protected <T> T get(int index) Get the value at a given index.- Type Parameters:
T
-- Parameters:
index
-- Returns:
- Since:
- 2.1
-
get
Get the value for a given key.- Type Parameters:
T
-- Parameters:
key
-- Returns:
- Since:
- 2.1
-
isArgumentMap
protected boolean isArgumentMap() -
argumentMap
Get the argument map.- Returns:
- Since:
- 2.1
-
contains
Check if the given key is available.- Parameters:
key
-- Returns:
- Since:
- 2.1
-