Spec-Zone.ru › Kotlin 1.4

Regex

kotlin-stdlib / kotlin.text / Regex
Требования к платформе и версии: JS (1.1), Native (1.3)
class Regex
Требования к платформе и версии: JVM (1.0)
class Regex : Serializable
Для JVM

Представляет скомпилированное регулярное выражение. Предоставляет функции для сопоставления строк в тексте с шаблоном, замены найденных вхождений и разделения текста вокруг совпадений.

Для справки по синтаксису шаблона см. Pattern.

Для JS

Представляет скомпилированное регулярное выражение. Предоставляет функции для сопоставления строк в тексте с шаблоном, замены найденных вхождений и разделения текста вокруг совпадений.

Для справки по синтаксису шаблона см. MDN RegExp и http://www.w3schools.com/jsref/jsref_obj_regexp.asp.

Для Native

Представляет скомпилированное регулярное выражение. Предоставляет функции для сопоставления строк в тексте с шаблоном, замены найденных вхождений и разделения текста вокруг совпадений.

Конструкторы

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

<init>

Создает регулярное выражение из указанной строки шаблона и по умолчанию параметров.

<init>(pattern: String)

Создает регулярное выражение из указанной строки шаблона и указанного единственного параметра.

<init>(pattern: String, option: RegexOption)

Создает регулярное выражение из указанной строки шаблона и указанного набора параметров.

<init>(pattern: String, options: Set<RegexOption>)

Свойства

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

options

Набор параметров, используемых для создания этого регулярного выражения.

val options: Set<RegexOption>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

pattern

Строка шаблона этого регулярного выражения.

val pattern: String

Функции

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

containsMatchIn

Указывает, может ли регулярное выражение найти хотя бы одно совпадение в указанном входном значении.

fun containsMatchIn(input: CharSequence): Boolean

find

Возвращает первое совпадение регулярного выражения в входных данных, начиная с указанного начального индекса.

Требования к платформе и версии: JVM (1.0), JS (1.1)
fun find(
    input: CharSequence, 
    startIndex: Int = 0
): MatchResult?
Требования к платформе и версии: Native (1.3)
fun find(input: CharSequence, startIndex: Int): MatchResult?

findAll

Возвращает последовательность всех вхождений регулярного выражения в строке входных данных, начиная с указанного начального индекса.

Требования к платформе и версии: JVM (1.0), JS (1.1)
fun findAll(
    input: CharSequence, 
    startIndex: Int = 0
): Sequence<MatchResult>
Требования к платформе и версии: Native (1.3)
fun findAll(
    input: CharSequence, 
    startIndex: Int
): Sequence<MatchResult>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

matchEntire

Попытка сопоставить всю входную последовательность символов с шаблоном.

fun matchEntire(input: CharSequence): MatchResult?
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

matches

Указывает, соответствует ли регулярное выражение всей входной строке.

infix fun matches(input: CharSequence): Boolean
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

replace

Заменяет все вхождения этого регулярного выражения в указанной строке входных данных на указанную замену.

fun replace(input: CharSequence, replacement: String): String

Заменяет все вхождения этого регулярного выражения в указанной строке входных данных результатом применения заданной функции преобразования, которая принимает MatchResult и возвращает строку, используемую в качестве замены для этого совпадения.

fun replace(
    input: CharSequence, 
    transform: (MatchResult) -> CharSequence
): String
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

replaceFirst

Заменяет первое вхождение этого регулярного выражения в указанной строке входных данных на указанную замену.

fun replaceFirst(
    input: CharSequence, 
    replacement: String
): String

split

Разделяет последовательность символов входных данных по совпадениям с этим регулярным выражением.

Требования к платформе и версии: JVM (1.0), JS (1.1)
fun split(input: CharSequence, limit: Int = 0): List<String>
Требования к платформе и версии: Native (1.3)
fun split(input: CharSequence, limit: Int): List<String>
Требования к платформе и версии: JVM (1.0)

toPattern

Возвращает экземпляр Pattern с таким же шаблоном и опциями, что и у этого экземпляра Regex.

fun toPattern(): Pattern
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toString

Возвращает строковое представление этого регулярного выражения, а именно шаблон этого регулярного выражения.

fun toString(): String

Функции объекта-компаньона

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

escape

Возвращает строку шаблона регулярного выражения, которая буквально соответствует указанной строке. Ни один символ этой строки не будет иметь специального значения при поиске вхождения регулярного выражения.

fun escape(literal: String): String
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

escapeReplacement

Возвращает литеральную строку замены для указанной строки. Ни один символ этой строки не будет иметь специального значения при использовании ее в качестве строки замены в функции Regex.replace.

fun escapeReplacement(literal: String): String
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

fromLiteral

Возвращает регулярное выражение, которое буквально соответствует указанной строке. Ни один символ этой строки не будет иметь специального значения при поиске вхождения регулярного выражения.

fun fromLiteral(literal: String): Regex

© 2010–2020 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/index.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API