Package com.mongodb.client.model

Enum Class MongoTimeUnit

java.lang.Object

java.lang.Enum<MongoTimeUnit>

com.mongodb.client.model.MongoTimeUnit

All Implemented Interfaces:

Serializable, Comparable<MongoTimeUnit>, java.lang.constant.Constable

@Beta
public enum MongoTimeUnit
extends Enum<MongoTimeUnit>

Units for specifying time-based bounds for windows and output units for some time-based windowed computations.

Since:

4.3

Since server release

5.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DAY	DAY
HOUR	HOUR
MILLISECOND	MILLISECOND
MINUTE	MINUTE
MONTH	MONTH
QUARTER	QUARTER
SECOND	SECOND
WEEK	WEEK
YEAR	YEAR

Method Summary

Modifier and Type	Method	Description
static MongoTimeUnit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MongoTimeUnit[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

YEAR

public static final MongoTimeUnit YEAR

YEAR

QUARTER

public static final MongoTimeUnit QUARTER

QUARTER

MONTH

public static final MongoTimeUnit MONTH

MONTH

WEEK

public static final MongoTimeUnit WEEK

WEEK

DAY

public static final MongoTimeUnit DAY

DAY

HOUR

public static final MongoTimeUnit HOUR

HOUR

MINUTE

public static final MongoTimeUnit MINUTE

MINUTE

SECOND

public static final MongoTimeUnit SECOND

SECOND

MILLISECOND

public static final MongoTimeUnit MILLISECOND

MILLISECOND

Method Details

values

public static MongoTimeUnit[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MongoTimeUnit valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null