azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[stdlib] KT-55619 provide samples and extend documentation for String.format

Browse Source
This commit is contained in:
Ilya Gorbunov
2023-11-21 22:14:20 +01:00
committed by Space Team
parent b1465fbfb8
commit 28c1049518
2 changed files with 66 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/stdlib/jvm/src/kotlin/text/StringsJVM.kt
+28 -4
View File
@@ -325,30 +325,54 @@ public actual inline fun String.toCharArray(
}
/**
* Uses this string as a format string and returns a string obtained by substituting the specified arguments,
* Uses this string as a format string and returns a string obtained
* by substituting format specifiers in the format string with the provided arguments,
* using the default locale.
*
* See [java.util.Formatter] class documentation
* for the syntax of format specifiers for the format string.
*
* @sample samples.text.Strings.formatExtension
*/
@kotlin.internal.InlineOnly
public inline fun String.format(vararg args: Any?): String = java.lang.String.format(this, *args)
/**
* Uses the provided [format] as a format string and returns a string obtained by substituting the specified arguments,
* Uses the provided [format] as a format string and returns a string obtained
* by substituting format specifiers in the format string with the provided arguments,
* using the default locale.
*
* See [java.util.Formatter] class documentation
* for the syntax of format specifiers for the format string.
*
* @sample samples.text.Strings.formatStatic
*/
@kotlin.internal.InlineOnly
public inline fun String.Companion.format(format: String, vararg args: Any?): String = java.lang.String.format(format, *args)
/**
* Uses this string as a format string and returns a string obtained by substituting the specified arguments,
* Uses this string as a format string and returns a string obtained
* by substituting format specifiers in the format string with the provided arguments,
* using the specified locale. If [locale] is `null` then no localization is applied.
*
* See [java.util.Formatter] class documentation
* for the syntax of format specifiers for the format string.
*
* @sample samples.text.Strings.formatWithLocaleExtension
*/
@SinceKotlin("1.4")
@kotlin.internal.InlineOnly
public inline fun String.format(locale: Locale?, vararg args: Any?): String = java.lang.String.format(locale, this, *args)
/**
* Uses the provided [format] as a format string and returns a string obtained by substituting the specified arguments,
* Uses the provided [format] as a format string and returns a string obtained
* by substituting format specifiers in the format string with the provided arguments,
* using the specified locale. If [locale] is `null` then no localization is applied.
*
* See [java.util.Formatter] class documentation
* for the syntax of format specifiers for the format string.
*
* @sample samples.text.Strings.formatWithLocaleStatic
*/
@SinceKotlin("1.4")
@kotlin.internal.InlineOnly