Package com.mongodb.client.model

Class Collation

java.lang.Object

com.mongodb.client.model.Collation

public final class Collation
extends Object

The options regarding collation support in MongoDB 3.4+

Since:

3.4

MongoDB documentation

Create Collection

Index options

Since server release

3.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Collation.Builder	A Collation builder.

Method Summary

Modifier and Type	Method	Description
BsonDocument	asDocument()	Gets this collation options as a document.
static Collation.Builder	builder()	Convenience method to create a Builder.
static Collation.Builder	builder(Collation options)	Convenience method to create a from an existing Collation.
boolean	equals(Object o)
CollationAlternate	getAlternate()	Returns the collation alternate
Boolean	getBackwards()	Returns the backwards value
CollationCaseFirst	getCaseFirst()	Returns the collation case first value
Boolean	getCaseLevel()	Returns the case level value
String	getLocale()	Returns the locale
CollationMaxVariable	getMaxVariable()	Returns the maxVariable
Boolean	getNormalization()	Returns the normalization value
Boolean	getNumericOrdering()	Returns the numeric ordering, if true will order numbers based on numerical order and not collation order.
CollationStrength	getStrength()	Returns the collation strength
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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 String getLocale()

Returns the locale

Returns:

the locale

See Also:

ICU User Guide - Locale

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

getAlternate

@Nullable
public CollationAlternate getAlternate()

Returns the collation alternate

Returns:

the alternate

getMaxVariable

@Nullable
public CollationMaxVariable getMaxVariable()

Returns the maxVariable

Controls which characters are affected by collection alternate CollationAlternate.SHIFTED.

Returns:

the maxVariable

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object