Class Collation

    • 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
      • getCaseLevel

        @Nullable
        public 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 Boolean getNumericOrdering​()
        Returns the numeric ordering, if true will order numbers based on numerical order and not collation order.
        Returns:
        the numeric ordering
      • getNormalization

        @Nullable
        public Boolean getNormalization​()
        Returns the normalization value

        If true, normalizes text into Unicode NFD.

        Returns:
        the normalization
      • getBackwards

        @Nullable
        public 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
      • hashCode

        public int hashCode​()
        Overrides:
        hashCode in class Object