final class Collation extends AnyRef

Represents a collection, view, index or operation specific collation.

import reactivemongo.api.Collation

val collation = Collation(
  locale = "en-US",
  caseLevel = None,
  caseFirst = None,
  strength = Some(Collation.PrimaryStrength),
  numericOrdering = None,
  alternate = None,
  maxVariable = None,
  backwards = None)
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Collation
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Collation toany2stringadd[Collation] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Collation, B)
    Implicit
    This member is added by an implicit conversion from Collation toArrowAssoc[Collation] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def alternate: Option[Alternate]

    The field that determines whether collation should consider whitespace and punctuation as base characters

    The field that determines whether collation should consider whitespace and punctuation as base characters

    Annotations
    @inline()
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def backwards: Option[Boolean]

    The flag that determines whether strings with diacritics sort from back of the string

    The flag that determines whether strings with diacritics sort from back of the string

    Annotations
    @inline()
  9. def caseFirst: Option[CaseFirst]

    The field that determines sort order of case differences during tertiary level comparisons

    The field that determines sort order of case differences during tertiary level comparisons

    Annotations
    @inline()
  10. def caseLevel: Option[Boolean]

    The flag that determines whether to include case comparison at strength level 1 or 2 (see ICU case level)

    The flag that determines whether to include case comparison at strength level 1 or 2 (see ICU case level)

    Annotations
    @inline()
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  12. def ensuring(cond: (Collation) => Boolean, msg: => Any): Collation
    Implicit
    This member is added by an implicit conversion from Collation toEnsuring[Collation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (Collation) => Boolean): Collation
    Implicit
    This member is added by an implicit conversion from Collation toEnsuring[Collation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: => Any): Collation
    Implicit
    This member is added by an implicit conversion from Collation toEnsuring[Collation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): Collation
    Implicit
    This member is added by an implicit conversion from Collation toEnsuring[Collation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(that: Any): Boolean
    Definition Classes
    Collation → AnyRef → Any
  18. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def hashCode(): Int
    Definition Classes
    Collation → AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def locale: String

    The ICU locale

    Annotations
    @inline()
  23. def maxVariable: Option[MaxVariable]

    The field that determines up to which characters are considered ignorable

    The field that determines up to which characters are considered ignorable

    Annotations
    @inline()
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def normalization: Option[Boolean]

    The flag that determines whether to check if text require normalization and to perform normalization

    The flag that determines whether to check if text require normalization and to perform normalization

    Annotations
    @inline()
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. def numericOrdering: Option[Boolean]

    The flag that determines whether to compare numeric strings as numbers or as strings

    The flag that determines whether to compare numeric strings as numbers or as strings

    Annotations
    @inline()
  29. def strength: Option[Strength]
    Annotations
    @inline()
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    Collation → AnyRef → Any
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Collation toStringFormat[Collation] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def [B](y: B): (Collation, B)
    Implicit
    This member is added by an implicit conversion from Collation toArrowAssoc[Collation] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromCollation to any2stringadd[Collation]

Inherited by implicit conversion StringFormat fromCollation to StringFormat[Collation]

Inherited by implicit conversion Ensuring fromCollation to Ensuring[Collation]

Inherited by implicit conversion ArrowAssoc fromCollation to ArrowAssoc[Collation]

Ungrouped