core/org.gnit.lucenekmp.jdkport/Surrogate

Surrogate

object Surrogate

Utility class for dealing with surrogates.

Author

Mark Reinhold

Martin Buchholz

Ulf Zibis

Types

class Generator

Surrogate generation support. Charset implementations may use instances of this class to handle the details of generating UTF-16 surrogate pairs.

class Parser

Surrogate parsing support. Charset implementations may use instances of this class to handle the details of parsing UTF-16 surrogate pairs.

Properties

val MAX_HIGH: Char

val MAX_LOW: Char

val MIN_HIGH: Char

val MIN_LOW: Char

val UCS4_MAX: Int

val UCS4_MIN: Int

Functions

fun high(uc: Int): Char

Returns the high UTF-16 surrogate for the given supplementary UCS-4 character. Use of Character.highSurrogate is generally preferred.

fun is(c: Int): Boolean

Tells whether or not the given value is in the surrogate range. Use of Character.isSurrogate is generally preferred.

fun isHigh(c: Int): Boolean

Tells whether or not the given value is in the high surrogate range. Use of Character.isHighSurrogate is generally preferred.

fun isLow(c: Int): Boolean

Tells whether or not the given value is in the low surrogate range. Use of Character.isLowSurrogate is generally preferred.

fun low(uc: Int): Char

Returns the low UTF-16 surrogate for the given supplementary UCS-4 character. Use of Character.lowSurrogate is generally preferred.

fun neededFor(uc: Int): Boolean

Tells whether or not the given UCS-4 character must be represented as a surrogate pair in UTF-16. Use of Character.isSupplementaryCodePoint is generally preferred.

fun toUCS4(c: Char, d: Char): Int

Converts the given surrogate pair into a 32-bit UCS-4 character. Use of Character.toCodePoint is generally preferred.