com.couchbase.lite

Class Collation.Unicode

java.lang.Object

com.couchbase.lite.Collation

com.couchbase.lite.Collation.Unicode

Enclosing class:

Collation

public static final class Collation.Unicode
extends Collation

Unicode Collation that will compare two strings by using Unicode collation algorithm. If the locale is not specified, the collation is Unicode-aware but not localized; for example, accented Roman letters sort right after the base letter

Nested Class Summary

Nested classes/interfaces inherited from class com.couchbase.lite.Collation

Collation.ASCII, Collation.Unicode

Method Summary

Modifier and Type	Method and Description
Collation.Unicode	ignoreAccents(boolean ignoreAccents) Specifies whether the collation ignore the accents or diacritics when comparing the strings or not.
Collation.Unicode	ignoreCase(boolean ignoreCase) Specifies whether the collation is case-insensitive or not.
Collation.Unicode	locale(String locale) Specifies the locale to allow the collation to compare strings appropriately base on the locale.

Methods inherited from class com.couchbase.lite.Collation

ascii, toString, unicode

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

ignoreCase

@NonNull
public Collation.Unicode ignoreCase(boolean ignoreCase)

Specifies whether the collation is case-insensitive or not. Case-insensitive collation will treat ASCII uppercase and lowercase letters as equivalent.

Parameters:

ignoreCase - True for case-insensitive; false for case-sensitive.

Returns:

The Unicode Collation object.

ignoreAccents

@NonNull
public Collation.Unicode ignoreAccents(boolean ignoreAccents)

Specifies whether the collation ignore the accents or diacritics when comparing the strings or not.

Parameters:

ignoreAccents - True for accent-insensitive; false for accent-sensitive.

Returns:

The Unicode Collation object.

locale

@NonNull
public Collation.Unicode locale(String locale)

Specifies the locale to allow the collation to compare strings appropriately base on the locale.

Parameters:

locale - The locale code which is an [ISO-639](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code plus, optionally, an underscore and an [ISO-3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code: "en", "en_US", "fr_CA", etc. Specifying the locale will allow the collation to compare strings appropriately base on the locale.

Returns:

this