Char

Compares this value with the specified value for order.

fun compareTo(other: Char): Int

Decrements this value.

operator fun dec(): Char

Indicates whether some other object is "equal to" this one. Implementations must fulfil the following requirements:

fun equals(other: Any?): Boolean

Returns a hash code value for the object. The general contract of hashCode is:

fun hashCode(): Int

Increments this value.

operator fun inc(): Char

Subtracts the other Char value from this value resulting an Int.

operator fun minus(other: Char): Int

Subtracts the other Int value from this value resulting a Char.

operator fun minus(other: Int): Char

Adds the other Int value to this value resulting a Char.

operator fun plus(other: Int): Char

Creates a range from this value to the specified other value.

operator fun rangeTo(other: Char): CharRange

Returns the value of this character as a Byte.

fun toByte(): Byte

Returns the value of this character as a Char.

fun toChar(): Char

Returns the value of this character as a Double.

fun toDouble(): Double

Returns the value of this character as a Float.

fun toFloat(): Float

Returns the value of this character as a Int.

fun toInt(): Int

Returns the value of this character as a Long.

fun toLong(): Long

Returns the value of this character as a Short.

fun toShort(): Short

Returns a string representation of the object.

fun toString(): String

The maximum value of a Unicode code point. Kotlin/Native specific.

const val MAX_CODE_POINT: Int

The maximum value of a Unicode high-surrogate code unit.

const val MAX_HIGH_SURROGATE: Char

The maximum value of a Unicode low-surrogate code unit.

const val MAX_LOW_SURROGATE: Char

The maximum radix available for conversion to and from strings.

const val MAX_RADIX: Int

The maximum value of a Unicode surrogate code unit.

const val MAX_SURROGATE: Char

The maximum value of a character code unit.

const val MAX_VALUE: Char

The minimum value of a Unicode code point. Kotlin/Native specific.

const val MIN_CODE_POINT: Int

The minimum value of a Unicode high-surrogate code unit.

const val MIN_HIGH_SURROGATE: Char

The minimum value of a Unicode low-surrogate code unit.

const val MIN_LOW_SURROGATE: Char

The minimum radix available for conversion to and from strings.

const val MIN_RADIX: Int

The minimum value of a supplementary code point, \u0x10000. Kotlin/Native specific.

const val MIN_SUPPLEMENTARY_CODE_POINT: Int

The minimum value of a Unicode surrogate code unit.

const val MIN_SURROGATE: Char

The minimum value of a character code unit.

const val MIN_VALUE: Char

The number of bits used to represent a Char in a binary form.

const val SIZE_BITS: Int

The number of bytes used to represent a Char in a binary form.

const val SIZE_BYTES: Int

Returns the Unicode directionality property for the given character.

val Char.directionality: CharDirectionality

Ensures that this value is not less than the specified minimumValue.

fun <T : Comparable<T>> T.coerceAtLeast(minimumValue: T): T

Ensures that this value is not greater than the specified maximumValue.

fun <T : Comparable<T>> T.coerceAtMost(maximumValue: T): T

Ensures that this value lies in the specified range minimumValue..maximumValue.

fun <T : Comparable<T>> T.coerceIn(
    minimumValue: T?, 
    maximumValue: T?
): T

Ensures that this value lies in the specified range.

fun <T : Comparable<T>> T.coerceIn(
    range: ClosedFloatingPointRange<T>
): T

fun <T : Comparable<T>> T.coerceIn(range: ClosedRange<T>): T

Returns a progression from this value down to the specified to value with the step -1.

infix fun Char.downTo(to: Char): CharProgression

Returns true if this character is equal to the other character, optionally ignoring character case.

fun Char.equals(
    other: Char, 
    ignoreCase: Boolean = false
): Boolean

Returns true if this character (Unicode code point) may be part of a Java identifier as other than the first character.

fun Char.isJavaIdentifierPart(): Boolean

Returns true if this character is permissible as the first character in a Java identifier.

fun Char.isJavaIdentifierStart(): Boolean

Returns true if this character is a Unicode surrogate code unit.

fun Char.isSurrogate(): Boolean

Returns true if this character is a titlecase character.

fun Char.isTitleCase(): Boolean

Concatenates this Char and a String.

operator fun Char.plus(other: String): String

Creates a range from this Comparable value to the specified that value.

operator fun <T : Comparable<T>> T.rangeTo(
    that: T
): ClosedRange<T>

Converts this character to titlecase.

fun Char.toTitleCase(): Char

Returns a range from this value up to but excluding the specified to value.

infix fun Char.until(to: Char): CharRange

Checks if the codepoint specified is a supplementary codepoint or not.

fun Char.Companion.isSupplementaryCodePoint(
    codepoint: Int
): Boolean

Converts the codepoint specified to a char array. If the codepoint is not supplementary, the method will return an array with one element otherwise it will return an array A with a high surrogate in A0 and a low surrogate in A1.

fun Char.Companion.toChars(codePoint: Int): CharArray

Converts a surrogate pair to a unicode code point. Doesn't validate that the characters are a valid surrogate pair.

fun Char.Companion.toCodePoint(high: Char, low: Char): Int