Package com.ibm.icu.text

Class Normalizer

  • All Implemented Interfaces:
    Cloneable
    public final class Normalizer
extends Object
implements Cloneable
    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.

    Status:
    Stable ICU 2.8.

    • Constructor Detail

      • Normalizer

        @Deprecated
public Normalizer​(String str,
                  Normalizer.Mode mode,
                  int opt)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Creates a new Normalizer object for iterating over the normalized form of a given string.

        The options parameter specifies which optional Normalizer features are to be enabled for this object.

        Parameters:
        str - The string to be normalized. The normalization will start at the beginning of the string.
        mode - The normalization mode.
        opt - Any optional features to be enabled. Currently the only available option is UNICODE_3_2. If you want the default behavior corresponding to one of the standard Unicode Normalization Forms, use 0 for this argument.

      • Normalizer

        @Deprecated
public Normalizer​(CharacterIterator iter,
                  Normalizer.Mode mode,
                  int opt)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Creates a new Normalizer object for iterating over the normalized form of the given text.

        Parameters:
        iter - The input text to be normalized. The normalization will start at the beginning of the string.
        mode - The normalization mode.
        opt - Any optional features to be enabled. Currently the only available option is UNICODE_3_2. If you want the default behavior corresponding to one of the standard Unicode Normalization Forms, use 0 for this argument.

      • Normalizer

        @Deprecated
public Normalizer​(UCharacterIterator iter,
                  Normalizer.Mode mode,
                  int options)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Creates a new Normalizer object for iterating over the normalized form of the given text.

        Parameters:
        iter - The input text to be normalized. The normalization will start at the beginning of the string.
        mode - The normalization mode.
        options - The normalization options, ORed together (0 for no options).

    • Method Detail

      • clone

        @Deprecated
public Normalizer clone()
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Clones this Normalizer object. All properties of this object are duplicated in the new object, including the cloning of any CharacterIterator that was passed in to the constructor or to setText. However, the text storage underlying the CharacterIterator is not duplicated unless the iterator's clone method does so.
        Overrides:
        clone in class Object

      • compose

        @Deprecated
public static String compose​(String str,
                             boolean compat)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Compose a string. The string will be composed to according to the specified mode.
        Parameters:
        str - The string to compose.
        compat - If true the string will be composed according to NFKC rules and if false will be composed according to NFC rules.
        Returns:
        String The composed string

      • compose

        @Deprecated
public static String compose​(String str,
                             boolean compat,
                             int options)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Compose a string. The string will be composed to according to the specified mode.
        Parameters:
        str - The string to compose.
        compat - If true the string will be composed according to NFKC rules and if false will be composed according to NFC rules.
        options - The only recognized option is UNICODE_3_2
        Returns:
        String The composed string

      • compose

        @Deprecated
public static int compose​(char[] source,
                          char[] target,
                          boolean compat,
                          int options)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Compose a string. The string will be composed to according to the specified mode.
        Parameters:
        source - The char array to compose.
        target - A char buffer to receive the normalized text.
        compat - If true the char array will be composed according to NFKC rules and if false will be composed according to NFC rules.
        options - The normalization options, ORed together (0 for no options).
        Returns:
        int The total buffer size needed;if greater than length of result, the output was truncated.
        Throws:
        IndexOutOfBoundsException - if target.length is less than the required length

      • compose

        @Deprecated
public static int compose​(char[] src,
                          int srcStart,
                          int srcLimit,
                          char[] dest,
                          int destStart,
                          int destLimit,
                          boolean compat,
                          int options)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Compose a string. The string will be composed to according to the specified mode.
        Parameters:
        src - The char array to compose.
        srcStart - Start index of the source
        srcLimit - Limit index of the source
        dest - The char buffer to fill in
        destStart - Start index of the destination buffer
        destLimit - End index of the destination buffer
        compat - If true the char array will be composed according to NFKC rules and if false will be composed according to NFC rules.
        options - The normalization options, ORed together (0 for no options).
        Returns:
        int The total buffer size needed;if greater than length of result, the output was truncated.
        Throws:
        IndexOutOfBoundsException - if target.length is less than the required length

      • decompose

        @Deprecated
