Destructured

Common
JVM
JS
Native
1.0
class Destructured

Provides components for destructuring assignment of group values.

component1 corresponds to the value of the first group, component2 — of the second, and so on.

If the group in the regular expression is optional and there were no match captured by that group, corresponding component value is an empty string.

import kotlin.test.*
import java.util.*

fun main(args: Array<String>) {
//sampleStart
val inputString = "John 9731879"
val match = Regex("(\\w+) (\\d+)").find(inputString)!!
val (name, phone) = match.destructured

println(name) // John     // value of the first group matched by \w+
println(phone) // 9731879 // value of the second group matched by \d+

// group with the zero index is the whole substring matched by the regular expression
println(match.groupValues) // [John 9731879, John, 9731879]

val numberedGroupValues = match.destructured.toList()
// destructured group values only contain values of the groups, excluding the zeroth group.
println(numberedGroupValues) // [John, 9731879]
//sampleEnd
}

Properties

Common
JVM
JS
Native
1.0

match

val match: MatchResult

Functions

Common
JVM
JS
Native
1.0

component1

operator fun component1(): String
Common
JVM
JS
Native
1.0

component10

operator fun component10(): String
Common
JVM
JS
Native
1.0

component2

operator fun component2(): String
Common
JVM
JS
Native
1.0

component3

operator fun component3(): String
Common
JVM
JS
Native
1.0

component4

operator fun component4(): String
Common
JVM
JS
Native
1.0

component5

operator fun component5(): String
Common
JVM
JS
Native
1.0

component6

operator fun component6(): String
Common
JVM
JS
Native
1.0

component7

operator fun component7(): String
Common
JVM
JS
Native
1.0

component8

operator fun component8(): String
Common
JVM
JS
Native
1.0

component9

operator fun component9(): String
Common
JVM
JS
Native
1.0

toList

Returns destructured group values as a list of strings. First value in the returned list corresponds to the value of the first group, and so on.

fun toList(): List<String>