Spec-Zone.ru › Kotlin 1.6

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.

Обратите внимание, что RegExp объекты под капотом создаются с флагом "u", который включает функции, связанные с Юникодом, в регулярных выражениях. Это также делает синтаксис шаблона более строгим, например, запрещает ненужные экранированные последовательности.

Для 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
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

find

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

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

findAll

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

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

matchAt

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

fun matchAt(input: CharSequence, index: Int): 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.5), JS (1.5), Native (1.5)

matchesAt

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

fun matchesAt(input: CharSequence, index: Int): 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
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

split

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

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

splitToSequence

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

fun splitToSequence(
    input: CharSequence, 
    limit: Int = 0
): Sequence<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–2022 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/

Spec-Zone.ru

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