Enum Class CollationAlternate

java.lang.Object
java.lang.Enum<CollationAlternate>
com.mongodb.client.model.CollationAlternate
All Implemented Interfaces:
Serializable, Comparable<CollationAlternate>, java.lang.constant.Constable

public enum CollationAlternate extends Enum<CollationAlternate>
Collation support allows the specific configuration of whether or not spaces and punctuation are considered base characters.
Since:
3.4
Since server release
3.4
  • Enum Constant Details

    • 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:
  • Method Details

    • values

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