public static String decompose​(String str,
                               boolean compat)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Decompose a string. The string will be decomposed to according to the specified mode.
        Parameters:
        str - The string to decompose.
        compat - If true the string will be decomposed according to NFKD rules and if false will be decomposed according to NFD rules.
        Returns:
        String The decomposed string

      • decompose

        @Deprecated
public static String decompose​(String str,
                               boolean compat,
                               int options)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Decompose a string. The string will be decomposed to according to the specified mode.
        Parameters:
        str - The string to decompose.
        compat - If true the string will be decomposed according to NFKD rules and if false will be decomposed according to NFD rules.
        options - The normalization options, ORed together (0 for no options).
        Returns:
        String The decomposed string

      • decompose

        @Deprecated
public static int decompose​(char[] source,
                            char[] target,
                            boolean compat,
                            int options)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Decompose a string. The string will be decomposed to according to the specified mode.
        Parameters:
        source - The char array to decompose.
        target - A char buffer to receive the normalized text.
        compat - If true the char array will be decomposed according to NFKD rules and if false will be decomposed according to NFD rules.
        options - The normalization options, ORed together (0 for no options).
        Returns:
        int The total buffer size needed;if greater than length of result,the output was truncated.
        Throws:
        IndexOutOfBoundsException - if the target capacity is less than the required length

      • decompose

        @Deprecated
public static int decompose​(char[] src,
                            int srcStart,
                            int srcLimit,
                            char[] dest,
                            int destStart,
                            int destLimit,
                            boolean compat,
                            int options)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Decompose a string. The string will be decomposed to according to the specified mode.
        Parameters:
        src - The char array to compose.
        srcStart - Start index of the source
        srcLimit - Limit index of the source
        dest - The char buffer to fill in
        destStart - Start index of the destination buffer
        destLimit - End index of the destination buffer
        compat - If true the char array will be decomposed according to NFKD rules and if false will be decomposed according to NFD rules.
        options - The normalization options, ORed together (0 for no options).
        Returns:
        int The total buffer size needed;if greater than length of result,the output was truncated.
        Throws:
        IndexOutOfBoundsException - if the target capacity is less than the required length

      • normalize

        @Deprecated
public static String normalize​(String str,
                               Normalizer.Mode mode,
                               int options)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Normalizes a String using the given normalization operation.

        The options parameter specifies which optional Normalizer features are to be enabled for this operation. Currently the only available option is UNICODE_3_2. If you want the default behavior corresponding to one of the standard Unicode Normalization Forms, use 0 for this argument.

        Parameters:
        str - the input string to be normalized.
        mode - the normalization mode
        options - the optional features to be enabled.
        Returns:
        String the normalized string

      • normalize

        @Deprecated
public static String normalize​(String src,
                               Normalizer.Mode mode)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Normalize a string. The string will be normalized according to the specified normalization mode and options.
        Parameters:
        src - The string to normalize.
        mode - The normalization mode; one of Normalizer.NONE, Normalizer.NFD, Normalizer.NFC, Normalizer.NFKC, Normalizer.NFKD, Normalizer.DEFAULT
        Returns:
        the normalized string

      • normalize

        @Deprecated
public static int normalize​(char[] source,
                            char[] target,
                            Normalizer.Mode mode,
                            int options)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Normalize a string. The string will be normalized according to the specified normalization mode and options.
        Parameters:
        source - The char array to normalize.
        target - A char buffer to receive the normalized text.
        mode - The normalization mode; one of Normalizer.NONE, Normalizer.NFD, Normalizer.NFC, Normalizer.NFKC, Normalizer.NFKD, Normalizer.DEFAULT
        options - The normalization options, ORed together (0 for no options).
        Returns:
        int The total buffer size needed;if greater than length of result, the output was truncated.
        Throws:
        IndexOutOfBoundsException - if the target capacity is less than the required length

      • normalize

        @Deprecated
public static int normalize​(char[] src,
                            int srcStart,
                            int srcLimit,
                            char[] dest,
                            int destStart,
                            int destLimit,
                            Normalizer.Mode mode,
                            int options)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Normalize a string. The string will be normalized according to the specified normalization mode and options.
        Parameters:
        src - The char array to compose.
        srcStart - Start index of the source
        srcLimit - Limit index of the source
        dest - The char buffer to fill in
        destStart - Start index of the destination buffer
        destLimit - End index of the destination buffer
        mode - The normalization mode; one of Normalizer.NONE, Normalizer.NFD, Normalizer.NFC, Normalizer.NFKC, Normalizer.NFKD, Normalizer.DEFAULT
        options - The normalization options, ORed together (0 for no options).
        Returns:
        int The total buffer size needed;if greater than length of result, the output was truncated.
        Throws:
        IndexOutOfBoundsException - if the target capacity is less than the required length

      • normalize

        @Deprecated
