Package com.mongodb.client.model

Enum MongoTimeUnit

java.lang.Object

java.lang.Enum<MongoTimeUnit>

com.mongodb.client.model.MongoTimeUnit

All Implemented Interfaces:

Serializable, Comparable<MongoTimeUnit>

@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

Enum Constant Summary

Enum Constants

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

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

YEAR

public static final MongoTimeUnit YEAR

QUARTER

public static final MongoTimeUnit QUARTER

MONTH

public static final MongoTimeUnit MONTH

WEEK

public static final MongoTimeUnit WEEK

DAY

public static final MongoTimeUnit DAY

HOUR

public static final MongoTimeUnit HOUR

MINUTE

public static final MongoTimeUnit MINUTE

SECOND

public static final MongoTimeUnit SECOND

MILLISECOND

public static final MongoTimeUnit MILLISECOND

Method Detail

values

public static MongoTimeUnit[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MongoTimeUnit c : MongoTimeUnit.values())
    System.out.println(c);

Returns:

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

valueOf

public static MongoTimeUnit valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null