Module spring.data.mongodb

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

Class DateOperators.DateFromString

java.lang.Object

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

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

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

DateOperators

public static class DateOperators.DateFromString
extends DateOperators.TimezonedDateAggregationExpression

AggregationExpression for $dateFromString.
NOTE: Requires MongoDB 3.6 or later.

Since:

2.1

Author:

Matt Morrissette, Christoph Strobl

See Also:

• https://docs.mongodb.com/manual/reference/operator/aggregation/dateFromString/

Method Summary

Modifier and Type	Method	Description
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.
static DateOperators.DateFromString	fromString(Object value)	Creates new DateOperators.DateFromString.
static DateOperators.DateFromString	fromStringOf(String fieldReference)	Creates new DateOperators.DateFromString.
static DateOperators.DateFromString	fromStringOf(AggregationExpression expression)	Creates new DateOperators.DateFromString.
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)
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.DateFromString	withFormat(String format)	Optionally set the date format to use.
DateOperators.DateFromString	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

fromString

public static DateOperators.DateFromString fromString(Object value)

Creates new DateOperators.DateFromString.

Parameters:

value - must not be null.

Returns:

new instance of DateOperators.DateFromString.

Throws:

IllegalArgumentException - if given value is null.

fromStringOf

public static DateOperators.DateFromString fromStringOf(String fieldReference)

Creates new DateOperators.DateFromString.

Parameters:

fieldReference - must not be null.

Returns:

new instance of DateOperators.DateFromString.

Throws:

IllegalArgumentException - if given fieldReference is null.

fromStringOf

public static DateOperators.DateFromString fromStringOf(AggregationExpression expression)

Creates new DateOperators.DateFromString.

Parameters:

expression - must not be null.

Returns:

new instance of DateOperators.DateFromString.

Throws:

IllegalArgumentException - if given expression is null.

withTimezone

public DateOperators.DateFromString withTimezone(DateOperators.Timezone timezone)

Optionally set the DateOperators.Timezone to use. If not specified UTC is used.
NOTE: Requires MongoDB 3.6 or later.

Specified by:

withTimezone in class DateOperators.TimezonedDateAggregationExpression

Parameters:

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

Returns:

new instance of DateOperators.DateFromString.

Throws:

IllegalArgumentException - if given timezone is null.

withFormat

public DateOperators.DateFromString withFormat(String format)

Optionally set the date format to use. If not specified %Y-%m-%dT%H:%M:%S.%LZ is used.
NOTE: Requires MongoDB 4.0 or later.

Parameters:

format - must not be null.

Returns:

new instance of DateOperators.DateFromString.

Throws:

IllegalArgumentException - if given format is null.

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