Added in API level 24

UCharacter


class UCharacter : UCharacterEnums.ECharacterCategory, UCharacterEnums.ECharacterDirection
kotlin.Any
   ↳ android.icu.lang.UCharacter

[icu enhancement] ICU's replacement for java.lang.Character. Methods, fields, and other functionality specific to ICU are labeled '[icu]'.

The UCharacter class provides extensions to the java.lang.Character class. These extensions provide support for more Unicode properties. Each ICU release supports the latest version of Unicode available at that time.

For some time before Java 5 added support for supplementary Unicode code points, The ICU UCharacter class and many other ICU classes already supported them. Some UCharacter methods and constants were widened slightly differently than how the Character class methods and constants were widened later. In particular, Character#MAX_VALUE is still a char with the value U+FFFF, while the UCharacter#MAX_VALUE is an int with the value U+10FFFF.

Code points are represented in these API using ints. While it would be more convenient in Java to have a separate primitive datatype for them, ints suffice in the meantime.

Aside from the additions for UTF-16 support, and the updated Unicode properties, the main differences between UCharacter and Character are:

  • UCharacter is not designed to be a char wrapper and does not have APIs to which involves management of that single char.
    These include:
    • char charValue(),
    • int compareTo(java.lang.Character, java.lang.Character), etc.
  • UCharacter does not include Character APIs that are deprecated, nor does it include the Java-specific character information, such as boolean isJavaIdentifierPart(char ch).
  • Character maps characters 'A' - 'Z' and 'a' - 'z' to the numeric values '10' - '35'. UCharacter also does this in digit and getNumericValue, to adhere to the java semantics of these methods. New methods unicodeDigit, and getUnicodeNumericValue do not treat the above code points as having numeric values. This is a semantic change from ICU4J 1.3.1.

In addition to Java compatibility functions, which calculate derived properties, this API provides low-level access to the Unicode Character Database.

Unicode assigns each code point (not just assigned character) values for many properties. Most of them are simple boolean flags, or constants from a small enumerated list. For some properties, values are strings or other relatively more complex types.

For more information see "About the Unicode Character Database" (http://www.unicode.org/ucd/) and the ICU User Guide chapter on Properties (https://unicode-org.github.io/icu/userguide/strings/properties).

There are also functions that provide easy migration from C/POSIX functions like isblank(). Their use is generally discouraged because the C/POSIX standards do not define their semantics beyond the ASCII range, which means that different implementations exhibit very different behavior. Instead, Unicode properties should be used directly.

There are also only a few, broad C/POSIX character classes, and they tend to be used for conflicting purposes. For example, the "isalpha()" class is sometimes used to determine word boundaries, while a more sophisticated approach would at least distinguish initial letters from continuation characters (the latter including combining marks). (In ICU, BreakIterator is the most sophisticated API for word boundaries.) Another example: There is no "istitle()" class for titlecase characters.

ICU 3.4 and later provides API access for all twelve C/POSIX character classes. ICU implements them according to the Standard Recommendations in Annex C: Compatibility Properties of UTS #18 Unicode Regular Expressions (http://www.unicode.org/reports/tr18/#Compatibility_Properties).

API access for C/POSIX character classes is as follows:

<code>- alpha:     isUAlphabetic(c) or hasBinaryProperty(c, UProperty.ALPHABETIC)
  - lower:     isULowercase(c) or hasBinaryProperty(c, UProperty.LOWERCASE)
  - upper:     isUUppercase(c) or hasBinaryProperty(c, UProperty.UPPERCASE)
  - punct:     ((1&lt;&lt;getType(c)) &amp; ((1&lt;&lt;DASH_PUNCTUATION)|(1&lt;&lt;START_PUNCTUATION)|
                (1&lt;&lt;END_PUNCTUATION)|(1&lt;&lt;CONNECTOR_PUNCTUATION)|(1&lt;&lt;OTHER_PUNCTUATION)|
                (1&lt;&lt;INITIAL_PUNCTUATION)|(1&lt;&lt;FINAL_PUNCTUATION)))!=0
  - digit:     isDigit(c) or getType(c)==DECIMAL_DIGIT_NUMBER
  - xdigit:    hasBinaryProperty(c, UProperty.POSIX_XDIGIT)
  - alnum:     hasBinaryProperty(c, UProperty.POSIX_ALNUM)
  - space:     isUWhiteSpace(c) or hasBinaryProperty(c, UProperty.WHITE_SPACE)
  - blank:     hasBinaryProperty(c, UProperty.POSIX_BLANK)
  - cntrl:     getType(c)==CONTROL
  - graph:     hasBinaryProperty(c, UProperty.POSIX_GRAPH)
  - print:     hasBinaryProperty(c, UProperty.POSIX_PRINT)</code>

The C/POSIX character classes are also available in UnicodeSet patterns, using patterns like [:graph:] or \p{graph}.

[icu] Note: There are several ICU (and Java) whitespace functions. Comparison:

  • isUWhiteSpace=UCHAR_WHITE_SPACE: Unicode White_Space property; most of general categories "Z" (separators) + most whitespace ISO controls (including no-break spaces, but excluding IS1..IS4)
  • isWhitespace: Java isWhitespace; Z + whitespace ISO controls but excluding no-break spaces
  • isSpaceChar: just Z (including no-break spaces)

This class is not subclassable.

Summary

Nested classes
abstract

Bidi Paired Bracket Type constants.

abstract

Decomposition Type constants.

abstract

East Asian Width constants.

abstract

Grapheme Cluster Break constants.

abstract

Hangul Syllable Type constants.

abstract

Indic Positional Category constants.

abstract

Indic Syllabic Category constants.

abstract

Joining Group constants.

abstract

Joining Type constants.

abstract

Line Break constants.

abstract

Numeric Type constants.

abstract

Sentence Break constants.

[icu enhancement] ICU's replacement for java.lang.Character.UnicodeBlock.

abstract

Vertical Orientation constants.

abstract

Word Break constants.

Constants
static Int

[icu] Option value for case folding: use default mappings defined in CaseFolding.

static Int

[icu] Option value for case folding: Use the modified set of mappings provided in CaseFolding.

static Int

Constant U+10FFFF, same as Character#MAX_CODE_POINT.

static Char

Constant U+DBFF, same as Character#MAX_HIGH_SURROGATE.

static Char

Constant U+DFFF, same as Character#MAX_LOW_SURROGATE.

static Int

Compatibility constant for Java Character's MAX_RADIX.

static Char

Constant U+DFFF, same as Character#MAX_SURROGATE.

static Int

The highest Unicode code point value (scalar value), constant U+10FFFF (uses 21 bits).

static Int

Constant U+0000, same as Character#MIN_CODE_POINT.

static Char

Constant U+D800, same as Character#MIN_HIGH_SURROGATE.

static Char

Constant U+DC00, same as Character#MIN_LOW_SURROGATE.

static Int

Compatibility constant for Java Character's MIN_RADIX.

static Int

Constant U+10000, same as Character#MIN_SUPPLEMENTARY_CODE_POINT.

static Char

Constant U+D800, same as Character#MIN_SURROGATE.

static Int

The lowest Unicode code point value, constant 0.

static Double

Special value that is returned by getUnicodeNumericValue(int) when no numeric value is defined for a code point.

static Int

Unicode value used when translating into Unicode encoding form and there is no existing character.

static Int

The minimum value for Supplementary code points, constant U+10000.

static Int

Do not adjust the titlecasing indexes from BreakIterator::next() indexes; titlecase exactly the characters at breaks from the iterator.

static Int

Do not lowercase non-initial parts of words when titlecasing.

Inherited constants
Public methods
static Int

Same as Character#charCount.

static Int
codePointAt(seq: CharSequence!, index: Int)

Same as Character#codePointAt(CharSequence, int).

static Int
codePointAt(text: CharArray!, index: Int)

Same as Character#codePointAt(char[], int).

static Int
codePointAt(text: CharArray!, index: Int, limit: Int)

Same as Character#codePointAt(char[], int, int).

static Int

Same as Character#codePointBefore(CharSequence, int).

static Int
codePointBefore(text: CharArray!, index: Int)

Same as Character#codePointBefore(char[], int).

static Int
codePointBefore(text: CharArray!, index: Int, limit: Int)

Same as Character#codePointBefore(char[], int, int).

static Int
codePointCount(text: CharSequence!, start: Int, limit: Int)

Equivalent to the Character#codePointCount(CharSequence, int, int) method, for convenience.

static Int
codePointCount(text: CharArray!, start: Int, limit: Int)

Equivalent to the Character#codePointCount(char[], int, int) method, for convenience.

static Int
digit(ch: Int, radix: Int)

Returnss the numeric value of a decimal digit code point.

static Int
digit(ch: Int)

Returnss the numeric value of a decimal digit code point.

static Int
foldCase(ch: Int, defaultmapping: Boolean)

[icu] The given character is mapped to its case folding equivalent according to UnicodeData.

static String!
foldCase(str: String!, defaultmapping: Boolean)

[icu] The given string is mapped to its case folding equivalent according to UnicodeData.

static Int
foldCase(ch: Int, options: Int)

[icu] The given character is mapped to its case folding equivalent according to UnicodeData.

static String!
foldCase(str: String!, options: Int)

[icu] The given string is mapped to its case folding equivalent according to UnicodeData.

static Char
forDigit(digit: Int, radix: Int)

Provide the java.

static VersionInfo!
getAge(ch: Int)

[icu] Returns the "age" of the code point.

static Int

[icu] Maps the specified character to its paired bracket character.

static Int

[icu]

static Int

[icu]

static Int

[icu]

static Int
getCodePoint(lead: Int, trail: Int)

[icu] Returns a code point corresponding to the two surrogate code units.

static Int
getCodePoint(lead: Char, trail: Char)

[icu] Returns a code point corresponding to the two surrogate code units.

static Int
getCodePoint(char16: Char)

[icu] Returns the code point corresponding to the BMP code point.

static Int

[icu] Returns the combining class of the argument codepoint

static Int

[icu] Returns the Bidirection property of a code point.

static Byte

Equivalent to the Character#getDirectionality(char) method, for convenience.

static String!

[icu] Returns a name for a valid codepoint.

static ValueIterator!

[icu]

static Int

[icu] Returns the numeric value of a Han character.

static Int

[icu] Returns the maximum value for an integer/binary Unicode property.

static Int

[icu] Returns the minimum value for an integer/binary Unicode property type.

static Int

[icu] Returns the property value for a Unicode property type of a code point.

static Int

[icu] Maps the specified code point to a "mirror-image" code point.

static String!
getName(ch: Int)

[icu] Returns the most current Unicode name of the argument code point, or null if the character is unassigned or outside the range UCharacter.MIN_VALUE and UCharacter.MAX_VALUE or does not have a name.

static String!
getName(s: String!, separator: String!)

[icu] Returns the names for each of the characters in a string

static String!

[icu] Returns the corrected name from NameAliases.

static ValueIterator!

[icu]

static Int

Returns the numeric value of the code point as a nonnegative integer.

static Int
getPropertyEnum(propertyAlias: CharSequence!)

[icu] Return the UProperty selector for a given property name, as specified in the Unicode database file PropertyAliases.

static String!
getPropertyName(property: Int, nameChoice: Int)

[icu] Return the Unicode name for a given property, as given in the Unicode database file PropertyAliases.

static Int
getPropertyValueEnum(property: Int, valueAlias: CharSequence!)

[icu] Return the property value integer for a given value name, as specified in the Unicode database file PropertyValueAliases.

static String!
getPropertyValueName(property: Int, value: Int, nameChoice: Int)

[icu] Return the Unicode name for a given property value, as given in the Unicode database file PropertyValueAliases.

static Int
getType(ch: Int)

Returns a value indicating a code point's Unicode category.

static RangeValueIterator!

[icu]

static Double

[icu] Returns the numeric value for a Unicode code point as defined in the Unicode Character Database.

static VersionInfo!

[icu] Returns the version of Unicode data used.

static Boolean
hasBinaryProperty(ch: Int, property: Int)

[icu] Check a binary Unicode property for a code point.

static Boolean

[icu] Returns true if the property is true for the string.

static Boolean
isBMP(ch: Int)

[icu] Determines if the code point is in the BMP plane.

static Boolean

[icu] Determines whether the specified code point is of base form.

static Boolean

Determines if a code point has a defined meaning in the up-to-date Unicode standard.

static Boolean
isDigit(ch: Int)

Determines if a code point is a Java digit.

static Boolean
isHighSurrogate(codePoint: Int)

Same as Character#isHighSurrogate, except that the ICU version accepts int for code points.

static Boolean

Same as Character#isHighSurrogate,

static Boolean

Determines if the specified code point is an ISO control character.

static Boolean

Determines if the specified code point should be regarded as an ignorable character in a Java identifier.

static Boolean

Compatibility override of Java method, delegates to java.

static Boolean

Compatibility override of Java method, delegates to java.

static Boolean
isLegal(ch: Int)

[icu] A code point is illegal if and only if

  • Out of bounds, less than 0 or greater than UCharacter.MAX_VALUE
  • A surrogate value, 0xD800 to 0xDFFF
  • Not-a-character, having the form 0x xxFFFF or 0x xxFFFE
Note: legal does not mean that it is assigned in this version of Unicode.

static Boolean
isLegal(str: String!)

[icu] A string is legal iff all its code points are legal.

static Boolean

Determines if the specified code point is a letter.

static Boolean

Determines if the specified code point is a letter or digit.

static Boolean
isLowSurrogate(codePoint: Int)

Same as Character#isLowSurrogate, except that the ICU version accepts int for code points.

static Boolean

Same as Character#isLowSurrogate,

static Boolean

Determines if the specified code point is a lowercase character.

static Boolean

Determines whether the code point has the "mirrored" property.

static Boolean

[icu] Determines whether the specified code point is a printable character according to the Unicode standard.

static Boolean

Determines if the specified code point is a Unicode specified space character, i.

static Boolean

[icu] Determines if the code point is a supplementary character.

static Boolean

Same as Character#isSupplementaryCodePoint.

static Boolean
isSurrogatePair(high: Int, low: Int)

Same as Character#isSurrogatePair, except that the ICU version accepts int for code points.

static Boolean
isSurrogatePair(high: Char, low: Char)

Same as Character#isSurrogatePair.

static Boolean

Determines if the specified code point is a titlecase character.

static Boolean

[icu]

static Boolean

[icu]

static Boolean

[icu]

static Boolean

[icu]

static Boolean

Determines if the specified character is permissible as a non-initial character of an identifier according to UAX #31 Unicode Identifier and Pattern Syntax.

static Boolean

Determines if the specified character is permissible as the first character in an identifier according to UAX #31 Unicode Identifier and Pattern Syntax.

static Boolean

Determines if the specified code point is an uppercase character.

static Boolean

Equivalent to Character#isValidCodePoint.

static Boolean

Determines if the specified code point is a white space character.

static Int
offsetByCodePoints(text: CharSequence!, index: Int, codePointOffset: Int)

Equivalent to the Character#offsetByCodePoints(CharSequence, int, int) method, for convenience.

static Int
offsetByCodePoints(text: CharArray!, start: Int, count: Int, index: Int, codePointOffset: Int)

Equivalent to the Character#offsetByCodePoints(char[], int, int, int, int) method, for convenience.

static Int
toChars(cp: Int, dst: CharArray!, dstIndex: Int)

Same as Character#toChars(int, char[], int).

static CharArray!
toChars(cp: Int)

Same as Character#toChars(int).

static Int
toCodePoint(high: Int, low: Int)

Same as Character#toCodePoint, except that the ICU version accepts int for code points.

static Int
toCodePoint(high: Char, low: Char)

Same as Character#toCodePoint.

static Int

The given code point is mapped to its lowercase equivalent; if the code point has no lowercase equivalent, the code point itself is returned.

static String!

Returns the lowercase version of the argument string.

static String!
toLowerCase(locale: Locale!, str: String!)

Returns the lowercase version of the argument string.

static String!
toLowerCase(locale: ULocale!, str: String!)

Returns the lowercase version of the argument string.

static String!

Converts argument code point and returns a String object representing the code point's value in UTF-16 format.

static Int

Converts the code point argument to titlecase.

static String!
toTitleCase(str: String!, breakiter: BreakIterator!)

Returns the titlecase version of the argument string.

static String!
toTitleCase(locale: Locale!, str: String!, breakiter: BreakIterator!)

Returns the titlecase version of the argument string.

static String!
toTitleCase(locale: ULocale!, str: String!, titleIter: BreakIterator!)

Returns the titlecase version of the argument string.

static String!
toTitleCase(locale: ULocale!, str: String!, titleIter: BreakIterator!, options: Int)

Returns the titlecase version of the argument string.

static String!
toTitleCase(locale: Locale!, str: String!, titleIter: BreakIterator!, options: Int)

[icu]

static Int

Converts the character argument to uppercase.

static String!

Returns the uppercase version of the argument string.

static String!
toUpperCase(locale: Locale!, str: String!)

Returns the uppercase version of the argument string.

static String!
toUpperCase(locale: ULocale!, str: String!)

Returns the uppercase version of the argument string.

Constants

FOLD_CASE_DEFAULT

Added in API level 24
static val FOLD_CASE_DEFAULT: Int

[icu] Option value for case folding: use default mappings defined in CaseFolding.txt.

Value: 0

FOLD_CASE_EXCLUDE_SPECIAL_I

Added in API level 24
static val FOLD_CASE_EXCLUDE_SPECIAL_I: Int

[icu] 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).

