com.mongodb.client.model

Enum CollationCaseFirst

java.lang.Object

java.lang.Enum<CollationCaseFirst>

com.mongodb.client.model.CollationCaseFirst

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CollationCaseFirst>

public enum CollationCaseFirst
extends java.lang.Enum<CollationCaseFirst>

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

Since:

3.4

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOWER Lowercase first
OFF Off
UPPER Uppercase first

Method Summary

Modifier and Type	Method and Description
static CollationCaseFirst	fromString(java.lang.String collationCaseFirst) Returns the CollationCaseFirst from the string value.
java.lang.String	getValue()
static CollationCaseFirst	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CollationCaseFirst[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UPPER

public static final CollationCaseFirst UPPER

Uppercase first

LOWER

public static final CollationCaseFirst LOWER

Lowercase first

OFF

public static final CollationCaseFirst OFF

Off

Method Detail

values

public static CollationCaseFirst[] 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 (CollationCaseFirst c : CollationCaseFirst.values())
    System.out.println(c);

Returns:

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

valueOf

public static CollationCaseFirst valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getValue

public java.lang.String getValue()

Returns:

the String representation of the collation case first value

fromString

public static CollationCaseFirst fromString(java.lang.String collationCaseFirst)

Returns the CollationCaseFirst from the string value.

Parameters:

collationCaseFirst - the string value.

Returns:

the read concern