Normalizer
public
final
class
Normalizer
extends Object
implements
Cloneable
| java.lang.Object | |
| ↳ | android.icu.text.Normalizer |
Old Unicode normalization API.
This API has been replaced by the Normalizer2 class and is only available
for backward compatibility. This class simply delegates to the Normalizer2 class.
There are two exceptions: The new API does not provide a replacement for
QuickCheckResult and compare().
normalize transforms Unicode text into an equivalent composed or
decomposed form, allowing for easier sorting and searching of text.
normalize supports the standard normalization forms described in
Unicode Standard Annex #15 — Unicode Normalization Forms.
Characters with accents or other adornments can be encoded in several different ways in Unicode. For example, take the character A-acute. In Unicode, this can be encoded as a single character (the "composed" form):
00C1 LATIN CAPITAL LETTER A WITH ACUTE
or as two separate characters (the "decomposed" form):
0041 LATIN CAPITAL LETTER A
0301 COMBINING ACUTE ACCENT
To a user of your program, however, both of these sequences should be treated as the same "user-level" character "A with acute accent". When you are searching or comparing text, you must ensure that these two sequences are treated equivalently. In addition, you must handle characters with more than one accent. Sometimes the order of a character's combining accents is significant, while in other cases accent sequences in different orders are really equivalent.
Similarly, the string "ffi" can be encoded as three separate letters:
0066 LATIN SMALL LETTER F
0066 LATIN SMALL LETTER F
0069 LATIN SMALL LETTER I
or as the single character
FB03 LATIN SMALL LIGATURE FFI
The ffi ligature is not a distinct semantic character, and strictly speaking it shouldn't be in Unicode at all, but it was included for compatibility with existing character sets that already provided it. The Unicode standard identifies such characters by giving them "compatibility" decompositions into the corresponding semantic characters. When sorting and searching, you will often want to use these mappings.
normalize helps solve these problems by transforming text into
the canonical composed and decomposed forms as shown in the first example
above. In addition, you can have it perform compatibility decompositions so
that you can treat compatibility characters the same as their equivalents.
Finally, normalize rearranges accents into the proper canonical
order, so that you do not have to worry about accent rearrangement on your
own.
Form FCD, "Fast C or D", is also designed for collation. It allows to work on strings that are not necessarily normalized with an algorithm (like in collation) that works under "canonical closure", i.e., it treats precomposed characters and their decomposed equivalents the same.
It is not a normalization form because it does not provide for uniqueness of representation. Multiple strings may be canonically equivalent (their NFDs are identical) and may all conform to FCD without being identical themselves.
The form is defined such that the "raw decomposition", the recursive canonical decomposition of each character, results in a string that is canonically ordered. This means that precomposed characters are allowed for as long as their decompositions do not need canonical reordering.
Its advantage for a process like collation is that all NFD and most NFC texts - and many unnormalized texts - already conform to FCD and do not need to be normalized (NFD) for such a process. The FCD quick check will return YES for most strings in practice.
normalize(FCD) may be implemented with NFD.
For more details on FCD see Unicode Technical Note #5 (Canonical Equivalence in Applications): http://www.unicode.org/notes/tn5/#FCD
ICU collation performs either NFD or FCD normalization automatically if normalization is turned on for the collator object. Beyond collation and string search, normalized strings may be useful for string equivalence comparisons, transliteration/transcription, unique representations, etc.
The W3C generally recommends to exchange texts in NFC. Note also that most legacy character encodings use only precomposed forms and often do not encode any combining marks by themselves. For conversion to such character encodings the Unicode text needs to be normalized to NFC. For more usage examples, see the Unicode Standard Annex.
Note: The Normalizer class also provides API for iterative normalization. While the setIndex() and getIndex() refer to indices in the underlying Unicode input text, the next() and previous() methods iterate through characters in the normalized output. This means that there is not necessarily a one-to-one correspondence between characters returned by next() and previous() and the indices passed to and returned from setIndex() and getIndex(). It is for this reason that Normalizer does not implement the CharacterIterator interface.
Summary
Nested classes | |
|---|---|
class |
Normalizer.QuickCheckResult
Result values for quickCheck(). |
Constants | |
|---|---|
int |
COMPARE_CODE_POINT_ORDER
Option bit for compare: Compare strings in code point order instead of code unit order. |
int |
COMPARE_IGNORE_CASE
Option bit for compare: Perform case-insensitive comparison. |
int |
FOLD_CASE_DEFAULT
Option bit for compare: Case sensitively compare the strings |
int |
FOLD_CASE_EXCLUDE_SPECIAL_I
Option value for case folding: Use the modified set of mappings provided in CaseFolding.txt to handle dotted I and dotless i appropriately for Turkic languages (tr, az). |
int |
INPUT_IS_FCD
Option bit for compare: Both input strings are assumed to fulfill FCD conditions. |
Fields | |
|---|---|
public
static
final
Normalizer.QuickCheckResult |
MAYBE
Indicates it cannot be determined if string is in the normalized format without further thorough checks. |
public
static
final
Normalizer.QuickCheckResult |
NO
Indicates that string is not in the normalized format |
public
static
final
Normalizer.QuickCheckResult |
YES
Indicates that string is in the normalized format |
Public methods | |
|---|---|
static
int
|
compare(char[] s1, char[] s2, int options)
Compare two strings for canonical equivalence. |
static
int
|
compare(char[] s1, int s1Start, int s1Limit, char[] s2, int s2Start, int s2Limit, int options)
Compare two strings for canonical equivalence. |
static
int
|
compare(int char32a, int char32b, int options)
Convenience method that can have faster implementation by not allocating buffers. |
static
int
|
compare(String s1, String s2, int options)
Compare two strings for canonical equivalence. |
static
int
|
compare(int char32a, String str2, int options)
Convenience method that can have faster implementation by not allocating buffers. |
Inherited methods | |
|---|---|
Constants
COMPARE_CODE_POINT_ORDER
public static final int COMPARE_CODE_POINT_ORDER
Option bit for compare: Compare strings in code point order instead of code unit order.
Constant Value: 32768 (0x00008000)
COMPARE_IGNORE_CASE
public static final int COMPARE_IGNORE_CASE
Option bit for compare: Perform case-insensitive comparison.
Constant Value: 65536 (0x00010000)
FOLD_CASE_DEFAULT
public static final int FOLD_CASE_DEFAULT
Option bit for compare: Case sensitively compare the strings
Constant Value: 0 (0x00000000)
FOLD_CASE_EXCLUDE_SPECIAL_I
public static final int FOLD_CASE_EXCLUDE_SPECIAL_I
Option value for case folding: Use the modified set of mappings provided in CaseFolding.txt to handle dotted I and dotless i appropriately for Turkic languages (tr, az).
See also:
Constant Value: 1 (0x00000001)
INPUT_IS_FCD
public static final int INPUT_IS_FCD
Option bit for compare: Both input strings are assumed to fulfill FCD conditions.
Constant Value: 131072 (0x00020000)
Fields
MAYBE
public static final Normalizer.QuickCheckResult MAYBE
Indicates it cannot be determined if string is in the normalized format without further thorough checks.
NO
public static final Normalizer.QuickCheckResult NO
Indicates that string is not in the normalized format
YES
public static final Normalizer.QuickCheckResult YES
Indicates that string is in the normalized format
Public methods
compare
public static int compare (char[] s1,
char[] s2,
int options)
Compare two strings for canonical equivalence. Further options include case-insensitive comparison and code point order (as opposed to code unit order). Convenience method.
| Parameters | |
|---|---|
s1 |
char: First source string. |
s2 |
char: Second source string. |
options |
int: A bit set of options:
- FOLD_CASE_DEFAULT or 0 is used for default options:
Case-sensitive comparison in code unit order, and the input strings
are quick-checked for FCD.
- INPUT_IS_FCD
Set if the caller knows that both s1 and s2 fulfill the FCD
conditions. If not set, the function will quickCheck for FCD
and normalize if necessary.
- COMPARE_CODE_POINT_ORDER
Set to choose code point order instead of code unit order
- COMPARE_IGNORE_CASE
Set to compare strings case-insensitively using case folding,
instead of case-sensitively.
If set, then the following case folding options are used. |
| Returns | |
|---|---|
int |
<0 or 0 or >0 as usual for string comparisons |
compare
public static int compare (char[] s1,
int s1Start,
int s1Limit,
char[] s2,
int s2Start,
int s2Limit,
int options)
Compare two strings for canonical equivalence. Further options include case-insensitive comparison and code point order (as opposed to code unit order). Canonical equivalence between two strings is defined as their normalized forms (NFD or NFC) being identical. This function compares strings incrementally instead of normalizing (and optionally case-folding) both strings entirely, improving performance significantly. Bulk normalization is only necessary if the strings do not fulfill the FCD conditions. Only in this case, and only if the strings are relatively long, is memory allocated temporarily. For FCD strings and short non-FCD strings there is no memory allocation. Semantically, this is equivalent to strcmp[CodePointOrder](foldCase(NFD(s1)), foldCase(NFD(s2))) where code point order and foldCase are all optional.
| Parameters | |
|---|---|
s1 |
char: First source character array. |
s1Start |
int: start index of source |
s1Limit |
int: limit of the source |
s2 |
char: Second source character array. |
s2Start |
int: start index of the source |
s2Limit |
int: limit of the source |
options |
int: A bit set of options:
- FOLD_CASE_DEFAULT or 0 is used for default options:
Case-sensitive comparison in code unit order, and the input strings
are quick-checked for FCD.
- INPUT_IS_FCD
Set if the caller knows that both s1 and s2 fulfill the FCD
conditions.If not set, the function will quickCheck for FCD
and normalize if necessary.
- COMPARE_CODE_POINT_ORDER
Set to choose code point order instead of code unit order
- COMPARE_IGNORE_CASE
Set to compare strings case-insensitively using case folding,
instead of case-sensitively.
If set, then the following case folding options are used. |
| Returns | |
|---|---|
int |
<0 or 0 or >0 as usual for string comparisons |
compare
public static int compare (int char32a,
int char32b,
int options)
Convenience method that can have faster implementation by not allocating buffers.
| Parameters | |
|---|---|
char32a |
int: the first code point to be checked against the |
char32b |
int: the second code point |
options |
int: A bit set of options |
| Returns | |
|---|---|
int |
|
compare
public static int compare (String s1, String s2, int options)
Compare two strings for canonical equivalence. Further options include case-insensitive comparison and code point order (as opposed to code unit order). Canonical equivalence between two strings is defined as their normalized forms (NFD or NFC) being identical. This function compares strings incrementally instead of normalizing (and optionally case-folding) both strings entirely, improving performance significantly. Bulk normalization is only necessary if the strings do not fulfill the FCD conditions. Only in this case, and only if the strings are relatively long, is memory allocated temporarily. For FCD strings and short non-FCD strings there is no memory allocation. Semantically, this is equivalent to strcmp[CodePointOrder](foldCase(NFD(s1)), foldCase(NFD(s2))) where code point order and foldCase are all optional.
| Parameters | |
|---|---|
s1 |
String: First source string. |
s2 |
String: Second source string. |
options |
int: A bit set of options:
- FOLD_CASE_DEFAULT or 0 is used for default options:
Case-sensitive comparison in code unit order, and the input strings
are quick-checked for FCD.
- INPUT_IS_FCD
Set if the caller knows that both s1 and s2 fulfill the FCD
conditions. If not set, the function will quickCheck for FCD
and normalize if necessary.
- COMPARE_CODE_POINT_ORDER
Set to choose code point order instead of code unit order
- COMPARE_IGNORE_CASE
Set to compare strings case-insensitively using case folding,
instead of case-sensitively.
If set, then the following case folding options are used. |
| Returns | |
|---|---|
int |
<0 or 0 or >0 as usual for string comparisons |
compare
public static int compare (int char32a,
String str2,
int options)
Convenience method that can have faster implementation by not allocating buffers.
| Parameters | |
|---|---|
char32a |
int: the first code point to be checked against |
str2 |
String: the second string |
options |
int: A bit set of options |
| Returns | |
|---|---|
int |
|
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-04-04 UTC.