Before Unicode 3.2, CaseFolding.txt contains mappings marked with 'I' that are to be included for default mappings and excluded for the Turkic-specific mappings.

Unicode 3.2 CaseFolding.txt instead contains mappings marked with 'T' that are to be excluded for default mappings and included for the Turkic-specific mappings.

Value: 1

MAX_CODE_POINT

Added in API level 24
static val MAX_CODE_POINT: Int

Constant U+10FFFF, same as Character#MAX_CODE_POINT.

Value: 1114111

MAX_HIGH_SURROGATE

Added in API level 24
static val MAX_HIGH_SURROGATE: Char

Constant U+DBFF, same as Character#MAX_HIGH_SURROGATE.

Value: 56319

MAX_LOW_SURROGATE

Added in API level 24
static val MAX_LOW_SURROGATE: Char

Constant U+DFFF, same as Character#MAX_LOW_SURROGATE.

Value: 57343

MAX_RADIX

Added in API level 24
static val MAX_RADIX: Int

Compatibility constant for Java Character's MAX_RADIX.

Value: 36

MAX_SURROGATE

Added in API level 24
static val MAX_SURROGATE: Char

Constant U+DFFF, same as Character#MAX_SURROGATE.

Value: 57343

MAX_VALUE

Added in API level 24
static val MAX_VALUE: Int

The highest Unicode code point value (scalar value), constant U+10FFFF (uses 21 bits). Same as Character#MAX_CODE_POINT.

Up-to-date Unicode implementation of Character#MAX_VALUE which is still a char with the value U+FFFF.

Value: 1114111

MIN_CODE_POINT

Added in API level 24
static val MIN_CODE_POINT: Int

Constant U+0000, same as Character#MIN_CODE_POINT.

Value: 0

MIN_HIGH_SURROGATE

Added in API level 24
static val MIN_HIGH_SURROGATE: Char

Constant U+D800, same as Character#MIN_HIGH_SURROGATE.

Value: 55296

MIN_LOW_SURROGATE

Added in API level 24
static val MIN_LOW_SURROGATE: Char

Constant U+DC00, same as Character#MIN_LOW_SURROGATE.

Value: 56320

MIN_RADIX

Added in API level 24
static val MIN_RADIX: Int

Compatibility constant for Java Character's MIN_RADIX.

Value: 2

