kotlin-stdlib/kotlin/Char

Char

class Char : Comparable<Char> (source)

Represents a 16-bit Unicode character.

On the JVM, non-nullable values of this type are represented as values of the primitive type char.

Since Kotlin

1.0
class Char : Comparable<Char> (source)

Represents a 16-bit Unicode character.

Since Kotlin

1.3

Types

Link copied to clipboard
object Companion
Since Kotlin 1.0
object Companion
Since Kotlin 1.3

Properties

Link copied to clipboard
actual val Char.category: CharCategory

Returns the Unicode general category of this character.

Since Kotlin 1.0
actual val Char.category: CharCategory

Returns the Unicode general category of this character.

Since Kotlin 1.3
Link copied to clipboard
val Char.directionality: CharDirectionality

Returns the Unicode directionality property for the given character.

Since Kotlin 1.0

Functions

Link copied to clipboard
open operator override fun compareTo(other: Char): Int

Compares this value with the specified value for order.

Since Kotlin 1.0
open operator external override fun compareTo(other: Char): Int

Compares this value with the specified value for order.

Since Kotlin 1.3
Link copied to clipboard
operator fun dec(): Char

Returns this value decremented by one.

Since Kotlin 1.0
operator external fun dec(): Char

Returns this value decremented by one.

Since Kotlin 1.3
Link copied to clipboard
infix fun Char.downTo(to: Char): CharProgression

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

Since Kotlin 1.0
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
fun equals(other: Char): Boolean
Since Kotlin 1.3
Link copied to clipboard
fun Char.equals(other: Char, ignoreCase: Boolean = false): Boolean

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

Since Kotlin 1.0
Link copied to clipboard
open override fun hashCode(): Int
Since Kotlin 1.3
Link copied to clipboard
operator fun inc(): Char

Returns this value incremented by one.

Since Kotlin 1.0
operator external fun inc(): Char

Returns this value incremented by one.

Since Kotlin 1.3
Link copied to clipboard
actual inline fun Char.isDefined(): Boolean

Returns true if this character (Unicode code point) is defined in Unicode.

Since Kotlin 1.0
actual fun Char.isDefined(): Boolean

Returns true if this character (Unicode code point) is defined in Unicode.

Since Kotlin 1.3
Link copied to clipboard
actual inline fun Char.isDigit(): Boolean

Returns true if this character is a digit.

Since Kotlin 1.0
actual fun Char.isDigit(): Boolean

Returns true if this character is a digit.

Since Kotlin 1.3
Link copied to clipboard
expect fun Char.isHighSurrogate(): Boolean
Since Kotlin 1.0
actual fun Char.isHighSurrogate(): Boolean

Returns true if this character is a Unicode high-surrogate code unit (also known as leading-surrogate code unit).

Since Kotlin 1.1
actual inline fun Char.isHighSurrogate(): Boolean

Returns true if this character is a Unicode high-surrogate code unit (also known as leading-surrogate code unit).

Since Kotlin 1.0
actual external fun Char.isHighSurrogate(): Boolean

Returns true if this character is a Unicode high-surrogate code unit (also known as leading-surrogate code unit).

Since Kotlin 1.3
Link copied to clipboard
inline fun Char.isIdentifierIgnorable(): Boolean

Returns true if this character (Unicode code point) should be regarded as an ignorable character in a Java identifier or a Unicode identifier.

Since Kotlin 1.0
external fun Char.isIdentifierIgnorable(): Boolean

Returns true if this character (Unicode code point) should be regarded as an ignorable character in a Java identifier or a Unicode identifier.

Since Kotlin 1.3
Link copied to clipboard
actual inline fun Char.isISOControl(): Boolean

Returns true if this character is an ISO control character.

Since Kotlin 1.0
actual external fun Char.isISOControl(): Boolean

Returns true if this character is an ISO control character.

Since Kotlin 1.3
Link copied to clipboard
inline fun Char.isJavaIdentifierPart(): Boolean

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

Since Kotlin 1.0
Link copied to clipboard
inline fun Char.isJavaIdentifierStart(): Boolean

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

Since Kotlin 1.0
Link copied to clipboard
actual inline fun Char.isLetter(): Boolean

Returns true if this character is a letter.

Since Kotlin 1.0
actual fun Char.isLetter(): Boolean

Returns true if this character is a letter.

Since Kotlin 1.3
Link copied to clipboard
actual inline fun Char.isLetterOrDigit(): Boolean

Returns true if this character is a letter or digit.

Since Kotlin 1.0
actual fun Char.isLetterOrDigit(): Boolean

Returns true if this character is a letter or digit.

Since Kotlin 1.3
Link copied to clipboard
actual inline fun Char.isLowerCase(): Boolean

Returns true if this character is lower case.

Since Kotlin 1.0
actual fun Char.isLowerCase(): Boolean

Returns true if this character is lower case.

Since Kotlin 1.3
Link copied to clipboard
expect fun Char.isLowSurrogate(): Boolean
Since Kotlin 1.0
actual fun Char.isLowSurrogate(): Boolean

Returns true if this character is a Unicode low-surrogate code unit (also known as trailing-surrogate code unit).

Since Kotlin 1.1
actual inline fun Char.isLowSurrogate(): Boolean

Returns true if this character is a Unicode low-surrogate code unit (also known as trailing-surrogate code unit).

