kotlin-stdlib/kotlin.text/toShort

toShort

expect fun String.toShort(): Short(source)

Parses the string to a Short number.

The string must consist of an optional leading + or - sign and decimal digits (0-9), and fit the valid Short value range (within Short.MIN_VALUE..Short.MAX_VALUE), otherwise a NumberFormatException will be thrown.

Since Kotlin

1.0

Throws

if the string is not a valid representation of a Short.

Samples

import kotlin.test.assertFailsWith

fun main() { 
   //sampleStart 
   println("0".toShort()) // 0
println("42".toShort()) // 42
println("042".toShort()) // 42
println("-42".toShort()) // -42
// Short.MAX_VALUE
println("32767".toShort()) // 32767
// Short overflow
// "32768".toShort() // will fail with NumberFormatException
// 'a' is not a digit
// "-1a".toShort() // will fail with NumberFormatException
// underscore
// "1_000".toShort() // will fail with NumberFormatException
// whitespaces
// " 1000 ".toShort() // will fail with NumberFormatException 
   //sampleEnd
}
expect fun String.toShort(radix: Int): Short(source)

Parses the string as a Short number and returns the result.

Since Kotlin

1.0

Throws

if the string is not a valid representation of a number.

when radix is not a valid radix for string to number conversion.

actual fun String.toShort(): Short(source)

Parses the string to a Short number.

The string must consist of an optional leading + or - sign and decimal digits (0-9), and fit the valid Short value range (within Short.MIN_VALUE..Short.MAX_VALUE), otherwise a NumberFormatException will be thrown.

Since Kotlin

1.1

Throws

if the string is not a valid representation of a Short.

Samples

import kotlin.test.assertFailsWith

fun main() { 
   //sampleStart 
   println("0".toShort()) // 0
println("42".toShort()) // 42
println("042".toShort()) // 42
println("-42".toShort()) // -42
// Short.MAX_VALUE
println("32767".toShort()) // 32767
// Short overflow
// "32768".toShort() // will fail with NumberFormatException
// 'a' is not a digit
// "-1a".toShort() // will fail with NumberFormatException
// underscore
// "1_000".toShort() // will fail with NumberFormatException
// whitespaces
// " 1000 ".toShort() // will fail with NumberFormatException 
   //sampleEnd
}
actual fun String.toShort(radix: Int): Short(source)

Parses the string as a Short number and returns the result.

Since Kotlin

1.1

Throws

if the string is not a valid representation of a number.

when radix is not a valid radix for string to number conversion.

actual inline fun String.toShort(): Short(source)

Parses the string to a Short number.

The string must consist of an optional leading + or - sign and decimal digits (0-9), and fit the valid Short value range (within Short.MIN_VALUE..Short.MAX_VALUE), otherwise a NumberFormatException will be thrown.

Since Kotlin

1.0

Throws

if the string is not a valid representation of a Short.

Samples

import kotlin.test.assertFailsWith

fun main() { 
   //sampleStart 
   println("0".toShort()) // 0
println("42".toShort()) // 42
println("042".toShort()) // 42
println("-42".toShort()) // -42
// Short.MAX_VALUE
println("32767".toShort()) // 32767
// Short overflow
// "32768".toShort() // will fail with NumberFormatException
// 'a' is not a digit
// "-1a".toShort() // will fail with NumberFormatException
// underscore
// "1_000".toShort() // will fail with NumberFormatException
// whitespaces
// " 1000 ".toShort() // will fail with NumberFormatException 
   //sampleEnd
}
actual inline fun String.toShort(radix: Int): Short(source)

Parses the string as a Short number and returns the result.

Since Kotlin

1.1

Throws

if the string is not a valid representation of a number.

when radix is not a valid radix for string to number conversion.

actual inline fun String.toShort(): Short(source)

Parses the string to a Short number.

The string must consist of an optional leading + or - sign and decimal digits (0-9), and fit the valid Short value range (within Short.MIN_VALUE..Short.MAX_VALUE), otherwise a NumberFormatException will be thrown.

Since Kotlin

1.3

Throws

if the string is not a valid representation of a Short.

Samples

import kotlin.test.assertFailsWith

fun main() { 
   //sampleStart 
   println("0".toShort()) // 0
println("42".toShort()) // 42
println("042".toShort()) // 42
println("-42".toShort()) // -42
// Short.MAX_VALUE
println("32767".toShort()) // 32767
// Short overflow
// "32768".toShort() // will fail with NumberFormatException
// 'a' is not a digit
// "-1a".toShort() // will fail with NumberFormatException
// underscore
// "1_000".toShort() // will fail with NumberFormatException
// whitespaces
// " 1000 ".toShort() // will fail with NumberFormatException 
   //sampleEnd
}
actual inline fun String.toShort(radix: Int): Short(source)

Parses the string as a Short number and returns the result.

Since Kotlin

1.3

Throws

if the string is not a valid representation of a number.

when radix is not a valid radix for string to number conversion.

actual fun String.toShort(): Short(source)

Parses the string to a Short number.

The string must consist of an optional leading + or - sign and decimal digits (0-9), and fit the valid Short value range (within Short.MIN_VALUE..Short.MAX_VALUE), otherwise a NumberFormatException will be thrown.

Since Kotlin

1.8

Throws

if the string is not a valid representation of a Short.

Samples

import kotlin.test.assertFailsWith

fun main() { 
   //sampleStart 
   println("0".toShort()) // 0
println("42".toShort()) // 42
println("042".toShort()) // 42
println("-42".toShort()) // -42
// Short.MAX_VALUE
println("32767".toShort()) // 32767
// Short overflow
// "32768".toShort() // will fail with NumberFormatException
// 'a' is not a digit
// "-1a".toShort() // will fail with NumberFormatException
// underscore
// "1_000".toShort() // will fail with NumberFormatException
// whitespaces
// " 1000 ".toShort() // will fail with NumberFormatException 
   //sampleEnd
}
actual fun String.toShort(radix: Int): Short(source)

Parses the string as a Short number and returns the result.

Since Kotlin

1.8

Throws

if the string is not a valid representation of a number.

when radix is not a valid radix for string to number conversion.

actual fun String.toShort(): Short(source)

Parses the string to a Short number.

The string must consist of an optional leading + or - sign and decimal digits (0-9), and fit the valid Short value range (within Short.MIN_VALUE..Short.MAX_VALUE), otherwise a NumberFormatException will be thrown.

Since Kotlin

1.8

Throws

if the string is not a valid representation of a Short.

Samples

import kotlin.test.assertFailsWith

fun main() { 
   //sampleStart 
   println("0".toShort()) // 0
println("42".toShort()) // 42
println("042".toShort()) // 42
println("-42".toShort()) // -42
// Short.MAX_VALUE
println("32767".toShort()) // 32767
// Short overflow
// "32768".toShort() // will fail with NumberFormatException
// 'a' is not a digit
// "-1a".toShort() // will fail with NumberFormatException
// underscore
// "1_000".toShort() // will fail with NumberFormatException
// whitespaces
// " 1000 ".toShort() // will fail with NumberFormatException 
   //sampleEnd
}
actual fun String.toShort(radix: Int): Short(source)

Parses the string as a Short number and returns the result.

Since Kotlin

1.8

Throws

if the string is not a valid representation of a number.

when radix is not a valid radix for string to number conversion.