MIN_SUPPLEMENTARY_CODE_POINT

Added in API level 24
static val MIN_SUPPLEMENTARY_CODE_POINT: Int

Constant U+10000, same as Character#MIN_SUPPLEMENTARY_CODE_POINT.

Value: 65536

MIN_SURROGATE

Added in API level 24
static val MIN_SURROGATE: Char

Constant U+D800, same as Character#MIN_SURROGATE.

Value: 55296

MIN_VALUE

Added in API level 24
static val MIN_VALUE: Int

The lowest Unicode code point value, constant 0. Same as Character#MIN_CODE_POINT, same integer value as Character#MIN_VALUE.

Value: 0

NO_NUMERIC_VALUE

Added in API level 24
static val NO_NUMERIC_VALUE: Double

Special value that is returned by getUnicodeNumericValue(int) when no numeric value is defined for a code point.

Value: -1.23456789E8

REPLACEMENT_CHAR

Added in API level 24
static val REPLACEMENT_CHAR: Int

Unicode value used when translating into Unicode encoding form and there is no existing character.

Value: 65533

SUPPLEMENTARY_MIN_VALUE

Added in API level 24
static val SUPPLEMENTARY_MIN_VALUE: Int

The minimum value for Supplementary code points, constant U+10000. Same as Character#MIN_SUPPLEMENTARY_CODE_POINT.

Value: 65536

TITLECASE_NO_BREAK_ADJUSTMENT

Added in API level 24
static val TITLECASE_NO_BREAK_ADJUSTMENT: Int

Do not adjust the titlecasing indexes from BreakIterator::next() indexes; titlecase exactly the characters at breaks from the iterator. Option bit for titlecasing APIs that take an options bit set. By default, titlecasing will take each break iterator index, adjust it by looking for the next cased character, and titlecase that one. Other characters are lowercased. This follows Unicode 4 & 5 section 3.13 Default Case Operations: R3 toTitlecase(X): Find the word boundaries based on Unicode Standard Annex #29, "Text Boundaries." Between each pair of word boundaries, find the first cased character F. If F exists, map F to default_title(F); then map each subsequent character C to default_lower(C).

Value: 512

TITLECASE_NO_LOWERCASE

Added in API level 24
static val TITLECASE_NO_LOWERCASE: Int

Do not lowercase non-initial parts of words when titlecasing. Option bit for titlecasing APIs that take an options bit set. By default, titlecasing will titlecase the first cased character of a word and lowercase all other characters. With this option, the other characters will not be modified.

Value: 256

