Module spring.data.mongodb

Package org.springframework.data.mongodb.core.index

Enum Class IndexOptions.Unique

java.lang.Object

java.lang.Enum<IndexOptions.Unique>

org.springframework.data.mongodb.core.index.IndexOptions.Unique

All Implemented Interfaces:

Serializable, Comparable<IndexOptions.Unique>, Constable

Enclosing class:

IndexOptions

public static enum IndexOptions.Unique
extends Enum<IndexOptions.Unique>

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
NO
PREPARE	An existing index is not checked for pre-existing, duplicate index entries but inserting new duplicate entries fails.
YES	When unique is true the index rejects duplicate entries.

Method Summary

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

public static final IndexOptions.Unique NO

YES

public static final IndexOptions.Unique YES

When unique is true the index rejects duplicate entries.

PREPARE

public static final IndexOptions.Unique PREPARE

An existing index is not checked for pre-existing, duplicate index entries but inserting new duplicate entries fails.

Method Details

values

public static IndexOptions.Unique[] 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 IndexOptions.Unique 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