public static String normalize​(int char32,
                               Normalizer.Mode mode,
                               int options)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Normalize a codepoint according to the given mode
        Parameters:
        char32 - The input string to be normalized.
        mode - The normalization mode
        options - Options for use with exclusion set and tailored Normalization The only option that is currently recognized is UNICODE_3_2
        Returns:
        String The normalized string
        See Also:
        UNICODE_3_2

      • normalize

        @Deprecated
public static String normalize​(int char32,
                               Normalizer.Mode mode)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Convenience method to normalize a codepoint according to the given mode
        Parameters:
        char32 - The input string to be normalized.
        mode - The normalization mode
        Returns:
        String The normalized string

      • quickCheck

        @Deprecated
public static Normalizer.QuickCheckResult quickCheck​(String source,
                                                     Normalizer.Mode mode)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Convenience method.
        Parameters:
        source - string for determining if it is in a normalized format
        mode - normalization format (Normalizer.NFC,Normalizer.NFD, Normalizer.NFKC,Normalizer.NFKD)
        Returns:
        Return code to specify if the text is normalized or not (Normalizer.YES, Normalizer.NO or Normalizer.MAYBE)

      • quickCheck

        @Deprecated
public static Normalizer.QuickCheckResult quickCheck​(String source,
                                                     Normalizer.Mode mode,
                                                     int options)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Performing quick check on a string, to quickly determine if the string is in a particular normalization format. Three types of result can be returned Normalizer.YES, Normalizer.NO or Normalizer.MAYBE. Result Normalizer.YES indicates that the argument string is in the desired normalized format, Normalizer.NO determines that argument string is not in the desired normalized format. A Normalizer.MAYBE result indicates that a more thorough check is required, the user may have to put the string in its normalized form and compare the results.
        Parameters:
        source - string for determining if it is in a normalized format
        mode - normalization format (Normalizer.NFC,Normalizer.NFD, Normalizer.NFKC,Normalizer.NFKD)
        options - Options for use with exclusion set and tailored Normalization The only option that is currently recognized is UNICODE_3_2
        Returns:
        Return code to specify if the text is normalized or not (Normalizer.YES, Normalizer.NO or Normalizer.MAYBE)

      • quickCheck

        @Deprecated
public static Normalizer.QuickCheckResult quickCheck​(char[] source,
                                                     Normalizer.Mode mode,
                                                     int options)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Convenience method.
        Parameters:
        source - Array of characters for determining if it is in a normalized format
        mode - normalization format (Normalizer.NFC,Normalizer.NFD, Normalizer.NFKC,Normalizer.NFKD)
        options - Options for use with exclusion set and tailored Normalization The only option that is currently recognized is UNICODE_3_2
        Returns:
        Return code to specify if the text is normalized or not (Normalizer.YES, Normalizer.NO or Normalizer.MAYBE)

      • quickCheck

        @Deprecated
public static Normalizer.QuickCheckResult quickCheck​(char[] source,
                                                     int start,
                                                     int limit,
                                                     Normalizer.Mode mode,
                                                     int options)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Performing quick check on a string, to quickly determine if the string is in a particular normalization format. Three types of result can be returned Normalizer.YES, Normalizer.NO or Normalizer.MAYBE. Result Normalizer.YES indicates that the argument string is in the desired normalized format, Normalizer.NO determines that argument string is not in the desired normalized format. A Normalizer.MAYBE result indicates that a more thorough check is required, the user may have to put the string in its normalized form and compare the results.
        Parameters:
        source - string for determining if it is in a normalized format
        start - the start index of the source
        limit - the limit index of the source it is equal to the length
        mode - normalization format (Normalizer.NFC,Normalizer.NFD, Normalizer.NFKC,Normalizer.NFKD)
        options - Options for use with exclusion set and tailored Normalization The only option that is currently recognized is UNICODE_3_2
        Returns:
        Return code to specify if the text is normalized or not (Normalizer.YES, Normalizer.NO or Normalizer.MAYBE)

      • isNormalized

        @Deprecated
