Class Collation


  • public final class Collation
    extends java.lang.Object
    The options regarding collation support in MongoDB 3.4+
    Since:
    3.4
    • Method Detail

      • builder

        public static Collation.Builder builder()
        Convenience method to create a Builder.
        Returns:
        a builder
      • builder

        public static Collation.Builder builder​(Collation options)
        Convenience method to create a from an existing Collation.
        Parameters:
        options - create a builder from existing options
        Returns:
        a builder
      • getLocale

        @Nullable
        public java.lang.String getLocale()
        Returns the locale
        Returns:
        the locale
        See Also:
        ICU User Guide - Locale
      • getCaseLevel

        @Nullable
        public java.lang.Boolean getCaseLevel()
        Returns the case level value
        Returns:
        the case level value
      • getCaseFirst

        @Nullable
        public CollationCaseFirst getCaseFirst()
        Returns the collation case first value
        Returns:
        the collation case first value
      • getStrength

        @Nullable
        public CollationStrength getStrength()
        Returns the collation strength
        Returns:
        the collation strength
      • getNumericOrdering

        @Nullable
        public java.lang.Boolean getNumericOrdering()
        Returns the numeric ordering, if true will order numbers based on numerical order and not collation order.
        Returns:
        the numeric ordering
      • getAlternate

        @Nullable
        public CollationAlternate getAlternate()
        Returns the collation alternate
        Returns:
        the alternate
      • getNormalization

        @Nullable
        public java.lang.Boolean getNormalization()
        Returns the normalization value

        If true, normalizes text into Unicode NFD.

        Returns:
        the normalization
      • getBackwards

        @Nullable
        public java.lang.Boolean getBackwards()
        Returns the backwards value
        Returns:
        the backwards value
      • asDocument

        public BsonDocument asDocument()
        Gets this collation options as a document.
        Returns:
        The collation options as a BsonDocument
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object