java.lang.Object
- dev.morphia.aggregation.experimental.expressions.DateExpressions

```
public final class DateExpressions
extends Object
```
Defines helper methods for the date expressions

Since:

2.0

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DateExpressions.DateExpression
Base class for the date expressions

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static DateFromParts`	`dateFromParts()`	Constructs and returns a Date object given the date’s constituent properties.
`static DateFromString`	`dateFromString()`	Converts a date/time string to a date object.
`static DateToParts`	`dateToParts(Expression date)`	Constructs and returns a Date object given the date’s constituent properties.
`static DateToString`	`dateToString()`	Returns the date as a formatted string.
`static DateExpressions.DateExpression`	`dayOfMonth(Expression value)`	Returns the day of the month for a date as a number between 1 and 31.
`static DateExpressions.DateExpression`	`dayOfWeek(Expression value)`	Returns the day of the week for a date as a number between 1 (Sunday) and 7 (Saturday).
`static DateExpressions.DateExpression`	`dayOfYear(Expression value)`	Returns the day of the year for a date as a number between 1 and 366 (leap year).
`static DateExpressions.DateExpression`	`hour(Expression value)`	Returns the hour for a date as a number between 0 and 23.
`static IsoDates`	`isoDayOfWeek(Expression value)`	Returns the weekday number in ISO 8601 format, ranging from 1 (for Monday) to 7 (for Sunday).
`static IsoDates`	`isoWeek(Expression value)`	Returns the week number in ISO 8601 format, ranging from 1 to 53.
`static IsoDates`	`isoWeekYear(Expression value)`	Returns the year number in ISO 8601 format.
`static DateExpressions.DateExpression`	`milliseconds(Expression value)`	Returns the milliseconds of a date as a number between 0 and 999.
`static DateExpressions.DateExpression`	`minute(Expression value)`	Returns the minute for a date as a number between 0 and 59.
`static DateExpressions.DateExpression`	`month(Expression value)`	Returns the month for a date as a number between 1 (January) and 12 (December).
`static DateExpressions.DateExpression`	`second(Expression value)`	Returns the seconds for a date as a number between 0 and 60 (leap seconds).
`static DateExpressions.DateExpression`	`toDate(Expression value)`	Converts a value to a date.
`static DateExpressions.DateExpression`	`week(Expression value)`	Returns the week number for a date as a number between 0 (the partial week that precedes the first Sunday of the year) and 53 (leap year).
`static DateExpressions.DateExpression`	`year(Expression value)`	Returns the year for a date as a number (e.g.

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

- Method Detail
  - dateFromParts
```
public static DateFromParts dateFromParts()
```
    Constructs and returns a Date object given the date’s constituent properties.
    
    Returns:
    
    the new expression
    
    MongoDB documentation
    Aggregration Expression: $dateFromParts
  - dateFromString
```
public static DateFromString dateFromString()
```
    Converts a date/time string to a date object.
    
    Returns:
    
    the new expression
    
    MongoDB documentation
    Aggregration Expression: $dateFromString
  - dateToParts
```
public static DateToParts dateToParts(Expression date)
```
    Constructs and returns a Date object given the date’s constituent properties.
    
    Parameters:
    
    date - The input date for which to return parts.
    
    Returns:
    
    the new expression
    
    MongoDB documentation
    Aggregration Expression: $dateToParts
  - dateToString
```
public static DateToString dateToString()
```
    Returns the date as a formatted string.
    
    Returns:
    
    the new expression
    
    MongoDB documentation
    Aggregration Expression: $dateToString
  - dayOfMonth
```
public static DateExpressions.DateExpression dayOfMonth(Expression value)
```
    Returns the day of the month for a date as a number between 1 and 31.
    
    Parameters:
    
    value - the expression containing the date value
    
    Returns:
    
    the new expression
    
    MongoDB documentation
    Aggregration Expression: $dayOfMonth
  - dayOfWeek
```
public static DateExpressions.DateExpression dayOfWeek(Expression value)
```
    Returns the day of the week for a date as a number between 1 (Sunday) and 7 (Saturday).
    
    Parameters:
    
    value - the expression containing the date value
    
    Returns:
    
    the new expression
    
    MongoDB documentation
    Aggregration Expression: $dayOfWeek
  - dayOfYear
```
public static DateExpressions.DateExpression dayOfYear(Expression value)
```
    Returns the day of the year for a date as a number between 1 and 366 (leap year).
    
    Parameters:
    
    value - the expression containing the date value
    
    Returns:
    
    the new expression
    
    MongoDB documentation
    Aggregration Expression: $dayOfYear
  - hour
```
public static DateExpressions.DateExpression hour(Expression value)
```
    Returns the hour for a date as a number between 0 and 23.
    
    Parameters:
    
    value - the expression containing the date value
    
    Returns:
    
    the new expression
    
    MongoDB documentation
    Aggregration Expression: $hour
  - isoDayOfWeek
```
public static IsoDates isoDayOfWeek(Expression value)
```
    Returns the weekday number in ISO 8601 format, ranging from 1 (for Monday) to 7 (for Sunday).
    
    Parameters:
    
    value - the expression containing the date value
    
    Returns:
    
    the new expression
    
    MongoDB documentation
    Aggregration Expression: $isoDayOfWeek
  - isoWeek
```
public static IsoDates isoWeek(Expression value)
```
    Returns the week number in ISO 8601 format, ranging from 1 to 53. Week numbers start at 1 with the week (Monday through Sunday) that contains the year’s first Thursday.
    
    Parameters:
    
    value - the expression containing the date value
    
    Returns:
    
    the new expression
    
    MongoDB documentation
    Aggregration Expression: $isoWeek
  - isoWeekYear
```
public static IsoDates isoWeekYear(Expression value)
```
    Returns the year number in ISO 8601 format. The year starts with the Monday of week 1 (ISO 8601) and ends with the Sunday of the last week (ISO 8601).
    
    Parameters:
    
    value - the expression containing the date value
    
    Returns:
    
    the new expression
    
    MongoDB documentation
    Aggregration Expression: $isoWeekYear
  - milliseconds
```
public static DateExpressions.DateExpression milliseconds(Expression value)
```
    Returns the milliseconds of a date as a number between 0 and 999.
    
    Parameters:
    
    value - the expression containing the date value
    
    Returns:
    
    the new expression
    
    MongoDB documentation
    Aggregration Expression: $millisecond
  - minute
```
public static DateExpressions.DateExpression minute(Expression value)
```
    Returns the minute for a date as a number between 0 and 59.
    
    Parameters:
    
    value - the expression containing the date value
    
    Returns:
    
    the new expression
    
    MongoDB documentation
    Aggregration Expression: $minute
  - month
```
public static DateExpressions.DateExpression month(Expression value)
```
    Returns the month for a date as a number between 1 (January) and 12 (December).
    
    Parameters:
    
    value - the expression containing the date value
    
    Returns:
    
    the new expression
    
    MongoDB documentation
    Aggregration Expression: $month
  - second
```
public static DateExpressions.DateExpression second(Expression value)
```
    Returns the seconds for a date as a number between 0 and 60 (leap seconds).
    
    Parameters:
    
    value - the expression containing the date value
    
    Returns:
    
    the new expression
    
    MongoDB documentation
    Aggregration Expression: $second
  - toDate
```
public static DateExpressions.DateExpression toDate(Expression value)
```
    Converts a value to a date. If the value cannot be converted to a date, $toDate errors. If the value is null or missing, $toDate returns null.
    
    Parameters:
    
    value - the expression containing the date value
    
    Returns:
    
    the new expression
    
    MongoDB documentation
    Aggregration Expression: $toDate
  - week
```
public static DateExpressions.DateExpression week(Expression value)
```
    Returns the week number for a date as a number between 0 (the partial week that precedes the first Sunday of the year) and 53 (leap year).
    
    Parameters:
    
    value - the expression containing the date value
    
    Returns:
    
    the new expression
    
    MongoDB documentation
    Aggregration Expression: $week
  - year
```
public static DateExpressions.DateExpression year(Expression value)
```
    Returns the year for a date as a number (e.g. 2014).
    
    Parameters:
    
    value - the expression containing the date value
    
    Returns:
    
    the new expression
    
    MongoDB documentation
    Aggregration Expression: $year

Class DateExpressions

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

dateFromParts

dateFromString

dateToParts

dateToString

dayOfMonth

dayOfWeek

dayOfYear

hour

isoDayOfWeek

isoWeek

isoWeekYear

milliseconds

minute

month

second

toDate

week

year