Class DateOperators.DateFromParts
java.lang.Object
org.springframework.data.mongodb.core.aggregation.DateOperators.TimezonedDateAggregationExpression
org.springframework.data.mongodb.core.aggregation.DateOperators.DateFromParts
- All Implemented Interfaces:
AggregationExpression
,DateOperators.DateParts<DateOperators.DateFromParts>
,MongoExpression
- Enclosing class:
- DateOperators
public static class DateOperators.DateFromParts
extends DateOperators.TimezonedDateAggregationExpression
implements DateOperators.DateParts<DateOperators.DateFromParts>
- Since:
- 2.1
- Author:
- Matt Morrissette, Christoph Strobl
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
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.Creates newDateOperators.DateFromParts.DateFromPartsWithYear
.Set the day to the given value which must resolve to a calendar day in range1 - 31
.Set the day to the value resolved by following the givenfield reference
.dayOf
(AggregationExpression expression) Set the day to the result of the givenexpression
.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
Set the hour to the given value which must resolve to a value in range of0 - 23
.millisecond
(Object millisecond) Set the millisecond to the given value which must resolve to a value in range0 - 999
.Set the minute to the given value which must resolve to a value in range0 - 59
.Set the month to the given value which must resolve to a calendar month in range1 - 12
.Set the month to the value resolved by following the givenfield reference
.monthOf
(AggregationExpression expression) Set the month to the result of the givenexpression
.Set the second to the given value which must resolve to a value in range0 - 59
.org.bson.Document
toDocument
(Object value, AggregationOperationContext context) org.bson.Document
toDocument
(AggregationOperationContext context) values()
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
Methods inherited from interface org.springframework.data.mongodb.core.aggregation.DateOperators.DateParts
hourOf, hourOf, millisecondOf, millisecondOf, minuteOf, minuteOf, secondOf, secondOf
-
Method Details
-
dateFromParts
Creates newDateOperators.DateFromParts.DateFromPartsWithYear
.- Returns:
- new instance of
DateOperators.DateFromParts.DateFromPartsWithYear
. - Since:
- 2.1
-
month
Set the month to the given value which must resolve to a calendar month in range1 - 12
. Can be a simple value,field reference
orexpression
.- Parameters:
month
- must not be null.- Returns:
- new instance.
- Throws:
IllegalArgumentException
- if given month is null.
-
monthOf
Set the month to the value resolved by following the givenfield reference
.- Parameters:
fieldReference
- must not be null.- Returns:
- new instance.
- Throws:
IllegalArgumentException
- if given fieldReference is null.
-
monthOf
Set the month to the result of the givenexpression
.- Parameters:
expression
- must not be null.- Returns:
- new instance.
- Throws:
IllegalArgumentException
- if given expression is null.
-
day
Set the day to the given value which must resolve to a calendar day in range1 - 31
. Can be a simple value,field reference
orexpression
.- Parameters:
day
- must not be null.- Returns:
- new instance.
- Throws:
IllegalArgumentException
- if given day is null.
-
dayOf
Set the day to the value resolved by following the givenfield reference
.- Parameters:
fieldReference
- must not be null.- Returns:
- new instance.
- Throws:
IllegalArgumentException
- if given fieldReference is null.
-
dayOf
Set the day to the result of the givenexpression
.- Parameters:
expression
- must not be null.- Returns:
- new instance.
- Throws:
IllegalArgumentException
- if given expression is null.
-
hour
Description copied from interface:DateOperators.DateParts
Set the hour to the given value which must resolve to a value in range of0 - 23
. Can be a simple value,field reference
orexpression
.- Specified by:
hour
in interfaceDateOperators.DateParts<DateOperators.DateFromParts>
- Parameters:
hour
- must not be null.- Returns:
- new instance.
-
minute
Description copied from interface:DateOperators.DateParts
Set the minute to the given value which must resolve to a value in range0 - 59
. Can be a simple value,field reference
orexpression
.- Specified by:
minute
in interfaceDateOperators.DateParts<DateOperators.DateFromParts>
- Parameters:
minute
- must not be null.- Returns:
- new instance.
-
second
Description copied from interface:DateOperators.DateParts
Set the second to the given value which must resolve to a value in range0 - 59
. Can be a simple value,field reference
orexpression
.- Specified by:
second
in interfaceDateOperators.DateParts<DateOperators.DateFromParts>
- Parameters:
second
- must not be null.- Returns:
- new instance.
-
millisecond
Description copied from interface:DateOperators.DateParts
Set the millisecond to the given value which must resolve to a value in range0 - 999
. Can be a simple value,field reference
orexpression
.- Specified by:
millisecond
in interfaceDateOperators.DateParts<DateOperators.DateFromParts>
- Parameters:
millisecond
- must not be null.- Returns:
- new instance.
-
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.DateFromParts
. - Throws:
IllegalArgumentException
- if given timezone 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
-
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
-
argumentMap
Get the argument map.- Returns:
- Since:
- 2.1
-
contains
Check if the given key is available.- Parameters:
key
-- Returns:
- Since:
- 2.1
-