See Also

    Public methods

    charCount

    Added in API level 24
    static fun charCount(cp: Int): Int

    Same as Character#charCount. Returns the number of chars needed to represent the code point (1 or 2). This does not check the code point for validity.

    Parameters
    cp Int: the code point to check
    Return
    Int the number of chars needed to represent the code point

    codePointAt

    Added in API level 24
    static fun codePointAt(
        seq: CharSequence!,
        index: Int
    ): Int

    Same as Character#codePointAt(CharSequence, int). Returns the code point at index. This examines only the characters at index and index+1.

    Parameters
    seq CharSequence!: the characters to check
    index Int: the index of the first or only char forming the code point
    Return
    Int the code point at the index

    codePointAt

    Added in API level 24
    static fun codePointAt(
        text: CharArray!,
        index: Int
    ): Int

    Same as Character#codePointAt(char[], int). Returns the code point at index. This examines only the characters at index and index+1.

    Parameters
    text CharArray!: the characters to check
    index Int: the index of the first or only char forming the code point
    Return
    Int the code point at the index

    codePointAt

    Added in API level 24
    static fun codePointAt(
        text: CharArray!,
        index: Int,
        limit: Int
    ): Int

    Same as Character#codePointAt(char[], int, int). Returns the code point at index. This examines only the characters at index and index+1.

    Parameters
    text CharArray!: the characters to check
    index Int: the index of the first or only char forming the code point
    limit Int: the limit of the valid text
    Return
    Int the code point at the index

    codePointBefore

    Added in API level 24
    static fun codePointBefore(
        seq: CharSequence!,
        index: Int
    ): Int

    Same as Character#codePointBefore(CharSequence, int). Return the code point before index. This examines only the characters at index-1 and index-2.

    Parameters
    seq CharSequence!: the characters to check
    index Int: the index after the last or only char forming the code point
    Return
    Int the code point before the index

    codePointBefore

    Added in API level 24
    static fun codePointBefore(
        text: CharArray!,
        index: Int
    ): Int

    Same as Character#codePointBefore(char[], int). Returns the code point before index. This examines only the characters at index-1 and index-2.

    Parameters
    text CharArray!: the characters to check
    index Int: the index after the last or only char forming the code point
    Return
    Int the code point before the index

    codePointBefore

    Added in API level 24
    static fun codePointBefore(
        text: CharArray!,
        index: Int,
        limit: Int
    ): Int

    Same as Character#codePointBefore(char[], int, int). Return the code point before index. This examines only the characters at index-1 and index-2.

    Parameters
    text CharArray!: the characters to check
    index Int: the index after the last or only char forming the code point
    limit Int: the start of the valid text
    Return
    Int the code point before the index

    codePointCount

    Added in API level 24
    static fun codePointCount(
        text: CharSequence!,
        start: Int,
        limit: Int
    ): Int

    Equivalent to the Character#codePointCount(CharSequence, int, int) method, for convenience. Counts the number of code points in the range of text.

    Parameters
    text CharSequence!: the characters to check
    start Int: the start of the range
    limit Int: the limit of the range
    Return
    Int the number of code points in the range

    codePointCount

    Added in API level 24
    static fun codePointCount(
        text: CharArray!,
        start: Int,
        limit: Int
    ): Int

    Equivalent to the Character#codePointCount(char[], int, int) method, for convenience. Counts the number of code points in the range of text.

    Parameters
    text CharArray!: the characters to check
    start Int: the start of the range
    limit Int: the limit of the range
    Return
    Int the number of code points in the range

    digit

    Added in API level 24
    static fun digit(
        ch: Int,
        radix: Int
    ): Int

    Returnss the numeric value of a decimal digit code point.
    This method observes the semantics of java.lang.Character.digit(). Note that this will return positive values for code points for which isDigit returns false, just like java.lang.Character.
    Semantic Change: In release 1.3.1 and prior, this did not treat the European letters as having a digit value, and also treated numeric letters and other numbers as digits. This has been changed to conform to the java semantics.
    A code point is a valid digit if and only if:

    • ch is a decimal digit or one of the european letters, and
    • the value of ch is less than the specified radix.

    Parameters
    ch Int: the code point to query
    radix Int: the radix
    Return
    Int the numeric value represented by the code point in the specified radix, or -1 if the code point is not a decimal digit or if its value is too large for the radix

    digit

    Added in API level 24
    static fun digit(ch: Int): Int

    Returnss the numeric value of a decimal digit code point.
    This is a convenience overload of digit(int, int) that provides a decimal radix.
    Semantic Change: In release 1.3.1 and prior, this treated numeric letters and other numbers as digits. This has been changed to conform to the java semantics.

    Parameters
    ch Int: the code point to query
    Return
    Int the numeric value represented by the code point, or -1 if the code point is not a decimal digit or if its value is too large for a decimal radix

    foldCase

    Added in API level 24
    static fun foldCase(
        ch: Int,
        defaultmapping: Boolean
    ): Int

    [icu] The given character is mapped to its case folding equivalent according to UnicodeData.txt and CaseFolding.txt; if the character has no case folding equivalent, the character itself is returned.

    This function only returns the simple, single-code point case mapping. Full case mappings should be used whenever possible because they produce better results by working on whole strings. They can map to a result string with a different length as appropriate. Full case mappings are applied by the case mapping functions that take String parameters rather than code points (int). See also the User Guide chapter on C/POSIX migration: https://unicode-org.github.io/icu/userguide/icu/posix#case-mappings

    Parameters
    ch Int: the character to be converted
    defaultmapping Boolean: Indicates whether the default mappings defined in CaseFolding.txt are to be used, otherwise the mappings for dotted I and dotless i marked with 'T' in CaseFolding.txt are included.
    Return
    Int the case folding equivalent of the character, if any; otherwise the character itself.

    foldCase

    Added in API level 24
    static fun foldCase(
        str: String!,
        defaultmapping: Boolean
    ): String!

    [icu] The given string is mapped to its case folding equivalent according to UnicodeData.txt and CaseFolding.txt; if any character has no case folding equivalent, the character itself is returned. "Full", multiple-code point case folding mappings are returned here. For "simple" single-code point mappings use the API foldCase(int ch, boolean defaultmapping).

    Parameters
    str String!: the String to be converted
    defaultmapping Boolean: Indicates whether the default mappings defined in CaseFolding.txt are to be used, otherwise the mappings for dotted I and dotless i marked with 'T' in CaseFolding.txt are included.
    Return
    String! the case folding equivalent of the character, if any; otherwise the character itself.

    foldCase

    Added in API level 24
    static fun foldCase(
        ch: Int,
        options: Int
    ): Int

    [icu] The given character is mapped to its case folding equivalent according to UnicodeData.txt and CaseFolding.txt; if the character has no case folding equivalent, the character itself is returned.

    This function only returns the simple, single-code point case mapping. Full case mappings should be used whenever possible because they produce better results by working on whole strings. They can map to a result string with a different length as appropriate. Full case mappings are applied by the case mapping functions that take String parameters rather than code points (int). See also the User Guide chapter on C/POSIX migration: https://unicode-org.github.io/icu/userguide/icu/posix#case-mappings

    Parameters
    ch Int: the character to be converted
    options Int: A bit set for special processing. Currently the recognised options are FOLD_CASE_EXCLUDE_SPECIAL_I and FOLD_CASE_DEFAULT
    Return
    Int the case folding equivalent of the character, if any; otherwise the character itself.

    foldCase

    Added in API level 24
    static fun foldCase(
        str: String!,
        options: Int
    ): String!

    [icu] The given string is mapped to its case folding equivalent according to UnicodeData.txt and CaseFolding.txt; if any character has no case folding equivalent, the character itself is returned. "Full", multiple-code point case folding mappings are returned here. For "simple" single-code point mappings use the API foldCase(int ch, boolean defaultmapping).

    Parameters
    str String!: the String to be converted
    options Int: A bit set for special processing. Currently the recognised options are FOLD_CASE_EXCLUDE_SPECIAL_I and FOLD_CASE_DEFAULT
    Return
    String! the case folding equivalent of the character, if any; otherwise the character itself.

    forDigit

    Added in API level 24
    static fun forDigit(
        digit: Int,
        radix: Int
    ): Char

    Provide the java.lang.Character forDigit API, for convenience.

    getAge

    Added in API level 24
    static fun getAge(ch: Int): VersionInfo!

    [icu] Returns the "age" of the code point.

    The "age" is the Unicode version when the code point was first designated (as a non-character or for Private Use) or assigned a character.

    This can be useful to avoid emitting code points to receiving processes that do not accept newer characters.

    The data is from the UCD file DerivedAge.txt.

    Parameters
    ch Int: The code point.
    Return
    VersionInfo! the Unicode version number

    getBidiPairedBracket

    Added in API level 24
    static fun getBidiPairedBracket(c: Int): Int

    [icu] Maps the specified character to its paired bracket character. For Bidi_Paired_Bracket_Type!=None, this is the same as getMirror(int). Otherwise c itself is returned. See http://www.unicode.org/reports/tr9/

    Parameters
    c Int: the code point to be mapped
    Return
    Int the paired bracket code point, or c itself if there is no such mapping (Bidi_Paired_Bracket_Type=None)

    getCharFromExtendedName

    Added in API level 24
    static fun getCharFromExtendedName(name: String!): Int

    [icu]

    Find a Unicode character by either its name and return its code point value. All Unicode names are in uppercase. Extended names are all lowercase except for numbers and are contained within angle brackets. The names are searched in the following order

    • Most current Unicode name if there is any
    • Unicode 1.0 name if there is any
    • Extended name in the form of "<codepoint_type-codepoint_hex_digits>". E.g. <noncharacter-FFFE>
    Note calling any methods related to code point names, e.g. getName() incurs a one-time initialization cost to construct the name tables.
    Parameters
    name String!: codepoint name
    Return
    Int code point associated with the name or -1 if the name is not found.

    getCharFromName

    Added in API level 24
    static fun getCharFromName(name: String!): Int

    [icu]

    Finds a Unicode code point by its most current Unicode name and return its code point value. All Unicode names are in uppercase. Note calling any methods related to code point names, e.g. getName() incurs a one-time initialization cost to construct the name tables.

    Parameters
    name String!: most current Unicode character name whose code point is to be returned
    Return
    Int code point or -1 if name is not found

    getCharFromNameAlias

    Added in API level 24
    static fun getCharFromNameAlias(name: String!): Int

    [icu]

    Find a Unicode character by its corrected name alias and return its code point value. All Unicode names are in uppercase. Note calling any methods related to code point names, e.g. getName() incurs a one-time initialization cost to construct the name tables.

    Parameters
    name String!: Unicode name alias whose code point is to be returned
    Return
    Int code point or -1 if name is not found

    getCodePoint

    Added in API level 33
    static fun getCodePoint(
        lead: Int,
        trail: Int
    ): Int

    [icu] Returns a code point corresponding to the two surrogate code units.

    Parameters
    lead Int: the lead unit (In ICU 2.1-69 the type of both parameters was char.)
    trail Int: the trail unit
    Return
    Int code point if lead and trail form a valid surrogate pair.
    Exceptions
    java.lang.IllegalArgumentException thrown when the code units do not form a valid surrogate pair

    getCodePoint

    Added in API level 24
    static fun getCodePoint(
        lead: Char,
        trail: Char
    ): Int

    [icu] Returns a code point corresponding to the two surrogate code units.

    Parameters
    lead Char: the lead char
    trail Char: the trail char
    Return
    Int code point if surrogate characters are valid.
    Exceptions
    java.lang.IllegalArgumentException thrown when the code units do not form a valid code point

    getCodePoint

    Added in API level 24
    static fun getCodePoint(char16: Char): Int

    [icu] Returns the code point corresponding to the BMP code point.

    Parameters
    char16 Char: the BMP code point
    Return
    Int code point if argument is a valid character.
    Exceptions
    java.lang.IllegalArgumentException thrown when char16 is not a valid code point

    getCombiningClass

    Added in API level 24
    static fun getCombiningClass(ch: Int): Int

    [icu] Returns the combining class of the argument codepoint

    Parameters
    ch Int: code point whose combining is to be retrieved
    Return
    Int the combining class of the codepoint

    getDirection

    Added in API level 24
    static fun getDirection(ch: Int): Int

    [icu] Returns the Bidirection property of a code point. For example, 0x0041 (letter A) has the LEFT_TO_RIGHT directional property.
    Result returned belongs to the interface UCharacterDirection

    Parameters
    ch Int: the code point to be determined its direction
    Return
    Int direction constant from UCharacterDirection.

    getDirectionality

    Added in API level 24
    static fun getDirectionality(cp: Int): Byte

    Equivalent to the Character#getDirectionality(char) method, for convenience. Returns a byte representing the directionality of the character. [icu] Note: Unlike Character#getDirectionality(char), this returns DIRECTIONALITY_LEFT_TO_RIGHT for undefined or out-of-bounds characters. [icu] Note: The return value must be tested using the constants defined in UCharacterDirection and its interface UCharacterEnums.ECharacterDirection since the values are different from the ones defined by java.lang.Character.

    Parameters
    cp Int: the code point to check
    Return
    Byte the directionality of the code point

    See Also

    getExtendedName

    Added in API level 24
    static fun getExtendedName(ch: Int): String!

    [icu] Returns a name for a valid codepoint. Unlike, getName(int) and getName1_0(int), this method will return a name even for codepoints that are not assigned a name in UnicodeData.txt.

    The names are returned in the following order.

    • Most current Unicode name if there is any
    • Unicode 1.0 name if there is any
    • Extended name in the form of "<codepoint_type-codepoint_hex_digits>". E.g., <noncharacter-fffe>
    Note calling any methods related to code point names, e.g. getName() incurs a one-time initialization cost to construct the name tables.
    Parameters
    ch Int: the code point for which to get the name
    Return
    String! a name for the argument codepoint

    getExtendedNameIterator

    Added in API level 24
    static fun getExtendedNameIterator(): ValueIterator!

    [icu]

    Returns an iterator for character names, iterating over codepoints.

    This API only gets the iterator for the extended names. For modern, most up-to-date Unicode names use getNameIterator() or for older 1.0 Unicode names use get1_0NameIterator().

    Example of use:

    ValueIterator iterator = UCharacter.getExtendedNameIterator();
      ValueIterator.Element element = new ValueIterator.Element();
      while (iterator.next(element)) {
          System.out.println("Codepoint \\u" +
                             Integer.toHexString(element.codepoint) +
                             " has the name " + (String)element.value);
      }
      

    The maximal range which the name iterator iterates is from

    Return
    ValueIterator! an iterator

    getHanNumericValue

    Added in API level 24
    static fun getHanNumericValue(ch: Int): Int

    [icu] Returns the numeric value of a Han character.

    This returns the value of Han 'numeric' code points, including those for zero, ten, hundred, thousand, ten thousand, and hundred million. This includes both the standard and 'checkwriting' characters, the 'big circle' zero character, and the standard zero character.

    Note: The Unicode Standard has numeric values for more Han characters recognized by this method (see getNumericValue(int) and the UCD file DerivedNumericValues.txt), and a android.icu.text.NumberFormat can be used with a Chinese android.icu.text.NumberingSystem.

    Parameters
    ch Int: code point to query
    Return
    Int value if it is a Han 'numeric character,' otherwise return -1.

    getIntPropertyMaxValue

    Added in API level 24
    static fun getIntPropertyMaxValue(type: Int): Int

    [icu] Returns the maximum value for an integer/binary Unicode property. Can be used together with UCharacter.getIntPropertyMinValue(int) to allocate arrays of android.icu.text.UnicodeSet or similar. Examples for min/max values (for Unicode 3.2):

    • UProperty.BIDI_CLASS: 0/18 (UCharacterDirection.LEFT_TO_RIGHT/UCharacterDirection.BOUNDARY_NEUTRAL)
    • UProperty.SCRIPT: 0/45 (UScript.COMMON/UScript.TAGBANWA)
    • UProperty.IDEOGRAPHIC: 0/1 (false/true)
    For undefined UProperty constant values, min/max values will be 0/-1.

    Parameters
    type Int: UProperty selector constant, identifies which binary property to check. Must be UProperty.BINARY_START <= type < UProperty.BINARY_LIMIT or UProperty.INT_START <= type < UProperty.INT_LIMIT.
    Return
    Int Maximum value returned by u_getIntPropertyValue for a Unicode property. <= 0 if the property selector 'type' is out of range.

    getIntPropertyMinValue

    Added in API level 24
    static fun getIntPropertyMinValue(type: Int): Int

    [icu] Returns the minimum value for an integer/binary Unicode property type. Can be used together with UCharacter.getIntPropertyMaxValue(int) to allocate arrays of android.icu.text.UnicodeSet or similar.

    Parameters
    type Int: UProperty selector constant, identifies which binary property to check. Must be UProperty.BINARY_START <= type < UProperty.BINARY_LIMIT or UProperty.INT_START <= type < UProperty.INT_LIMIT.
    Return
    Int Minimum value returned by UCharacter.getIntPropertyValue(int) for a Unicode property. 0 if the property selector 'type' is out of range.

    getIntPropertyValue

    Added in API level 24
    static fun getIntPropertyValue(
        ch: Int,
        type: Int
    ): Int

    [icu] Returns the property value for a Unicode property type of a code point. Also returns binary and mask property values.

    Unicode, especially in version 3.2, defines many more properties than the original set in UnicodeData.txt.

    The properties APIs are intended to reflect Unicode properties as defined in the Unicode Character Database (UCD) and Unicode Technical Reports (UTR). For details about the properties see http://www.unicode.org/.

    For names of Unicode properties see the UCD file PropertyAliases.txt.

    Sample usage:
      int ea = UCharacter.getIntPropertyValue(c, UProperty.EAST_ASIAN_WIDTH);
      int ideo = UCharacter.getIntPropertyValue(c, UProperty.IDEOGRAPHIC);
      boolean b = (ideo == 1) ? true : false;
      
    Parameters
    ch Int: code point to test.
    type Int: UProperty selector constant, identifies which binary property to check. Must be UProperty.BINARY_START <= type < UProperty.BINARY_LIMIT or UProperty.INT_START <= type < UProperty.INT_LIMIT or UProperty.MASK_START <= type < UProperty.MASK_LIMIT.
    Return
    Int numeric value that is directly the property value or, for enumerated properties, corresponds to the numeric value of the enumerated constant of the respective property value type (ECharacterCategory, ECharacterDirection, DecompositionType, etc.). Returns 0 or 1 (for false / true) for binary Unicode properties. Returns a bit-mask for mask properties. Returns 0 if 'type' is out of bounds or if the Unicode version does not have data for the property at all, or not for this code point.

    getMirror

    Added in API level 24
    static fun getMirror(ch: Int): Int

    [icu] Maps the specified code point to a "mirror-image" code point. For code points with the "mirrored" property, implementations sometimes need a "poor man's" mapping to another code point such that the default glyph may serve as the mirror-image of the default glyph of the specified code point.
    This is useful for text conversion to and from codepages with visual order, and for displays without glyph selection capabilities.

    Parameters
    ch Int: code point whose mirror is to be retrieved
    Return
    Int another code point that may serve as a mirror-image substitute, or ch itself if there is no such mapping or ch does not have the "mirrored" property

    getName

    Added in API level 24
    static fun getName(ch: Int): String!

    [icu] Returns the most current Unicode name of the argument code point, or null if the character is unassigned or outside the range UCharacter.MIN_VALUE and UCharacter.MAX_VALUE or does not have a name.
    Note calling any methods related to code point names, e.g. getName() incurs a one-time initialization cost to construct the name tables.

    Parameters
    ch Int: the code point for which to get the name
    Return
    String! most current Unicode name

    getName

    Added in API level 24
    static fun getName(
        s: String!,
        separator: String!
    ): String!

    [icu] Returns the names for each of the characters in a string

    Parameters
    s String!: string to format
    separator String!: string to go between names
    Return
    String! string of names

    getNameAlias

    Added in API level 24
    static fun getNameAlias(ch: Int): String!

    [icu] Returns the corrected name from NameAliases.txt if there is one. Returns null if the character is unassigned or outside the range UCharacter.MIN_VALUE and UCharacter.MAX_VALUE or does not have a name.
    Note calling any methods related to code point names, e.g. getName() incurs a one-time initialization cost to construct the name tables.

    Parameters
    ch Int: the code point for which to get the name alias
    Return
    String! Unicode name alias, or null

    getNameIterator

    Added in API level 24
    static fun getNameIterator(): ValueIterator!

    [icu]

    Returns an iterator for character names, iterating over codepoints.

    This API only gets the iterator for the modern, most up-to-date Unicode names. For older 1.0 Unicode names use get1_0NameIterator() or for extended names use getExtendedNameIterator().

    Example of use:

    ValueIterator iterator = UCharacter.getNameIterator();
      ValueIterator.Element element = new ValueIterator.Element();
      while (iterator.next(element)) {
          System.out.println("Codepoint \\u" +
                             Integer.toHexString(element.codepoint) +
                             " has the name " + (String)element.value);
      }
      

    The maximal range which the name iterator iterates is from UCharacter.MIN_VALUE to UCharacter.MAX_VALUE.

    Return
    ValueIterator! an iterator

    getNumericValue

    Added in API level 24
    static fun getNumericValue(ch: Int): Int

    Returns the numeric value of the code point as a nonnegative integer.
    If the code point does not have a numeric value, then -1 is returned.
    If the code point has a numeric value that cannot be represented as a nonnegative integer (for example, a fractional value), then -2 is returned.

    Parameters
    ch Int: the code point to query
    Return
    Int the numeric value of the code point, or -1 if it has no numeric value, or -2 if it has a numeric value that cannot be represented as a nonnegative integer

    getPropertyEnum

    Added in API level 24
    static fun getPropertyEnum(propertyAlias: CharSequence!): Int

    [icu] Return the UProperty selector for a given property name, as specified in the Unicode database file PropertyAliases.txt. Short, long, and any other variants are recognized. In addition, this function maps the synthetic names "gcm" / "General_Category_Mask" to the property UProperty.GENERAL_CATEGORY_MASK. These names are not in PropertyAliases.txt.

    Parameters
    propertyAlias CharSequence!: the property name to be matched. The name is compared using "loose matching" as described in PropertyAliases.txt.
    Return
    Int a UProperty enum.
    Exceptions
    java.lang.IllegalArgumentException thrown if propertyAlias is not recognized.

    getPropertyName

    Added in API level 24
    static fun getPropertyName(
        property: Int,
        nameChoice: Int
    ): String!

    [icu] Return the Unicode name for a given property, as given in the Unicode database file PropertyAliases.txt. Most properties have more than one name. The nameChoice determines which one is returned. In addition, this function maps the property UProperty.GENERAL_CATEGORY_MASK to the synthetic names "gcm" / "General_Category_Mask". These names are not in PropertyAliases.txt.

    Parameters
    property Int: UProperty selector.
    nameChoice Int: UProperty.NameChoice selector for which name to get. All properties have a long name. Most have a short name, but some do not. Unicode allows for additional names; if present these will be returned by UProperty.NameChoice.LONG + i, where i=1, 2,...
    Return
    String! a name, or null if Unicode explicitly defines no name ("n/a") for a given property/nameChoice. If a given nameChoice throws an exception, then all larger values of nameChoice will throw an exception. If null is returned for a given nameChoice, then other nameChoice values may return non-null results.
    Exceptions
    java.lang.IllegalArgumentException thrown if property or nameChoice are invalid.

    getPropertyValueEnum

    Added in API level 24
    static fun getPropertyValueEnum(
        property: Int,
        valueAlias: CharSequence!
    ): Int

    [icu] Return the property value integer for a given value name, as specified in the Unicode database file PropertyValueAliases.txt. Short, long, and any other variants are recognized. Note: Some of the names in PropertyValueAliases.txt will only be recognized with UProperty.GENERAL_CATEGORY_MASK, not UProperty.GENERAL_CATEGORY. These include: "C" / "Other", "L" / "Letter", "LC" / "Cased_Letter", "M" / "Mark", "N" / "Number", "P" / "Punctuation", "S" / "Symbol", and "Z" / "Separator".

    Parameters
    property Int: UProperty selector constant. UProperty.INT_START <= property < UProperty.INT_LIMIT or UProperty.BINARY_START <= property < UProperty.BINARY_LIMIT or UProperty.MASK_START < = property < UProperty.MASK_LIMIT. Only these properties can be enumerated.
    valueAlias CharSequence!: the value name to be matched. The name is compared using "loose matching" as described in PropertyValueAliases.txt.
    Return
    Int a value integer. Note: UProperty.GENERAL_CATEGORY values are mask values produced by left-shifting 1 by UCharacter.getType(). This allows grouped categories such as [:L:] to be represented.
    Exceptions
    java.lang.IllegalArgumentException if property is not a valid UProperty selector or valueAlias is not a value of this property

    getPropertyValueName

    Added in API level 24
    static fun getPropertyValueName(
        property: Int,
        value: Int,
        nameChoice: Int
    ): String!

    [icu] Return the Unicode name for a given property value, as given in the Unicode database file PropertyValueAliases.txt. Most values have more than one name. The nameChoice determines which one is returned. Note: Some of the names in PropertyValueAliases.txt can only be retrieved using UProperty.GENERAL_CATEGORY_MASK, not UProperty.GENERAL_CATEGORY. These include: "C" / "Other", "L" / "Letter", "LC" / "Cased_Letter", "M" / "Mark", "N" / "Number", "P" / "Punctuation", "S" / "Symbol", and "Z" / "Separator".

    Parameters
    property Int: UProperty selector constant. UProperty.INT_START <= property < UProperty.INT_LIMIT or UProperty.BINARY_START <= property < UProperty.BINARY_LIMIT or UProperty.MASK_START < = property < UProperty.MASK_LIMIT. If out of range, null is returned.
    value Int: selector for a value for the given property. In general, valid values range from 0 up to some maximum. There are a few exceptions: (1.) UProperty.BLOCK values begin at the non-zero value BASIC_LATIN.getID(). (2.) UProperty.CANONICAL_COMBINING_CLASS values are not contiguous and range from 0..240. (3.) UProperty.GENERAL_CATEGORY_MASK values are mask values produced by left-shifting 1 by UCharacter.getType(). This allows grouped categories such as [:L:] to be represented. Mask values are non-contiguous.
    nameChoice Int: UProperty.NameChoice selector for which name to get. All values have a long name. Most have a short name, but some do not. Unicode allows for additional names; if present these will be returned by UProperty.NameChoice.LONG + i, where i=1, 2,...
    Return
    String! a name, or null if Unicode explicitly defines no name ("n/a") for a given property/value/nameChoice. If a given nameChoice throws an exception, then all larger values of nameChoice will throw an exception. If null is returned for a given nameChoice, then other nameChoice values may return non-null results.
    Exceptions
    java.lang.IllegalArgumentException thrown if property, value, or nameChoice are invalid.

    getType

    Added in API level 24
    static fun getType(ch: Int): Int

    Returns a value indicating a code point's Unicode category. Up-to-date Unicode implementation of java.lang.Character.getType() except for the above mentioned code points that had their category changed.
    Return results are constants from the interface UCharacterCategory
    NOTE: the UCharacterCategory values are not compatible with those returned by java.lang.Character.getType. UCharacterCategory values match the ones used in ICU4C, while java.lang.Character type values, though similar, skip the value 17.

    Parameters
    ch Int: code point whose type is to be determined
    Return
    Int category which is a value of UCharacterCategory

    getTypeIterator

    Added in API level 24
    static fun getTypeIterator(): RangeValueIterator!

    [icu]

    Returns an iterator for character types, iterating over codepoints.

    Example of use:

    RangeValueIterator iterator = UCharacter.getTypeIterator();
      RangeValueIterator.Element element = new RangeValueIterator.Element();
      while (iterator.next(element)) {
          System.out.println("Codepoint \\u" +
                             Integer.toHexString(element.start) +
                             " to codepoint \\u" +
                             Integer.toHexString(element.limit - 1) +
                             " has the character type " +
                             element.value);
      }
      
    Return
    RangeValueIterator! an iterator

    getUnicodeNumericValue

    Added in API level 24
    static fun getUnicodeNumericValue(ch: Int): Double

    [icu] Returns the numeric value for a Unicode code point as defined in the Unicode Character Database.

    A "double" return type is necessary because some numeric values are fractions, negative, or too large for int.

    For characters without any numeric values in the Unicode Character Database, this function will return NO_NUMERIC_VALUE. Note: This is different from the Unicode Standard which specifies NaN as the default value.

    API Change: In release 2.2 and prior, this API has a return type int and returns -1 when the argument ch does not have a corresponding numeric value. This has been changed to synch with ICU4C This corresponds to the ICU4C function u_getNumericValue.

    Parameters
    ch Int: Code point to get the numeric value for.
    Return
    Double numeric value of ch, or NO_NUMERIC_VALUE if none is defined.

    getUnicodeVersion

    Added in API level 24
    static fun getUnicodeVersion(): VersionInfo!

    [icu] Returns the version of Unicode data used.

    Return
    VersionInfo! the unicode version number used

    hasBinaryProperty

    Added in API level 24
    static fun hasBinaryProperty(
        ch: Int,
        property: Int
    ): Boolean

    [icu] Check a binary Unicode property for a code point.

    Unicode, especially in version 3.2, defines many more properties than the original set in UnicodeData.txt.

    This API is intended to reflect Unicode properties as defined in the Unicode Character Database (UCD) and Unicode Technical Reports (UTR).

    For details about the properties see http://www.unicode.org/.

    For names of Unicode properties see the UCD file PropertyAliases.txt.

    This API does not check the validity of the codepoint.

    Important: If ICU is built with UCD files from Unicode versions below 3.2, then properties marked with "new" are not or not fully available.

    Parameters
    ch Int: code point to test.
    property Int: selector constant from android.icu.lang.UProperty, identifies which binary property to check.
    Return
    Boolean true or false according to the binary Unicode property value for ch. Also false if property is out of bounds or if the Unicode version does not have data for the property at all, or not for this code point.

    hasBinaryProperty

    Added in API level 34
    static fun hasBinaryProperty(
        s: CharSequence!,
        property: Int
    ): Boolean

    [icu] Returns true if the property is true for the string. Same as hasBinaryProperty(int,int) if the string contains exactly one code point.

    Most properties apply only to single code points. UTS #51 Unicode Emoji defines several properties of strings.

    Parameters
    s CharSequence!: String to test.
    property Int: UProperty selector constant, identifies which binary property to check. Must be BINARY_START<=which<BINARY_LIMIT.
    Return
    Boolean true or false according to the binary Unicode property value for the string. Also false if property is out of bounds or if the Unicode version does not have data for the property at all.

    isBMP

    Added in API level 24
    static fun isBMP(ch: Int): Boolean

    [icu] Determines if the code point is in the BMP plane.

    Parameters
    ch Int: code point to be determined if it is not a supplementary character
    Return
    Boolean true if code point is not a supplementary character

    isBaseForm

    Added in API level 24
    static fun isBaseForm(ch: Int): Boolean

    [icu] Determines whether the specified code point is of base form. A code point of base form does not graphically combine with preceding characters, and is neither a control nor a format character.

    Parameters
    ch Int: code point to be determined if it is of base form
    Return
    Boolean true if the code point is of base form

    isDefined

    Added in API level 24
    static fun isDefined(ch: Int): Boolean

    Determines if a code point has a defined meaning in the up-to-date Unicode standard. E.g. supplementary code points though allocated space are not defined in Unicode yet.
    Up-to-date Unicode implementation of java.lang.Character.isDefined()

    Parameters
    ch Int: code point to be determined if it is defined in the most current version of Unicode
    Return
    Boolean true if this code point is defined in unicode

    isDigit

    Added in API level 24
    static fun isDigit(ch: Int): Boolean

    Determines if a code point is a Java digit.
    This method observes the semantics of java.lang.Character.isDigit(). It returns true for decimal digits only.
    Semantic Change: In release 1.3.1 and prior, this treated numeric letters and other numbers as digits. This has been changed to conform to the java semantics.

    Parameters
    ch Int: code point to query
    Return
    Boolean true if this code point is a digit

    isHighSurrogate

    Added in API level 33
    static fun isHighSurrogate(codePoint: Int): Boolean

    Same as Character#isHighSurrogate, except that the ICU version accepts int for code points.

    Parameters
    codePoint Int: the code point to check (In ICU 3.0-69 the type of this parameter was char.)
    Return
    Boolean true if codePoint is a high (lead) surrogate

    isHighSurrogate

    Added in API level 24
    static fun isHighSurrogate(ch: Char): Boolean

    Same as Character#isHighSurrogate,

    Parameters
    ch Char: the char to check
    Return
    Boolean true if ch is a high (lead) surrogate

    isISOControl

    Added in API level 24
    static fun isISOControl(ch: Int): Boolean

    Determines if the specified code point is an ISO control character. A code point is considered to be an ISO control character if it is in the range \u0000 through \u001F or in the range \u007F through \u009F.
    Up-to-date Unicode implementation of java.lang.Character.isISOControl()

    Parameters
    ch Int: code point to determine if it is an ISO control character
    Return
    Boolean true if code point is a ISO control character

    isIdentifierIgnorable

    Added in API level 24
    static fun isIdentifierIgnorable(ch: Int): Boolean

    Determines if the specified code point should be regarded as an ignorable character in a Java identifier. A character is Java-identifier-ignorable if it has the general category Cf Formatting Control, or it is a non-Java-whitespace ISO control: U+0000..U+0008, U+000E..U+001B, U+007F..U+009F.
    Up-to-date Unicode implementation of java.lang.Character.isIdentifierIgnorable().
    See UTR #8.

    Note that Unicode just recommends to ignore Cf (format controls).

    Parameters
    ch Int: code point to be determined if it can be ignored in a Unicode identifier.
    Return
    Boolean true if the code point is ignorable

    isJavaIdentifierPart

    Added in API level 24
    static fun isJavaIdentifierPart(cp: Int): Boolean

    Compatibility override of Java method, delegates to java.lang.Character.isJavaIdentifierPart.

    Parameters
    cp Int: the code point
    Return
    Boolean true if the code point can continue a java identifier.

    isJavaIdentifierStart

    Added in API level 24
    static fun isJavaIdentifierStart(cp: Int): Boolean

    Compatibility override of Java method, delegates to java.lang.Character.isJavaIdentifierStart.

    Parameters
    cp Int: the code point
    Return
    Boolean true if the code point can start a java identifier.

    isLegal

    Added in API level 24
    static fun isLegal(ch: Int): Boolean

    [icu] A code point is illegal if and only if

    • Out of bounds, less than 0 or greater than UCharacter.MAX_VALUE
    • A surrogate value, 0xD800 to 0xDFFF
    • Not-a-character, having the form 0x xxFFFF or 0x xxFFFE
    Note: legal does not mean that it is assigned in this version of Unicode.

    Parameters
    ch Int: code point to determine if it is a legal code point by itself
    Return
    Boolean true if and only if legal.

    isLegal

    Added in API level 24
    static fun isLegal(str: String!): Boolean

    [icu] A string is legal iff all its code points are legal. A code point is illegal if and only if

    • Out of bounds, less than 0 or greater than UCharacter.MAX_VALUE
    • A surrogate value, 0xD800 to 0xDFFF
    • Not-a-character, having the form 0x xxFFFF or 0x xxFFFE
    Note: legal does not mean that it is assigned in this version of Unicode.

    Parameters
    str String!: containing code points to examin
    Return
    Boolean true if and only if legal.

    isLetter

    Added in API level 24
    static fun isLetter(ch: Int): Boolean

    Determines if the specified code point is a letter. Up-to-date Unicode implementation of java.lang.Character.isLetter()

    Parameters
    ch Int: code point to determine if it is a letter
    Return
    Boolean true if code point is a letter

    isLetterOrDigit

    Added in API level 24
    static fun isLetterOrDigit(ch: Int): Boolean

    Determines if the specified code point is a letter or digit. [icu] Note: This method, unlike java.lang.Character does not regard the ascii characters 'A' - 'Z' and 'a' - 'z' as digits.

    Parameters
    ch Int: code point to determine if it is a letter or a digit
    Return
    Boolean true if code point is a letter or a digit

    isLowSurrogate

    Added in API level 33
    static fun isLowSurrogate(codePoint: Int): Boolean

    Same as Character#isLowSurrogate, except that the ICU version accepts int for code points.

    Parameters
    codePoint Int: the code point to check (In ICU 3.0-69 the type of this parameter was char.)
    Return
    Boolean true if codePoint is a low (trail) surrogate

    isLowSurrogate

    Added in API level 24
    static fun isLowSurrogate(ch: Char): Boolean

    Same as Character#isLowSurrogate,

    Parameters
    ch Char: the char to check
    Return
    Boolean true if ch is a low (trail) surrogate

    isLowerCase

    Added in API level 24
    static fun isLowerCase(ch: Int): Boolean

    Determines if the specified code point is a lowercase character. UnicodeData only contains case mappings for code points where they are one-to-one mappings; it also omits information about context-sensitive case mappings.
    For more information about Unicode case mapping please refer to the Technical report #21.
    Up-to-date Unicode implementation of java.lang.Character.isLowerCase()

    Parameters
    ch Int: code point to determine if it is in lowercase
    Return
    Boolean true if code point is a lowercase character

    isMirrored

    Added in API level 24
    static fun isMirrored(ch: Int): Boolean

    Determines whether the code point has the "mirrored" property. This property is set for characters that are commonly used in Right-To-Left contexts and need to be displayed with a "mirrored" glyph.

    Parameters
    ch Int: code point whose mirror is to be determined
    Return
    Boolean true if the code point has the "mirrored" property

    isPrintable

    Added in API level 24
    static fun isPrintable(ch: Int): Boolean

    [icu] Determines whether the specified code point is a printable character according to the Unicode standard.

    Parameters
    ch Int: code point to be determined if it is printable
    Return
    Boolean true if the code point is a printable character

    isSpaceChar

    Added in API level 24
    static fun isSpaceChar(ch: Int): Boolean

    Determines if the specified code point is a Unicode specified space character, i.e. if code point is in the category Zs, Zl and Zp. Up-to-date Unicode implementation of java.lang.Character.isSpaceChar().

    Parameters
    ch Int: code point to determine if it is a space
    Return
    Boolean true if the specified code point is a space character

    isSupplementary

    Added in API level 24
    static fun isSupplementary(ch: Int): Boolean

    [icu] Determines if the code point is a supplementary character. A code point is a supplementary character if and only if it is greater than SUPPLEMENTARY_MIN_VALUE

    Parameters
    ch Int: code point to be determined if it is in the supplementary plane
    Return
    Boolean true if code point is a supplementary character

    isSupplementaryCodePoint

    Added in API level 24
    static fun isSupplementaryCodePoint(cp: Int): Boolean

    Same as Character#isSupplementaryCodePoint.

    Parameters
    cp Int: the code point to check
    Return
    Boolean true if cp is a supplementary code point

    isSurrogatePair

    Added in API level 33
    static fun isSurrogatePair(
        high: Int,
        low: Int
    ): Boolean

    Same as Character#isSurrogatePair, except that the ICU version accepts int for code points.

    Parameters
    high Int: the high (lead) unit (In ICU 3.0-69 the type of both parameters was char.)
    low Int: the low (trail) unit
    Return
    Boolean true if high, low form a surrogate pair

    isSurrogatePair

    Added in API level 24
    static fun isSurrogatePair(
        high: Char,
        low: Char
    ): Boolean

    Same as Character#isSurrogatePair.

    Parameters
    high Char: the high (lead) char
    low Char: the low (trail) char
    Return
    Boolean true if high, low form a surrogate pair

    isTitleCase

    Added in API level 24
    static fun isTitleCase(ch: Int): Boolean

    Determines if the specified code point is a titlecase character. UnicodeData only contains case mappings for code points where they are one-to-one mappings; it also omits information about context-sensitive case mappings.
    For more information about Unicode case mapping please refer to the Technical report #21.
    Up-to-date Unicode implementation of java.lang.Character.isTitleCase().

    Parameters
    ch Int: code point to determine if it is in title case
    Return
    Boolean true if the specified code point is a titlecase character

    isUAlphabetic

    Added in API level 24
    static fun isUAlphabetic(ch: Int): Boolean

    [icu]

    Check if a code point has the Alphabetic Unicode property.

    Same as UCharacter.hasBinaryProperty(ch, UProperty.ALPHABETIC).

    Different from UCharacter.isLetter(ch)!

    Parameters
    ch Int: codepoint to be tested

    isULowercase

    Added in API level 24
    static fun isULowercase(ch: Int): Boolean

    [icu]

    Check if a code point has the Lowercase Unicode property.

    Same as UCharacter.hasBinaryProperty(ch, UProperty.LOWERCASE).

    This is different from UCharacter.isLowerCase(ch)!

    Parameters
    ch Int: codepoint to be tested

    isUUppercase

    Added in API level 24
    static fun isUUppercase(ch: Int): Boolean

    [icu]

    Check if a code point has the Uppercase Unicode property.

    Same as UCharacter.hasBinaryProperty(ch, UProperty.UPPERCASE).

    This is different from UCharacter.isUpperCase(ch)!

    Parameters
    ch Int: codepoint to be tested

    isUWhiteSpace

    Added in API level 24
    static fun isUWhiteSpace(ch: Int): Boolean

    [icu]

    Check if a code point has the White_Space Unicode property.

    Same as UCharacter.hasBinaryProperty(ch, UProperty.WHITE_SPACE).

    This is different from both UCharacter.isSpace(ch) and UCharacter.isWhitespace(ch)!

    Parameters
    ch Int: codepoint to be tested

    isUnicodeIdentifierPart

    Added in API level 24
    static fun isUnicodeIdentifierPart(ch: Int): Boolean

    Determines if the specified character is permissible as a non-initial character of an identifier according to UAX #31 Unicode Identifier and Pattern Syntax.

    Same as Unicode ID_Continue (UProperty#ID_CONTINUE).

    Note that this differs from java.lang.Character#isUnicodeIdentifierPart(char) which implements a different identifier profile.

    Parameters
    ch Int: the code point to be tested
    Return
    Boolean true if the code point may occur as a non-initial character of an identifier

    isUnicodeIdentifierStart

    Added in API level 24
    static fun isUnicodeIdentifierStart(ch: Int): Boolean

    Determines if the specified character is permissible as the first character in an identifier according to UAX #31 Unicode Identifier and Pattern Syntax.

    Same as Unicode ID_Start (UProperty#ID_START).

    Note that this differs from java.lang.Character#isUnicodeIdentifierStart(char) which implements a different identifier profile.

    Parameters
    ch Int: the code point to be tested
    Return
    Boolean true if the code point may start an identifier

    isUpperCase

    Added in API level 24
    static fun isUpperCase(ch: Int): Boolean

    Determines if the specified code point is an uppercase character. UnicodeData only contains case mappings for code point where they are one-to-one mappings; it also omits information about context-sensitive case mappings.
    For language specific case conversion behavior, use toUpperCase(locale, str).
    For example, the case conversion for dot-less i and dotted I in Turkish, or for final sigma in Greek. For more information about Unicode case mapping please refer to the Technical report #21.
    Up-to-date Unicode implementation of java.lang.Character.isUpperCase().

    Parameters
    ch Int: code point to determine if it is in uppercase
    Return
    Boolean true if the code point is an uppercase character

    isValidCodePoint

    Added in API level 24
    static fun isValidCodePoint(cp: Int): Boolean

    Equivalent to Character#isValidCodePoint.

    Parameters
    cp Int: the code point to check
    Return
    Boolean true if cp is a valid code point

    isWhitespace

    Added in API level 24
    static fun isWhitespace(ch: Int): Boolean

    Determines if the specified code point is a white space character. A code point is considered to be an whitespace character if and only if it satisfies one of the following criteria:

    • It is a Unicode Separator character (categories "Z" = "Zs" or "Zl" or "Zp"), but is not also a non-breaking space (\u00A0 or \u2007 or \u202F).
    • It is \u0009, HORIZONTAL TABULATION.
    • It is \u000A, LINE FEED.
    • It is \u000B, VERTICAL TABULATION.
    • It is \u000C, FORM FEED.
    • It is \u000D, CARRIAGE RETURN.
    • It is \u001C, FILE SEPARATOR.
    • It is \u001D, GROUP SEPARATOR.
    • It is \u001E, RECORD SEPARATOR.
    • It is \u001F, UNIT SEPARATOR.
    This API tries to sync with the semantics of Java's java.lang.Character.isWhitespace(), but it may not return the exact same results because of the Unicode version difference.

    Note: Unicode 4.0.1 changed U+200B ZERO WIDTH SPACE from a Space Separator (Zs) to a Format Control (Cf). Since then, isWhitespace(0x200b) returns false. See http://www.unicode.org/versions/Unicode4.0.1/

    Parameters
    ch Int: code point to determine if it is a white space
    Return
    Boolean true if the specified code point is a white space character

    offsetByCodePoints

    Added in API level 24
    static fun offsetByCodePoints(
        text: CharSequence!,
        index: Int,
        codePointOffset: Int
    ): Int

    Equivalent to the Character#offsetByCodePoints(CharSequence, int, int) method, for convenience. Adjusts the char index by a code point offset.

    Parameters
    text CharSequence!: the characters to check
    index Int: the index to adjust
    codePointOffset Int: the number of code points by which to offset the index
    Return
    Int the adjusted index

    offsetByCodePoints

    Added in API level 24
    static fun offsetByCodePoints(
        text: CharArray!,
        start: Int,
        count: Int,
        index: Int,
        codePointOffset: Int
    ): Int

    Equivalent to the Character#offsetByCodePoints(char[], int, int, int, int) method, for convenience. Adjusts the char index by a code point offset.

    Parameters
    text CharArray!: the characters to check
    start Int: the start of the range to check
    count Int: the length of the range to check
    index Int: the index to adjust
    codePointOffset Int: the number of code points by which to offset the index
    Return
    Int the adjusted index

    toChars

    Added in API level 24
    static fun toChars(
        cp: Int,
        dst: CharArray!,
        dstIndex: Int
    ): Int

    Same as Character#toChars(int, char[], int). Writes the chars representing the code point into the destination at the given index.

    Parameters
    cp Int: the code point to convert
    dst CharArray!: the destination array into which to put the char(s) representing the code point
    dstIndex Int: the index at which to put the first (or only) char
    Return
    Int the count of the number of chars written (1 or 2)
    Exceptions
    java.lang.IllegalArgumentException if cp is not a valid code point

    toChars

    Added in API level 24
    static fun toChars(cp: Int): CharArray!

    Same as Character#toChars(int). Returns a char array representing the code point.

    Parameters
    cp Int: the code point to convert
    Return
    CharArray! an array containing the char(s) representing the code point
    Exceptions
    java.lang.IllegalArgumentException if cp is not a valid code point

    toCodePoint

    Added in API level 33
    static fun toCodePoint(
        high: Int,
        low: Int
    ): Int

    Same as Character#toCodePoint, except that the ICU version accepts int for code points. Returns the code point represented by the two surrogate code units. This does not check the surrogate pair for validity.

    Parameters
    high Int: the high (lead) surrogate (In ICU 3.0-69 the type of both parameters was char.)
    low Int: the low (trail) surrogate
    Return
    Int the code point formed by the surrogate pair

    toCodePoint

    Added in API level 24
    static fun toCodePoint(
        high: Char,
        low: Char
    ): Int

    Same as Character#toCodePoint. Returns the code point represented by the two surrogate code units. This does not check the surrogate pair for validity.

    Parameters
    high Char: the high (lead) surrogate
    low Char: the low (trail) surrogate
    Return
    Int the code point formed by the surrogate pair

    toLowerCase

    Added in API level 24
    static fun toLowerCase(ch: Int): Int

    The given code point is mapped to its lowercase equivalent; if the code point has no lowercase equivalent, the code point itself is returned. Up-to-date Unicode implementation of java.lang.Character.toLowerCase()

    This function only returns the simple, single-code point case mapping. Full case mappings should be used whenever possible because they produce better results by working on whole strings. They take into account the string context and the language and can map to a result string with a different length as appropriate. Full case mappings are applied by the case mapping functions that take String parameters rather than code points (int). See also the User Guide chapter on C/POSIX migration: https://unicode-org.github.io/icu/userguide/icu/posix#case-mappings

    Parameters
    ch Int: code point whose lowercase equivalent is to be retrieved
    Return
    Int the lowercase equivalent code point

    toLowerCase

    Added in API level 24
    static fun toLowerCase(str: String!): String!

    Returns the lowercase version of the argument string. Casing is dependent on the default locale and context-sensitive

    Parameters
    str String!: source string to be performed on
    Return
    String! lowercase version of the argument string

    toLowerCase

    Added in API level 24
    static fun toLowerCase(
        locale: Locale!,
        str: String!
    ): String!

    Returns the lowercase version of the argument string. Casing is dependent on the argument locale and context-sensitive

    Parameters
    locale Locale!: which string is to be converted in
    str String!: source string to be performed on
    Return
    String! lowercase version of the argument string

    toLowerCase

    Added in API level 24
    static fun toLowerCase(
        locale: ULocale!,
        str: String!
    ): String!

    Returns the lowercase version of the argument string. Casing is dependent on the argument locale and context-sensitive

    Parameters
    locale ULocale!: which string is to be converted in
    str String!: source string to be performed on
    Return
    String! lowercase version of the argument string

    toString

    Added in API level 24
    static fun toString(ch: Int): String!

    Converts argument code point and returns a String object representing the code point's value in UTF-16 format. The result is a string whose length is 1 for BMP code points, 2 for supplementary ones.

    Up-to-date Unicode implementation of java.lang.Character.toString().

    Parameters
    ch Int: code point
    Return
    String! string representation of the code point, null if code point is not defined in unicode

    toTitleCase

    Added in API level 24
    static fun toTitleCase(ch: Int): Int

    Converts the code point argument to titlecase. If no titlecase is available, the uppercase is returned. If no uppercase is available, the code point itself is returned. Up-to-date Unicode implementation of java.lang.Character.toTitleCase()

    This function only returns the simple, single-code point case mapping. Full case mappings should be used whenever possible because they produce better results by working on whole strings. They take into account the string context and the language and can map to a result string with a different length as appropriate. Full case mappings are applied by the case mapping functions that take String parameters rather than code points (int). See also the User Guide chapter on C/POSIX migration: https://unicode-org.github.io/icu/userguide/icu/posix#case-mappings

    Parameters
    ch Int: code point whose title case is to be retrieved
    Return
    Int titlecase code point

    toTitleCase

    Added in API level 24
    static fun toTitleCase(
        str: String!,
        breakiter: BreakIterator!
    ): String!

    Returns the titlecase version of the argument string.

    Position for titlecasing is determined by the argument break iterator, hence the user can customize his break iterator for a specialized titlecasing. In this case only the forward iteration needs to be implemented. If the break iterator passed in is null, the default Unicode algorithm will be used to determine the titlecase positions.

    Only positions returned by the break iterator will be title cased, character in between the positions will all be in lower case.

    Casing is dependent on the default locale and context-sensitive

    Parameters
    str String!: source string to be performed on
    breakiter BreakIterator!: break iterator to determine the positions in which the character should be title cased.
    Return
    String! titlecase version of the argument string

    toTitleCase

    Added in API level 24
    static fun toTitleCase(
        locale: Locale!,
        str: String!,
        breakiter: BreakIterator!
    ): String!

    Returns the titlecase version of the argument string.

    Position for titlecasing is determined by the argument break iterator, hence the user can customize his break iterator for a specialized titlecasing. In this case only the forward iteration needs to be implemented. If the break iterator passed in is null, the default Unicode algorithm will be used to determine the titlecase positions.

    Only positions returned by the break iterator will be title cased, character in between the positions will all be in lower case.

    Casing is dependent on the argument locale and context-sensitive

    Parameters
    locale Locale!: which string is to be converted in
    str String!: source string to be performed on
    breakiter BreakIterator!: break iterator to determine the positions in which the character should be title cased.
    Return
    String! titlecase version of the argument string

    toTitleCase

    Added in API level 24
    static fun toTitleCase(
        locale: ULocale!,
        str: String!,
        titleIter: BreakIterator!
    ): String!

    Returns the titlecase version of the argument string.

    Position for titlecasing is determined by the argument break iterator, hence the user can customize his break iterator for a specialized titlecasing. In this case only the forward iteration needs to be implemented. If the break iterator passed in is null, the default Unicode algorithm will be used to determine the titlecase positions.

    Only positions returned by the break iterator will be title cased, character in between the positions will all be in lower case.

    Casing is dependent on the argument locale and context-sensitive

    Parameters
    locale ULocale!: which string is to be converted in
    str String!: source string to be performed on
    titleIter BreakIterator!: break iterator to determine the positions in which the character should be title cased.
    Return
    String! titlecase version of the argument string

    toTitleCase

    Added in API level 24
    static fun toTitleCase(
        locale: ULocale!,
        str: String!,
        titleIter: BreakIterator!,
        options: Int
    ): String!

    Returns the titlecase version of the argument string.

    Position for titlecasing is determined by the argument break iterator, hence the user can customize his break iterator for a specialized titlecasing. In this case only the forward iteration needs to be implemented. If the break iterator passed in is null, the default Unicode algorithm will be used to determine the titlecase positions.

    Only positions returned by the break iterator will be title cased, character in between the positions will all be in lower case.

    Casing is dependent on the argument locale and context-sensitive

    Parameters
    locale ULocale!: which string is to be converted in
    str String!: source string to be performed on
    titleIter BreakIterator!: break iterator to determine the positions in which the character should be title cased.
    options Int: bit set to modify the titlecasing operation
    Return
    String! titlecase version of the argument string

    toTitleCase

    Added in API level 24
    static fun toTitleCase(
        locale: Locale!,
        str: String!,
        titleIter: BreakIterator!,
        options: Int
    ): String!

    [icu]

    Returns the titlecase version of the argument string.

    Position for titlecasing is determined by the argument break iterator, hence the user can customize his break iterator for a specialized titlecasing. In this case only the forward iteration needs to be implemented. If the break iterator passed in is null, the default Unicode algorithm will be used to determine the titlecase positions.

    Only positions returned by the break iterator will be title cased, character in between the positions will all be in lower case.

    Casing is dependent on the argument locale and context-sensitive

    Parameters
    locale Locale!: which string is to be converted in
    str String!: source string to be performed on
    titleIter BreakIterator!: break iterator to determine the positions in which the character should be title cased.
    options Int: bit set to modify the titlecasing operation
    Return
    String! titlecase version of the argument string

    toUpperCase

    Added in API level 24
    static fun toUpperCase(ch: Int): Int

    Converts the character argument to uppercase. If no uppercase is available, the character itself is returned. Up-to-date Unicode implementation of java.lang.Character.toUpperCase()

    This function only returns the simple, single-code point case mapping. Full case mappings should be used whenever possible because they produce better results by working on whole strings. They take into account the string context and the language and can map to a result string with a different length as appropriate. Full case mappings are applied by the case mapping functions that take String parameters rather than code points (int). See also the User Guide chapter on C/POSIX migration: https://unicode-org.github.io/icu/userguide/icu/posix#case-mappings

    Parameters
    ch Int: code point whose uppercase is to be retrieved
    Return
    Int uppercase code point

    toUpperCase

    Added in API level 24
    static fun toUpperCase(str: String!): String!

    Returns the uppercase version of the argument string. Casing is dependent on the default locale and context-sensitive.

    Parameters
    str String!: source string to be performed on
    Return
    String! uppercase version of the argument string

    toUpperCase

    Added in API level 24
    static fun toUpperCase(
        locale: Locale!,
        str: String!
    ): String!

    Returns the uppercase version of the argument string. Casing is dependent on the argument locale and context-sensitive.

    Parameters
    locale Locale!: which string is to be converted in
    str String!: source string to be performed on
    Return
    String! uppercase version of the argument string

    toUpperCase

    Added in API level 24
    static fun toUpperCase(
        locale: ULocale!,
        str: String!
    ): String!

    Returns the uppercase version of the argument string. Casing is dependent on the argument locale and context-sensitive.

    Parameters
    locale ULocale!: which string is to be converted in
    str String!: source string to be performed on
    Return
    String! uppercase version of the argument string