public static boolean isNormalized​(char[] src,
                                   int start,
                                   int limit,
                                   Normalizer.Mode mode,
                                   int options)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Test if a string is in a given normalization form. This is semantically equivalent to source.equals(normalize(source, mode)). Unlike quickCheck(), this function returns a definitive result, never a "maybe". For NFD, NFKD, and FCD, both functions work exactly the same. For NFC and NFKC where quickCheck may return "maybe", this function will perform further tests to arrive at a true/false result.
        Parameters:
        src - The input array of characters to be checked to see if it is normalized
        start - The strart index in the source
        limit - The limit index in the source
        mode - the normalization mode
        options - Options for use with exclusion set and tailored Normalization The only option that is currently recognized is UNICODE_3_2
        Returns:
        Boolean value indicating whether the source string is in the "mode" normalization form

      • isNormalized

        @Deprecated
public static boolean isNormalized​(String str,
                                   Normalizer.Mode mode,
                                   int options)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Test if a string is in a given normalization form. This is semantically equivalent to source.equals(normalize(source, mode)). Unlike quickCheck(), this function returns a definitive result, never a "maybe". For NFD, NFKD, and FCD, both functions work exactly the same. For NFC and NFKC where quickCheck may return "maybe", this function will perform further tests to arrive at a true/false result.
        Parameters:
        str - the input string to be checked to see if it is normalized
        mode - the normalization mode
        options - Options for use with exclusion set and tailored Normalization The only option that is currently recognized is UNICODE_3_2
        See Also:
        isNormalized(char[], int, int, com.ibm.icu.text.Normalizer.Mode, int)

      • 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 - First source character array.
        s1Start - start index of source
        s1Limit - limit of the source
        s2 - Second source character array.
        s2Start - start index of the source
        s2Limit - limit of the source
        options - 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:
        <0 or 0 or >0 as usual for string comparisons
        See Also:
        normalize(java.lang.String, com.ibm.icu.text.Normalizer.Mode, int), FCD
        Status:
        Stable ICU 2.8.

      • 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 - First source string.
        s2 - Second source string.
        options - 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:
        <0 or 0 or >0 as usual for string comparisons
        See Also:
        normalize(java.lang.String, com.ibm.icu.text.Normalizer.Mode, int), FCD
        Status:
        Stable ICU 2.8.

      • 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 - First source string.
        s2 - Second source string.
        options - 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:
        <0 or 0 or >0 as usual for string comparisons
        See Also:
        normalize(java.lang.String, com.ibm.icu.text.Normalizer.Mode, int), FCD
        Status:
        Stable ICU 2.8.

      • compare

        public static int compare​(int char32a,
                          int char32b,
                          int options)
        Convenience method that can have faster implementation by not allocating buffers.
        Parameters:
        char32a - the first code point to be checked against the
        char32b - the second code point
        options - A bit set of options
        Status:
        Stable ICU 2.8.

      • compare

        public static int compare​(int char32a,
                          String str2,
                          int options)
        Convenience method that can have faster implementation by not allocating buffers.
        Parameters:
        char32a - the first code point to be checked against
        str2 - the second string
        options - A bit set of options
        Status:
        Stable ICU 2.8.

      • concatenate

        @Deprecated
