Package com.mongodb.client.model

Class Collation.Builder

java.lang.Object

com.mongodb.client.model.Collation.Builder

Enclosing class:

Collation

@NotThreadSafe
public static final class Collation.Builder
extends Object

A Collation builder.

Method Summary

Modifier and Type	Method	Description
Collation.Builder	backwards(Boolean backwards)	Sets the backwards value
Collation	build()	Creates a new Collation object with the settings initialised on this builder.
Collation.Builder	caseLevel(Boolean caseLevel)	Sets the case level value
Collation.Builder	collationAlternate(CollationAlternate alternate)	Sets the alternate
Collation.Builder	collationCaseFirst(CollationCaseFirst caseFirst)	Sets the collation case first value
Collation.Builder	collationMaxVariable(CollationMaxVariable maxVariable)	Sets the maxVariable
Collation.Builder	collationStrength(CollationStrength strength)	Sets the collation strength
Collation.Builder	locale(String locale)	Sets the locale
Collation.Builder	normalization(Boolean normalization)	Sets the normalization value
Collation.Builder	numericOrdering(Boolean numericOrdering)	Sets the numeric ordering

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

locale

public Collation.Builder locale(@Nullable
                                String locale)

Sets the locale

Parameters:

locale - the locale

Returns:

this

See Also:

ICU User Guide - Locale

caseLevel

public Collation.Builder caseLevel(@Nullable
                                   Boolean caseLevel)

Sets the case level value

Turns on case sensitivity

Parameters:

caseLevel - the case level value

Returns:

this

collationCaseFirst

public Collation.Builder collationCaseFirst(@Nullable
                                            CollationCaseFirst caseFirst)

Sets the collation case first value

Determines if Uppercase or lowercase values should come first

Parameters:

caseFirst - the collation case first value

Returns:

this

collationStrength

public Collation.Builder collationStrength(@Nullable
                                           CollationStrength strength)

Sets the collation strength

Parameters:

strength - the strength

Returns:

this

numericOrdering

public Collation.Builder numericOrdering(@Nullable
                                         Boolean numericOrdering)

Sets the numeric ordering

Parameters:

numericOrdering - if true will order numbers based on numerical order and not collation order

Returns:

this

collationAlternate

public Collation.Builder collationAlternate(@Nullable
                                            CollationAlternate alternate)

Sets the alternate

Controls whether spaces and punctuation are considered base characters

Parameters:

alternate - the alternate

Returns:

this

collationMaxVariable

public Collation.Builder collationMaxVariable(@Nullable
                                              CollationMaxVariable maxVariable)

Sets the maxVariable

Parameters:

maxVariable - the maxVariable

Returns:

this

normalization

public Collation.Builder normalization(@Nullable
                                       Boolean normalization)

Sets the normalization value

If true, normalizes text into Unicode NFD.

Parameters:

normalization - the normalization value

Returns:

this

backwards

public Collation.Builder backwards(@Nullable
                                   Boolean backwards)

Sets the backwards value

Causes secondary differences to be considered in reverse order, as it is done in the French language

Parameters:

backwards - the backwards value

Returns:

this

build

public Collation build()

Creates a new Collation object with the settings initialised on this builder.

Returns:

a new Collation object