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
- Since:
- 2.1
- Author:
- Matt Morrissette, Christoph Strobl
- See Also:
-
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.static DateOperators.DateFromString
fromString
(Object value) Creates newDateOperators.DateFromString
.static DateOperators.DateFromString
fromStringOf
(String fieldReference) Creates newDateOperators.DateFromString
.static DateOperators.DateFromString
fromStringOf
(AggregationExpression expression) Creates newDateOperators.DateFromString
.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
org.bson.Document
toDocument
(Object value, AggregationOperationContext context) org.bson.Document
toDocument
(AggregationOperationContext context) values()
withFormat
(String format) Optionally set the date format to use.withTimezone
(DateOperators.Timezone timezone) Optionally set theDateOperators.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
Creates newDateOperators.DateFromString
.- Parameters:
value
- must not be null.- Returns:
- new instance of
DateOperators.DateFromString
. - Throws:
IllegalArgumentException
- if given value is null.
-
fromStringOf
Creates newDateOperators.DateFromString
.- Parameters:
fieldReference
- must not be null.- Returns:
- new instance of
DateOperators.DateFromString
. - Throws:
IllegalArgumentException
- if given fieldReference is null.
-
fromStringOf
Creates newDateOperators.DateFromString
.- Parameters:
expression
- must not be null.- Returns:
- new instance of
DateOperators.DateFromString
. - Throws:
IllegalArgumentException
- if given expression is null.
-
withTimezone
Optionally set theDateOperators.Timezone
to use. If not specified UTC is used.
NOTE: Requires MongoDB 3.6 or later.- Specified by:
withTimezone
in classDateOperators.TimezonedDateAggregationExpression
- Parameters:
timezone
- must not be null. ConsiderDateOperators.Timezone.none()
instead.- Returns:
- new instance of
DateOperators.DateFromString
. - Throws:
IllegalArgumentException
- if given timezone is null.
-
withFormat
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
-
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
-