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.2
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.

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

Since Kotlin

1.1

Types

Link copied to clipboard
object Companion
Since Kotlin 1.2
object Companion
Since Kotlin 1.0
object Companion
Since Kotlin 1.1

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.2
open operator override fun compareTo(other: Char): Int

Compares this value with the specified value for order.

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

Compares this value with the specified value for order.

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

Returns this value decremented by one.

Since Kotlin 1.2
operator fun dec(): Char

Returns this value decremented by one.

Since Kotlin 1.0
operator fun dec(): Char

Returns this value decremented by one.

Since Kotlin 1.1
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Since Kotlin 1.2
open operator override fun equals(other: Any?): Boolean
Since Kotlin 1.0
open operator override fun equals(other: Any?): Boolean
Since Kotlin 1.1
Link copied to clipboard
operator fun inc(): Char

Returns this value incremented by one.

Since Kotlin 1.2
operator fun inc(): Char

Returns this value incremented by one.

Since Kotlin 1.0
operator fun inc(): Char

Returns this value incremented by one.

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

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

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

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

Since Kotlin 1.2
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
operator fun minus(other: Char): Int

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

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

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

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

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

Since Kotlin 1.2
operator fun plus(other: Int): Char

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

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

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

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

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

Since Kotlin 1.2
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.1
Link copied to clipboard
fun toByte(): Byte

Returns the value of this character as a Byte.

Since Kotlin 1.2
fun toByte(): Byte

Returns the value of this character as a Byte.

Since Kotlin 1.0
fun toByte(): Byte

Returns the value of this character as a Byte.

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

Returns the value of this character as a Char.

Since Kotlin 1.2
fun toChar(): Char

Returns the value of this character as a Char.

Since Kotlin 1.0
fun toChar(): Char

Returns the value of this character as a Char.

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

Returns the value of this character as a Double.

Since Kotlin 1.2
fun toDouble(): Double

Returns the value of this character as a Double.

Since Kotlin 1.0
fun toDouble(): Double

Returns the value of this character as a Double.

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

Returns the value of this character as a Float.

Since Kotlin 1.2
fun toFloat(): Float

Returns the value of this character as a Float.

Since Kotlin 1.0
fun toFloat(): Float

Returns the value of this character as a Float.

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

Returns the value of this character as a Int.

Since Kotlin 1.2
fun toInt(): Int

Returns the value of this character as a Int.

Since Kotlin 1.0
fun toInt(): Int

Returns the value of this character as a Int.

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

Returns the value of this character as a Long.

Since Kotlin 1.2
fun toLong(): Long

Returns the value of this character as a Long.

Since Kotlin 1.0
fun toLong(): Long

Returns the value of this character as a Long.

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

Returns the value of this character as a Short.

Since Kotlin 1.2
fun toShort(): Short

Returns the value of this character as a Short.

Since Kotlin 1.0
fun toShort(): Short

Returns the value of this character as a Short.

Since Kotlin 1.1
Link copied to clipboard
open override fun toString(): String
Since Kotlin 1.2
open override fun toString(): String
Since Kotlin 1.0
open override fun toString(): String
Since Kotlin 1.1

Extensions

Link copied to clipboard
val Char.directionality: CharDirectionality
val Char.directionality: CharDirectionality
val Char.directionality: CharDirectionality

Returns the Unicode directionality property for the given character.

Since Kotlin 1.0
Link copied to clipboard
infix fun Char.downTo(to: Char): CharProgression
infix fun Char.downTo(to: Char): CharProgression
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.2
Link copied to clipboard
fun Char.equals(other: Char, ignoreCase: Boolean = false): Boolean
fun Char.equals(other: Char, ignoreCase: Boolean = false): Boolean
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.2
Link copied to clipboard
expect fun Char.isHighSurrogate(): Boolean
expect fun Char.isHighSurrogate(): Boolean
expect fun Char.isHighSurrogate(): Boolean
Since Kotlin 1.2
actual inline fun Char.isHighSurrogate(): Boolean
actual inline fun Char.isHighSurrogate(): Boolean
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 fun Char.isHighSurrogate(): Boolean
actual fun Char.isHighSurrogate(): Boolean
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
Link copied to clipboard
inline fun Char.isIdentifierIgnorable(): Boolean
inline fun Char.isIdentifierIgnorable(): Boolean
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
Link copied to clipboard
inline fun Char.isJavaIdentifierPart(): Boolean
inline fun Char.isJavaIdentifierPart(): Boolean
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
inline fun Char.isJavaIdentifierStart(): Boolean
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
expect fun Char.isLowSurrogate(): Boolean
expect fun Char.isLowSurrogate(): Boolean
expect fun Char.isLowSurrogate(): Boolean
Since Kotlin 1.2
actual inline fun Char.isLowSurrogate(): Boolean
actual inline fun Char.isLowSurrogate(): Boolean
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 fun Char.isLowSurrogate(): Boolean
actual fun Char.isLowSurrogate(): Boolean
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
Link copied to clipboard
fun Char.isSurrogate(): Boolean
fun Char.isSurrogate(): Boolean
fun Char.isSurrogate(): Boolean

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

Since Kotlin 1.2
Link copied to clipboard
expect fun Char.isWhitespace(): Boolean
expect fun Char.isWhitespace(): Boolean
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.2
actual fun Char.isWhitespace(): Boolean
actual fun Char.isWhitespace(): Boolean
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
actual fun Char.isWhitespace(): Boolean
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
Link copied to clipboard
inline operator fun Char.plus(other: String): String
inline operator fun Char.plus(other: String): String
inline operator fun Char.plus(other: String): String

Concatenates this Char and a String.

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

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

Since Kotlin 1.2
actual inline fun Char.toLowerCase(): Char
actual inline fun Char.toLowerCase(): Char
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 inline fun Char.toLowerCase(): Char
actual inline fun Char.toLowerCase(): Char
actual inline fun Char.toLowerCase(): Char

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

Since Kotlin 1.1
Link copied to clipboard
inline fun Char.toTitleCase(): Char
inline fun Char.toTitleCase(): Char
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
expect fun Char.toUpperCase(): Char
expect fun Char.toUpperCase(): Char

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

Since Kotlin 1.2
actual inline fun Char.toUpperCase(): Char
actual inline fun Char.toUpperCase(): Char
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 inline fun Char.toUpperCase(): Char
actual inline fun Char.toUpperCase(): Char
actual inline fun Char.toUpperCase(): Char

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

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

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

Since Kotlin 1.2