Collation

reactivemongo.api.Collation
See theCollation companion object
final class Collation

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)

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

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

Attributes

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

Attributes

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

Attributes

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)

Attributes

override def equals(that: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Attributes

that

the object to compare against this object for equality.

Returns:

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
override def hashCode: Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns:

the hash code value for this object.

Definition Classes
Any

Attributes

The field that determines up to which characters are considered ignorable

The field that determines up to which characters are considered ignorable

Attributes

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

Attributes

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

Attributes

override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns:

a string representation of the object.

Definition Classes
Any