Package com.mongodb.client.model

Enum Class CollationCaseFirst

java.lang.Object

java.lang.Enum<CollationCaseFirst>

com.mongodb.client.model.CollationCaseFirst

All Implemented Interfaces:

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

public enum CollationCaseFirst
extends Enum<CollationCaseFirst>

Collation support allows the specific configuration of how character cases are handled.

Since:

3.4

Since server release

3.4

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
LOWER	Lowercase first
OFF	Off
UPPER	Uppercase first

Method Summary

Modifier and Type	Method	Description
static CollationCaseFirst	fromString(String collationCaseFirst)	Returns the CollationCaseFirst from the string value.
String	getValue()
static CollationCaseFirst	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CollationCaseFirst[]	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

UPPER

public static final CollationCaseFirst UPPER

Uppercase first

LOWER

public static final CollationCaseFirst LOWER

Lowercase first

OFF

public static final CollationCaseFirst OFF

Off

Method Details

values

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

getValue

public String getValue()

Returns:

the String representation of the collation case first value

fromString

public static CollationCaseFirst fromString(String collationCaseFirst)

Returns the CollationCaseFirst from the string value.

Parameters:

collationCaseFirst - the string value.

Returns:

the read concern