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

public enum MongoTimeUnit
extends Enum<MongoTimeUnit>

Units for specifying time-based values.

Since:

4.3

See Also:

• Windows
• WindowOutputFields
• DensifyRange

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
String	value()	Returns a String representation of the unit, which may be useful when using methods like Windows.of(Bson), DensifyRange.of(Bson).
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

value

public String value()

Returns a String representation of the unit, which may be useful when using methods like Windows.of(Bson), DensifyRange.of(Bson).

Returns:

A String representation of the unit.