org.springframework.data.mongodb.core.aggregation

Class DateOperators.Timezone

java.lang.Object

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

Enclosing class:

DateOperators

public static class DateOperators.Timezone
extends Object

Timezone represents a MongoDB timezone abstraction which can be represented with a timezone ID or offset as a String. Also accepts a AggregationExpression or Field that resolves to a String of either Olson Timezone Identifier or a UTC Offset.

Format	Example
Olson Timezone Identifier	"America/New_York" "Europe/London" "GMT"
UTC Offset	+/-[hh]:[mm], e.g. "+04:45" -[hh][mm], e.g. "-0530" +/-[hh], e.g. "+03"

NOTE: Support for timezones in aggregations Requires MongoDB 3.6 or later.

Since:

2.1

Author:

Christoph Strobl, Mark Paluch

Method Summary

Modifier and Type	Method and Description
static DateOperators.Timezone	fromOffset(TimeZone timeZone) Create a DateOperators.Timezone for the given TimeZone rendering the offset as UTC offset.
static DateOperators.Timezone	fromOffset(ZoneOffset offset) Create a DateOperators.Timezone for the given ZoneOffset rendering the offset as UTC offset.
static DateOperators.Timezone	fromZone(TimeZone timeZone) Create a DateOperators.Timezone for the given TimeZone rendering the offset as UTC offset.
static DateOperators.Timezone	fromZone(ZoneId zoneId) Create a DateOperators.Timezone for the given ZoneId rendering the offset as UTC offset.
static DateOperators.Timezone	none() Return an empty DateOperators.Timezone.
static DateOperators.Timezone	ofExpression(AggregationExpression expression) Create a DateOperators.Timezone for the AggregationExpression resulting in the Olson Timezone Identifier or UTC Offset.
static DateOperators.Timezone	ofField(String fieldReference) Create a DateOperators.Timezone for the Field reference holding the Olson Timezone Identifier or UTC Offset.
static DateOperators.Timezone	valueOf(Object value) Create a DateOperators.Timezone for the given value which must be a valid expression that resolves to a String representing an Olson Timezone Identifier or UTC Offset.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

none

public static DateOperators.Timezone none()

Return an empty DateOperators.Timezone.

Returns:

never null.

valueOf

public static DateOperators.Timezone valueOf(Object value)

Create a DateOperators.Timezone for the given value which must be a valid expression that resolves to a String representing an Olson Timezone Identifier or UTC Offset.

Parameters:

value - the plain timezone String, a Field holding the timezone or an AggregationExpression resulting in the timezone.

Returns:

new instance of DateOperators.Timezone.

fromOffset

public static DateOperators.Timezone fromOffset(TimeZone timeZone)

Create a DateOperators.Timezone for the given TimeZone rendering the offset as UTC offset.

Parameters:

timeZone - TimeZone rendering the offset as UTC offset.

Returns:

new instance of DateOperators.Timezone.

Since:

3.3

fromOffset

public static DateOperators.Timezone fromOffset(ZoneOffset offset)

Create a DateOperators.Timezone for the given ZoneOffset rendering the offset as UTC offset.

Parameters:

offset - ZoneOffset rendering the offset as UTC offset.

Returns:

new instance of DateOperators.Timezone.

Since:

3.3

fromZone

public static DateOperators.Timezone fromZone(TimeZone timeZone)

Create a DateOperators.Timezone for the given TimeZone rendering the offset as UTC offset.

Parameters:

timeZone - DateOperators.Timezone rendering the offset as zone identifier.

Returns:

new instance of DateOperators.Timezone.

Since:

3.3

fromZone

public static DateOperators.Timezone fromZone(ZoneId zoneId)

Create a DateOperators.Timezone for the given ZoneId rendering the offset as UTC offset.

Parameters:

zoneId - ZoneId rendering the offset as zone identifier.

Returns:

new instance of DateOperators.Timezone.

Since:

3.3

ofField

public static DateOperators.Timezone ofField(String fieldReference)

Create a DateOperators.Timezone for the Field reference holding the Olson Timezone Identifier or UTC Offset.

Parameters:

fieldReference - the Field holding the timezone.

Returns:

new instance of DateOperators.Timezone.

ofExpression

public static DateOperators.Timezone ofExpression(AggregationExpression expression)

Create a DateOperators.Timezone for the AggregationExpression resulting in the Olson Timezone Identifier or UTC Offset.

Parameters:

expression - the AggregationExpression resulting in the timezone.

Returns:

new instance of DateOperators.Timezone.