com.mongodb.client.model

Enum CollationAlternate

java.lang.Object

java.lang.Enum<CollationAlternate>

com.mongodb.client.model.CollationAlternate

All Implemented Interfaces:

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

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

Collation support allows the specific configuration of whether or not spaces and punctuation are considered base characters.

Since:

3.4

Enum Constant Summary

Enum Constants

Enum Constant and Description
NON_IGNORABLE Non-ignorable
SHIFTED Shifted

Method Summary

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

NON_IGNORABLE

public static final CollationAlternate NON_IGNORABLE

Non-ignorable

Spaces and punctuation are considered base characters

SHIFTED

public static final CollationAlternate SHIFTED

Shifted

Spaces and punctuation are not considered base characters, and are only distinguished when the collation strength is > 3

See Also:

CollationMaxVariable

Method Detail

values

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

Returns:

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

valueOf

public static CollationAlternate 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 CollationAlternate fromString(java.lang.String collationAlternate)

Returns the CollationAlternate from the string value.

Parameters:

collationAlternate - the string value.

Returns:

the read concern