public static int concatenate​(char[] left,
                              int leftStart,
                              int leftLimit,
                              char[] right,
                              int rightStart,
                              int rightLimit,
                              char[] dest,
                              int destStart,
                              int destLimit,
                              Normalizer.Mode mode,
                              int options)
        Deprecated.
        ICU 56 Use Normalizer2 instead.
        Concatenate normalized strings, making sure that the result is normalized as well. If both the left and the right strings are in the normalization form according to "mode", then the result will be dest=normalize(left+right, mode) With the input strings already being normalized, this function will use next() and previous() to find the adjacent end pieces of the input strings. Only the concatenation of these end pieces will be normalized and then concatenated with the remaining parts of the input strings. It is allowed to have dest==left to avoid copying the entire left string.
        Parameters:
        left - Left source array, may be same as dest.
        leftStart - start in the left array.
        leftLimit - limit in the left array (==length)
        right - Right source array.
        rightStart - start in the right array.
        rightLimit - limit in the right array (==length)
        dest - The output buffer; can be null if destStart==destLimit==0 for pure preflighting.
        destStart - start in the destination array
        destLimit - limit in the destination array (==length)
        mode - The normalization mode.
        options - The normalization options, ORed together (0 for no options).
        Returns:
        Length of output (number of chars) when successful or IndexOutOfBoundsException
        Throws:
        IndexOutOfBoundsException - whose message has the string representation of destination capacity required.
        IndexOutOfBoundsException - if target capacity is less than the required length
        See Also:
        normalize(java.lang.String, com.ibm.icu.text.Normalizer.Mode, int), next(), previous()

      • getFC_NFKC_Closure

        @Deprecated
public static int getFC_NFKC_Closure​(int c,
                                     char[] dest)
        Deprecated.
        ICU 56
        Gets the FC_NFKC closure value.
        Parameters:
        c - The code point whose closure value is to be retrieved
        dest - The char array to receive the closure value
        Returns:
        the length of the closure value; 0 if there is none

      • getFC_NFKC_Closure

        @Deprecated
public static String getFC_NFKC_Closure​(int c)
        Deprecated.
        ICU 56
        Gets the FC_NFKC closure value.
        Parameters:
        c - The code point whose closure value is to be retrieved
        Returns:
        String representation of the closure value; "" if there is none

      • current

        @Deprecated
public int current()
        Deprecated.
        ICU 56
        Return the current character in the normalized text.
        Returns:
        The codepoint as an int

      • next

        @Deprecated
public int next()
        Deprecated.
        ICU 56
        Return the next character in the normalized text and advance the iteration position by one. If the end of the text has already been reached, DONE is returned.
        Returns:
        The codepoint as an int

      • previous

        @Deprecated
public int previous()
        Deprecated.
        ICU 56
        Return the previous character in the normalized text and decrement the iteration position by one. If the beginning of the text has already been reached, DONE is returned.
        Returns:
        The codepoint as an int

      • reset

        @Deprecated
public void reset()
        Deprecated.
        ICU 56
        Reset the index to the beginning of the text. This is equivalent to setIndexOnly(startIndex)).

      • setIndexOnly

        @Deprecated
public void setIndexOnly​(int index)
        Deprecated.
        ICU 56
        Set the iteration position in the input text that is being normalized, without any immediate normalization. After setIndexOnly(), getIndex() will return the same index that is specified here.
        Parameters:
        index - the desired index in the input text.

      • setIndex

        @Deprecated
public int setIndex​(int index)
        Deprecated.
        ICU 3.2
        Set the iteration position in the input text that is being normalized and return the first normalized character at that position.

        Note: This method sets the position in the input text, while next() and previous() 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().

        Parameters:
        index - the desired index in the input text.
        Returns:
        the first normalized character that is the result of iterating forward starting at the given index.
        Throws:
        IllegalArgumentException - if the given index is less than getBeginIndex() or greater than getEndIndex().
        Status:
        Obsolete. Will be removed in ICU 3.2.

      • getBeginIndex

        @Deprecated
public int getBeginIndex()
        Deprecated.
        ICU 2.2. Use startIndex() instead.
        Retrieve the index of the start of the input text. This is the begin index of the CharacterIterator or the start (i.e. 0) of the String over which this Normalizer is iterating
        Returns:
        The codepoint as an int
        See Also:
        startIndex()

      • getEndIndex

        @Deprecated
public int getEndIndex()
        Deprecated.
        ICU 2.2. Use endIndex() instead.
        Retrieve the index of the end of the input text. This is the end index of the CharacterIterator or the length of the String over which this Normalizer is iterating
        Returns:
        The codepoint as an int
        See Also:
        endIndex()

      • first

        @Deprecated
public int first()
        Deprecated.
        ICU 56
        Return the first character in the normalized text. This resets the Normalizer's position to the beginning of the text.
        Returns:
        The codepoint as an int

      • last

        @Deprecated
public int last()
        Deprecated.
        ICU 56
        Return the last character in the normalized text. This resets the Normalizer's position to be just before the the input text corresponding to that normalized character.
        Returns:
        The codepoint as an int

      • getIndex

        @Deprecated
