Package com.mongodb.client.cursor

Enum Class TimeoutMode

java.lang.Object

java.lang.Enum<TimeoutMode>

com.mongodb.client.cursor.TimeoutMode

All Implemented Interfaces:

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

@Alpha(CLIENT)
public enum TimeoutMode
extends Enum<TimeoutMode>

The timeout mode for a cursor

For operations that create cursors, timeoutMS can either cap the lifetime of the cursor or be applied separately to the original operation and all next calls.

Since:

5.2

See Also:

• MongoClientSettings.getTimeout(TimeUnit)

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
CURSOR_LIFETIME	The timeout lasts for the lifetime of the cursor
ITERATION	The timeout is reset for each batch iteration of the cursor

Method Summary

Modifier and Type	Method	Description
static TimeoutMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TimeoutMode[]	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

CURSOR_LIFETIME

public static final TimeoutMode CURSOR_LIFETIME

The timeout lasts for the lifetime of the cursor

ITERATION

public static final TimeoutMode ITERATION

The timeout is reset for each batch iteration of the cursor

Method Details

values

public static TimeoutMode[] 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 TimeoutMode 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