get

Common

JVM

Native

1.2

operator fun MatchGroupCollection.get(
    name: String
): MatchGroup?

(Common source) (JVM source) (Native source)

Returns a named group with the specified name.

Exceptions

IllegalArgumentException - if there is no group with the specified name defined in the regex pattern.

UnsupportedOperationException - if this match group collection doesn't support getting match groups by name, for example, when it's not supported by the current platform.

Return An instance of MatchGroup if the group with the specified name was matched or null otherwise.

1.7

operator fun <ERROR CLASS>.get(name: String): MatchGroup?
(source)

Returns a named group with the specified name.

Exceptions

IllegalArgumentException - if there is no group with the specified name defined in the regex pattern.

UnsupportedOperationException - if this match group collection doesn't support getting match groups by name, for example, when it's not supported by the current platform.

Return An instance of MatchGroup if the group with the specified name was matched or null otherwise.