xmlschema/io.github.pdvrieze.formats.xmlschema.regex/XRegex

XRegex

class XRegex(source)

Represents a compiled regular expression. Provides functions to match strings in text with a pattern, replace the found occurrences and split text around matches.

Note that in the future, the behavior of regular expression matching and replacement functions can be altered to match JVM implementation behavior where differences exist.

Constructors

constructor(pattern: String, version: SchemaVersion)

Creates a regular expression from the specified pattern string and the default options.

Types

object Companion

Properties

val pattern: String

The pattern string of this regular expression.

Functions

containsMatchIn

fun containsMatchIn(input: CharSequence): Boolean

Indicates whether the regular expression can find at least one match in the specified input.

fun find(input: CharSequence, startIndex: Int = 0): XMatchResult?

Returns the first match of a regular expression in the input, beginning at the specified startIndex.

fun findAll(input: CharSequence, startIndex: Int = 0): Sequence<XMatchResult>

Returns a sequence of all occurrences of a regular expression within the input string, beginning at the specified startIndex.

fun matchAt(input: CharSequence, index: Int): XMatchResult?

fun matchEntire(input: CharSequence): XMatchResult?

Attempts to match the entire input CharSequence against the pattern.

infix fun matches(input: CharSequence): Boolean

Indicates whether the regular expression matches the entire input.

fun matchesAt(input: CharSequence, index: Int): Boolean

open override fun toString(): String

Returns the string representation of this regular expression, namely the pattern of this regular expression.