com.mongodb.client.model

Enum CollationMaxVariable

java.lang.Object

java.lang.Enum<CollationMaxVariable>

com.mongodb.client.model.CollationMaxVariable

All Implemented Interfaces:

Serializable, Comparable<CollationMaxVariable>

public enum CollationMaxVariable
extends Enum<CollationMaxVariable>

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

CollationMaxVariable controls which characters are affected by CollationAlternate.SHIFTED.

Since:

3.4

See Also:

CollationAlternate.SHIFTED

Since server release

3.4

Enum Constant Summary

Enum Constants

Enum Constant and Description
PUNCT Punct
SPACE Shifted

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PUNCT

public static final CollationMaxVariable PUNCT

Punct

Both punctuation and spaces are affected.

SPACE

public static final CollationMaxVariable SPACE

Shifted

Only spaces are affected.

Method Detail

values

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

Returns:

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

valueOf

public static CollationMaxVariable valueOf(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:

IllegalArgumentException - if this enum type 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 CollationMaxVariable fromString(String collationMaxVariable)

Returns the CollationMaxVariable from the string value.

Parameters:

collationMaxVariable - the string value.

Returns:

the read concern