Module spring.data.mongodb

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

Class DateOperators.DateAdd

java.lang.Object

org.springframework.data.mongodb.core.aggregation.DateOperators.TimezonedDateAggregationExpression

org.springframework.data.mongodb.core.aggregation.DateOperators.DateAdd

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

DateOperators

public static class DateOperators.DateAdd
extends DateOperators.TimezonedDateAggregationExpression

AggregationExpression for $dateAdd.
NOTE: Requires MongoDB 5.0 or later.

Since:

3.3

Author:

Christoph Strobl

Method Summary

Modifier and Type	Method	Description
static DateOperators.DateAdd	addValue(Object value, String unit)	Add the number of units to a start date.
static DateOperators.DateAdd	addValueOf(String fieldReference, String unit)	Add the number of units from a field to a start date.
static DateOperators.DateAdd	addValueOf(AggregationExpression expression, String unit)	Add the number of units of the result of the given expression to a start date.
protected List<Object>	append(Object value)
protected List<Object>	append(Object value, org.springframework.data.mongodb.core.aggregation.AbstractAggregationExpression.Expand expandList)
protected Map<String,Object>	append(String key, Object value)
protected Map<String,Object>	appendAt(int index, String key, Object value)	Append the given key at the position in the underlying LinkedHashMap.
protected Map<String,Object>	appendTo(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()
protected boolean	isArgumentMap()
protected Map<String,Object>	remove(String key)
DateOperators.DateAdd	toDate(Object dateExpression)	Define the start date, in UTC, for the addition operation.
DateOperators.DateAdd	toDateOf(String fieldReference)	Define the start date, in UTC, for the addition operation.
DateOperators.DateAdd	toDateOf(AggregationExpression expression)	Define the start date, in UTC, for the addition operation.
org.bson.Document	toDocument(Object value, AggregationOperationContext context)
org.bson.Document	toDocument(AggregationOperationContext context)	Turns the AggregationExpression into a Document within the given AggregationOperationContext.
protected List<Object>	values()
DateOperators.DateAdd	withTimezone(DateOperators.Timezone timezone)	Optionally set the DateOperators.Timezone to use.

Methods inherited from class org.springframework.data.mongodb.core.aggregation.DateOperators.TimezonedDateAggregationExpression

appendTimezone, hasTimezone

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

addValueOf

public static DateOperators.DateAdd addValueOf(AggregationExpression expression,
 String unit)

Add the number of units of the result of the given expression to a start date.

Parameters:

expression - must not be null.

unit - must not be null.

Returns:

new instance of DateOperators.DateAdd.

addValueOf

public static DateOperators.DateAdd addValueOf(String fieldReference,
 String unit)

Add the number of units from a field to a start date.

Parameters:

fieldReference - must not be null.

unit - must not be null.

Returns:

new instance of DateOperators.DateAdd.

addValue

public static DateOperators.DateAdd addValue(Object value,
 String unit)

Add the number of units to a start date.

Parameters:

value - must not be null.

unit - must not be null.

Returns:

new instance of DateOperators.DateAdd.

toDateOf

public DateOperators.DateAdd toDateOf(AggregationExpression expression)

Define the start date, in UTC, for the addition operation.

Parameters:

expression - must not be null.

Returns:

new instance of DateOperators.DateAdd.

toDateOf

public DateOperators.DateAdd toDateOf(String fieldReference)

Define the start date, in UTC, for the addition operation.

Parameters:

fieldReference - must not be null.

Returns:

new instance of DateOperators.DateAdd.

toDate

public DateOperators.DateAdd toDate(Object dateExpression)

Define the start date, in UTC, for the addition operation.

Parameters:

dateExpression - anything that evaluates to a valid date. Must not be null.

Returns:

new instance of DateOperators.DateAdd.

withTimezone

public DateOperators.DateAdd withTimezone(DateOperators.Timezone timezone)

Optionally set the DateOperators.Timezone to use. If not specified UTC is used.

Specified by:

withTimezone in class DateOperators.TimezonedDateAggregationExpression

Parameters:

timezone - must not be null. Consider DateOperators.Timezone.none() instead.

Returns:

new instance of DateOperators.DateAdd.

getMongoMethod

protected String getMongoMethod()

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

Parameters:

context - must not be null.

Returns:

the MongoDB native (Document) form of the expression.

toDocument

public org.bson.Document toDocument(Object value,
 AggregationOperationContext context)

asFields

protected static List<Field> asFields(String... fieldRefs)

append

protected List<Object> append(Object value,
 org.springframework.data.mongodb.core.aggregation.AbstractAggregationExpression.Expand expandList)

append

protected List<Object> append(Object value)

append

protected Map<String,Object> append(String key,
 Object value)

appendTo

protected Map<String,Object> appendTo(String key,
 Object value)

remove

protected Map<String,Object> remove(String key)

appendAt

protected Map<String,Object> appendAt(int index,
 String key,
 Object value)

Append the given key at the position in the underlying LinkedHashMap.

Parameters:

index -

key -

value -

Returns:

Since:

3.1

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

isArgumentMap

protected boolean isArgumentMap()

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