Since Kotlin 1.0
actual external fun Char.isLowSurrogate(): Boolean

Returns true if this character is a Unicode low-surrogate code unit (also known as trailing-surrogate code unit).

Since Kotlin 1.3
Link copied to clipboard
fun Char.isSurrogate(): Boolean

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

Since Kotlin 1.0
Link copied to clipboard
actual inline fun Char.isTitleCase(): Boolean

Returns true if this character is a title case letter.

Since Kotlin 1.0
Link copied to clipboard
actual inline fun Char.isUpperCase(): Boolean

Returns true if this character is upper case.

Since Kotlin 1.0
actual fun Char.isUpperCase(): Boolean

Returns true if this character is upper case.

Since Kotlin 1.3
Link copied to clipboard
expect fun Char.isWhitespace(): Boolean

Determines whether a character is whitespace according to the Unicode standard. Returns true if the character is whitespace.

Since Kotlin 1.0
actual fun Char.isWhitespace(): Boolean

Determines whether a character is whitespace according to the Unicode standard. Returns true if the character is whitespace.

Since Kotlin 1.1
actual fun Char.isWhitespace(): Boolean

Determines whether a character is whitespace according to the Unicode standard. Returns true if the character is whitespace.

Since Kotlin 1.0
actual fun Char.isWhitespace(): Boolean

Determines whether a character is whitespace according to the Unicode standard. Returns true if the character is whitespace.

Since Kotlin 1.3
Link copied to clipboard
operator fun minus(other: Char): Int

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

Since Kotlin 1.0
operator fun minus(other: Int): Char

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

Since Kotlin 1.0
inline operator fun minus(other: Char): Int

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

Since Kotlin 1.3
inline operator fun minus(other: Int): Char

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

Since Kotlin 1.3
Link copied to clipboard
operator fun plus(other: Int): Char

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

Since Kotlin 1.0
inline operator fun plus(other: Int): Char

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

Since Kotlin 1.3
Link copied to clipboard
inline operator fun Char.plus(other: String): String

Concatenates this Char and a String.

Since Kotlin 1.0
Link copied to clipboard
operator fun rangeTo(other: Char): CharRange

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

Since Kotlin 1.0
operator fun rangeTo(other: Char): CharRange

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

Since Kotlin 1.3
Link copied to clipboard
fun toByte(): Byte

Returns the value of this character as a Byte.

Since Kotlin 1.0
external fun toByte(): Byte

Returns the value of this character as a Byte.

Since Kotlin 1.3
Link copied to clipboard
fun toChar(): Char

Returns the value of this character as a Char.

Since Kotlin 1.0
inline fun toChar(): Char

Returns the value of this character as a Char.

Since Kotlin 1.3
Link copied to clipboard
fun toDouble(): Double

Returns the value of this character as a Double.

Since Kotlin 1.0
external fun toDouble(): Double

Returns the value of this character as a Double.

Since Kotlin 1.3
Link copied to clipboard
fun toFloat(): Float

Returns the value of this character as a Float.

Since Kotlin 1.0
external fun toFloat(): Float

Returns the value of this character as a Float.

Since Kotlin 1.3
Link copied to clipboard
fun toInt(): Int

Returns the value of this character as a Int.

Since Kotlin 1.0
external fun toInt(): Int

Returns the value of this character as a Int.

Since Kotlin 1.3
Link copied to clipboard
fun toLong(): Long

Returns the value of this character as a Long.

Since Kotlin 1.0
external fun toLong(): Long

Returns the value of this character as a Long.

Since Kotlin 1.3
Link copied to clipboard
expect fun Char.toLowerCase(): Char

Converts this character to lower case using Unicode mapping rules of the invariant locale.

Since Kotlin 1.0
actual inline fun Char.toLowerCase(): Char

Converts this character to lower case using Unicode mapping rules of the invariant locale.

Since Kotlin 1.1
actual inline fun Char.toLowerCase(): Char

Converts this character to lower case using Unicode mapping rules of the invariant locale.

Since Kotlin 1.0
actual fun Char.toLowerCase(): Char

Converts this character to lower case using Unicode mapping rules of the invariant locale.

Since Kotlin 1.3
Link copied to clipboard
fun toShort(): Short

Returns the value of this character as a Short.

Since Kotlin 1.0
external fun toShort(): Short

Returns the value of this character as a Short.

Since Kotlin 1.3
Link copied to clipboard
open external override fun toString(): String
Since Kotlin 1.3
Link copied to clipboard
inline fun Char.toTitleCase(): Char

Converts this character to title case using Unicode mapping rules of the invariant locale.

Since Kotlin 1.0
Link copied to clipboard
expect fun Char.toUpperCase(): Char

Converts this character to upper case using Unicode mapping rules of the invariant locale.

Since Kotlin 1.0
actual inline fun Char.toUpperCase(): Char

Converts this character to upper case using Unicode mapping rules of the invariant locale.

Since Kotlin 1.1
actual inline fun Char.toUpperCase(): Char

Converts this character to upper case using Unicode mapping rules of the invariant locale.

Since Kotlin 1.0
actual fun Char.toUpperCase(): Char

Converts this character to upper case using Unicode mapping rules of the invariant locale.

Since Kotlin 1.3
Link copied to clipboard
infix fun Char.until(to: Char): CharRange

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

Since Kotlin 1.0