Document IllegalArgumentException thrown from string-number conversion

functions when an invalid radix is specified
#KT-17635 Fixed
This commit is contained in:
Ilya Gorbunov
2017-04-28 17:58:10 +03:00
parent cffdd3fd26
commit 8da4839f22
2 changed files with 40 additions and 0 deletions
@@ -27,6 +27,7 @@ public fun String.toByte(): Byte = toByteOrNull() ?: numberFormatError(this)
/**
* Parses the string as a signed [Byte] number and returns the result.
* @throws NumberFormatException if the string is not a valid representation of a number.
* @throws IllegalArgumentException when [radix] is not a valid radix for string to number conversion.
*/
public fun String.toByte(radix: Int): Byte = toByteOrNull(radix) ?: numberFormatError(this)
@@ -40,6 +41,7 @@ public fun String.toShort(): Short = toShortOrNull() ?: numberFormatError(this)
/**
* Parses the string as a [Short] number and returns the result.
* @throws NumberFormatException if the string is not a valid representation of a number.
* @throws IllegalArgumentException when [radix] is not a valid radix for string to number conversion.
*/
public fun String.toShort(radix: Int): Short = toShortOrNull(radix) ?: numberFormatError(this)
@@ -52,6 +54,7 @@ public fun String.toInt(): Int = toIntOrNull() ?: numberFormatError(this)
/**
* Parses the string as an [Int] number and returns the result.
* @throws NumberFormatException if the string is not a valid representation of a number.
* @throws IllegalArgumentException when [radix] is not a valid radix for string to number conversion.
*/
public fun String.toInt(radix: Int): Int = toIntOrNull(radix) ?: numberFormatError(this)
@@ -64,6 +67,7 @@ public fun String.toLong(): Long = toLongOrNull() ?: numberFormatError(this)
/**
* Parses the string as a [Long] number and returns the result.
* @throws NumberFormatException if the string is not a valid representation of a number.
* @throws IllegalArgumentException when [radix] is not a valid radix for string to number conversion.
*/
public fun String.toLong(radix: Int): Long = toLongOrNull(radix) ?: numberFormatError(this)