public int getIndex()
        Deprecated.
        ICU 56
        Retrieve the current iteration position in the input text that is being normalized. This method is useful in applications such as searching, where you need to be able to determine the position in the input text that corresponds to a given normalized output character.

        Note: This method sets the position in the input, while next() and previous() iterate through characters in the 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().

        Returns:
        The current iteration position

      • startIndex

        @Deprecated
public int startIndex()
        Deprecated.
        ICU 56
        Retrieve the index of the start of the input text. This is the begin index of the CharacterIterator or the start (i.e. 0) of the String over which this Normalizer is iterating
        Returns:
        The current iteration position

      • endIndex

        @Deprecated
public int endIndex()
        Deprecated.
        ICU 56
        Retrieve the index of the end of the input text. This is the end index of the CharacterIterator or the length of the String over which this Normalizer is iterating
        Returns:
        The current iteration position

      • setMode

        @Deprecated
public void setMode​(Normalizer.Mode newMode)
        Deprecated.
        ICU 56
        Set the normalization mode for this object.

        Note:If the normalization mode is changed while iterating over a string, calls to next() and previous() may return previously buffers characters in the old normalization mode until the iteration is able to re-sync at the next base character. It is safest to call setText(), first(), last(), etc. after calling setMode.

        Parameters:
        newMode - the new mode for this Normalizer. The supported modes are:
        • NFC - Unicode canonical decompositiion followed by canonical composition.
        • NFKC - Unicode compatibility decompositiion followed by canonical composition.
        • NFD - Unicode canonical decomposition
        • NFKD - Unicode compatibility decomposition.
        • NONE - Do nothing but return characters from the underlying input text.
        See Also:
        getMode()

      • setOption

        @Deprecated
public void setOption​(int option,
                      boolean value)
        Deprecated.
        ICU 56
        Set options that affect this Normalizer's operation. Options do not change the basic composition or decomposition operation that is being performed , but they control whether certain optional portions of the operation are done. Currently the only available option is:
        • UNICODE_3_2 - Use Normalization conforming to Unicode version 3.2.
        Parameters:
        option - the option whose value is to be set.
        value - the new setting for the option. Use true to turn the option on and false to turn it off.
        See Also:
        getOption(int)

      • getText

        @Deprecated
public int getText​(char[] fillIn)
        Deprecated.
        ICU 56
        Gets the underlying text storage
        Parameters:
        fillIn - the char buffer to fill the UTF-16 units. The length of the buffer should be equal to the length of the underlying text storage
        Throws:
        IndexOutOfBoundsException - If the index passed for the array is invalid.
        See Also:
        getLength()

      • getLength

        @Deprecated
public int getLength()
        Deprecated.
        ICU 56
        Gets the length of underlying text storage
        Returns:
        the length

      • getText

        @Deprecated
public String getText()
        Deprecated.
        ICU 56
        Returns the text under iteration as a string
        Returns:
        a copy of the text under iteration.

      • setText

        @Deprecated
public void setText​(StringBuffer newText)
        Deprecated.
        ICU 56
        Set the input text over which this Normalizer will iterate. The iteration position is set to the beginning of the input text.
        Parameters:
        newText - The new string to be normalized.

      • setText

        @Deprecated
public void setText​(char[] newText)
        Deprecated.
        ICU 56
        Set the input text over which this Normalizer will iterate. The iteration position is set to the beginning of the input text.
        Parameters:
        newText - The new string to be normalized.

      • setText

        @Deprecated
public void setText​(String newText)
        Deprecated.
        ICU 56
        Set the input text over which this Normalizer will iterate. The iteration position is set to the beginning of the input text.
        Parameters:
        newText - The new string to be normalized.

      • setText

        @Deprecated
public void setText​(CharacterIterator newText)
        Deprecated.
        ICU 56
        Set the input text over which this Normalizer will iterate. The iteration position is set to the beginning of the input text.
        Parameters:
        newText - The new string to be normalized.

      • setText

        @Deprecated
public void setText​(UCharacterIterator newText)
        Deprecated.
        ICU 56
        Set the input text over which this Normalizer will iterate. The iteration position is set to the beginning of the string.
        Parameters:
        newText - The new string to be normalized.