Module spring.data.mongodb

Package org.springframework.data.mongodb.core.query

Enum Class Meta.CursorOption

java.lang.Object

java.lang.Enum<Meta.CursorOption>

org.springframework.data.mongodb.core.query.Meta.CursorOption

All Implemented Interfaces:

Serializable, Comparable<Meta.CursorOption>, Constable

Enclosing class:

Meta

public static enum Meta.CursorOption
extends Enum<Meta.CursorOption>

Meta.CursorOption represents OP_QUERY wire protocol flags to change the behavior of queries.

Since:

1.10

Author:

Christoph Strobl

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
EXHAUST	Sets the cursor to return all data returned by the query at once rather than splitting the results into batches.
NO_TIMEOUT	Prevents the server from timing out idle cursors.
PARTIAL	Sets the cursor to return partial data from a query against a sharded cluster in which some shards do not respond rather than throwing an error.
SECONDARY_READS	Allows querying of a replica.

Method Summary

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

NO_TIMEOUT

public static final Meta.CursorOption NO_TIMEOUT

Prevents the server from timing out idle cursors.

EXHAUST

public static final Meta.CursorOption EXHAUST

Sets the cursor to return all data returned by the query at once rather than splitting the results into batches.

SECONDARY_READS

public static final Meta.CursorOption SECONDARY_READS

Allows querying of a replica.

Since:

3.0.2

PARTIAL

public static final Meta.CursorOption PARTIAL

Sets the cursor to return partial data from a query against a sharded cluster in which some shards do not respond rather than throwing an error.

Method Details

values

public static Meta.CursorOption[] 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 Meta.CursorOption 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