AccumulatorOperators.Sum (Spring Data MongoDB

java.lang.Object
- org.springframework.data.mongodb.core.aggregation.AccumulatorOperators.Sum

All Implemented Interfaces:

AggregationExpression

Enclosing class:

AccumulatorOperators
```
public static class AccumulatorOperators.Sum
extends Object
```
AggregationExpression for $sum.

Author:

Christoph Strobl

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccumulatorOperators.Sum`	`and(AggregationExpression expression)` Creates new `AccumulatorOperators.Sum` with all previously added arguments appending the given one.
`AccumulatorOperators.Sum`	`and(Number value)` Creates new `AccumulatorOperators.Sum` with all previously added arguments appending the given one.
`AccumulatorOperators.Sum`	`and(String fieldReference)` Creates new `AccumulatorOperators.Sum` with all previously added arguments appending the given one.
`protected List<Object>`	`append(Object value)`
`protected Map<String,Object>`	`append(String key, Object value)`
`protected Map<String,Object>`	`argumentMap()` Get the argument map.
`protected static List<Field>`	`asFields(String... fieldRefs)`
`protected boolean`	`contains(Object key)` Check if the given key is available.
`protected <T> T`	`get(int index)` Get the value at a given index.
`protected <T> T`	`get(Object key)` Get the value for a given key.
`protected String`	`getMongoMethod()`
`static AccumulatorOperators.Sum`	`sumOf(AggregationExpression expression)` Creates new `AccumulatorOperators.Sum`.
`static AccumulatorOperators.Sum`	`sumOf(String fieldReference)` Creates new `AccumulatorOperators.Sum`.
`org.bson.Document`	`toDocument(AggregationOperationContext context)` Turns the `AggregationExpression` into a `Document` within the given `AggregationOperationContext`.
`org.bson.Document`	`toDocument(Object value, AggregationOperationContext context)`
`protected List<Object>`	`values()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getMongoMethod
```
protected String getMongoMethod()
```
  - sumOf
```
public static AccumulatorOperators.Sum sumOf(String fieldReference)
```
    Creates new AccumulatorOperators.Sum.
    
    Parameters:
    
    fieldReference - must not be null.
    
    Returns:
  - sumOf
```
public static AccumulatorOperators.Sum sumOf(AggregationExpression expression)
```
    Creates new AccumulatorOperators.Sum.
    
    Parameters:
    
    expression - must not be null.
    
    Returns:
  - and
```
public AccumulatorOperators.Sum and(String fieldReference)
```
    Creates new AccumulatorOperators.Sum with all previously added arguments appending the given one.
    NOTE: Only possible in $project stage.
    
    Parameters:
    
    fieldReference - must not be null.
    
    Returns:
  - and
```
public AccumulatorOperators.Sum and(AggregationExpression expression)
```
    Creates new AccumulatorOperators.Sum with all previously added arguments appending the given one.
    NOTE: Only possible in $project stage.
    
    Parameters:
    
    expression - must not be null.
    
    Returns:
  - and
```
public AccumulatorOperators.Sum and(Number value)
```
    Creates new AccumulatorOperators.Sum with all previously added arguments appending the given one.
    NOTE: Only possible in $project stage.
    
    Parameters:
    
    value - the value to add.
    
    Returns:
    
    new instance of AccumulatorOperators.Sum.
    
    Since:
    
    2.2
  - toDocument
```
public org.bson.Document toDocument(Object value,
                                    AggregationOperationContext context)
```
  - toDocument
```
public org.bson.Document toDocument(AggregationOperationContext context)
```
    Description copied from interface: AggregationExpression
    
    Turns the AggregationExpression into a Document within the given AggregationOperationContext.
    
    Specified by:
    
    toDocument in interface AggregationExpression
    
    Returns:
  - asFields
```
protected static List<Field> asFields(String... fieldRefs)
```
  - append
```
protected List<Object> append(Object value)
```
  - append
```
protected Map<String,Object> append(String key,
                                    Object value)
```
  - values
```
protected List<Object> 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
```
protected <T> T get(Object key)
```
    Get the value for a given key.
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    key -
    
    Returns:
    
    Since:
    
    2.1
  - argumentMap
```
protected Map<String,Object> argumentMap()
```
    Get the argument map.
    
    Returns:
    
    Since:
    
    2.1
  - contains
```
protected boolean contains(Object key)
```
    Check if the given key is available.
    
    Parameters:
    
    key -
    
    Returns:
    
    Since:
    
    2.1

Class AccumulatorOperators.Sum

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getMongoMethod

sumOf

sumOf

and

and

and

toDocument

toDocument

asFields

append

append

values

get

get

argumentMap

contains