Package com.mongodb.client.model

Enum Class CollationMaxVariable

java.lang.Object
java.lang.Enum<CollationMaxVariable>
com.mongodb.client.model.CollationMaxVariable
All Implemented Interfaces:
Comparable<CollationMaxVariable>, java.lang.constant.Constable
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:
Since server release
3.4

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    PUNCT
    Punct
    SPACE
    Shifted

  • Method Summary

    Modifier and Type
    Method
    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 class with the specified name.
    static CollationMaxVariable[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    equals, name, valueOf

    Methods inherited from class java.lang.Object

    wait, wait

  • Enum Constant Details

  • Method Details

    • values

      public static CollationMaxVariable[] 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 CollationMaxVariable 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 CollationMaxVariable fromString(String collationMaxVariable)
      Returns the CollationMaxVariable from the string value.
      Parameters:
      collationMaxVariable - the string value.
      Returns:
      the read concern