kotlin-stdlib / kotlin.text / RegexOption

RegexOption

Common

Native

1.0

enum class RegexOption
(Common source) (JS source) (Native source)

JVM

1.0

enum class RegexOption : FlagEnum
(source)

For JVM, JS, Native

Provides enumeration values to use to set regular expression options.

For Common

Provides enumeration values to use to set regular expression options.

Note that the enum has different set of possible options on different platforms and can be extended later. Avoid exclusive when matches on this enum values. See the docs of RegexOption for the specific platform for details.

Enum Values

Common

JVM

Native

1.0

IGNORE_CASE

Enables case-insensitive matching. Case comparison is Unicode-aware.

Common

JVM

Native

1.0

MULTILINE

Enables multiline mode.

JVM

Native

1.0

LITERAL

Enables literal parsing of the pattern.

JVM

Native

1.0

UNIX_LINES

Enables Unix lines mode. In this mode, only the '\n' is recognized as a line terminator.

JVM

Native

1.0

COMMENTS

Permits whitespace and comments in pattern.

JVM

Native

1.0

DOT_MATCHES_ALL

Enables the mode, when the expression . matches any character, including a line terminator.

JVM

Native

1.0

CANON_EQ

Enables equivalence by canonical decomposition.

Properties

JVM

1.0

mask

val mask: Int

value

JVM

1.0

val value: Int

1.1

val value: String

Extension Properties

JVM

1.7

declaringJavaClass

Returns a Java Class instance of the enum the given constant belongs to.

val <E : Enum<E>> Enum<E>.declaringJavaClass: Class<E>

Extension Functions

Common

JVM

Native

1.0

coerceAtLeast

Ensures that this value is not less than the specified minimumValue.

fun <T : Comparable<T>> T.coerceAtLeast(minimumValue: T): T

Common

JVM

Native

1.0

coerceAtMost

Ensures that this value is not greater than the specified maximumValue.

fun <T : Comparable<T>> T.coerceAtMost(maximumValue: T): T

Common

JVM

Native

1.0

coerceIn

Ensures that this value lies in the specified range minimumValue..maximumValue.

fun <T : Comparable<T>> T.coerceIn(
    minimumValue: T?, 
    maximumValue: T?
): T

Ensures that this value lies in the specified range.

fun <T : Comparable<T>> T.coerceIn(
    range: ClosedFloatingPointRange<T>
): T

fun <T : Comparable<T>> T.coerceIn(range: ClosedRange<T>): T

Common

JVM

Native

1.6

compareTo

Compares this object with the specified object for order. Returns zero if this object is equal to the specified other object, a negative number if it's less than other, or a positive number if it's greater than other.

infix fun <T> Comparable<T>.compareTo(other: T): Int

Common

JVM

Native

1.0

rangeTo

Creates a range from this Comparable value to the specified that value.

operator fun <T : Comparable<T>> T.rangeTo(
    that: T
): ClosedRange<T>

Common

JVM

Native

1.9

rangeUntil

Creates an open-ended range from this Comparable value to the specified that value.

operator fun <T : Comparable<T>> T.rangeUntil(
    that: T
): OpenEndRange<T>

Inheritors

JVM

Native

1.0

CANON_EQ

Enables equivalence by canonical decomposition.

JVM

Native

1.0

COMMENTS

Permits whitespace and comments in pattern.

JVM

Native

1.0

DOT_MATCHES_ALL

Enables the mode, when the expression . matches any character, including a line terminator.

Common

JVM

Native

1.0

IGNORE_CASE

Enables case-insensitive matching. Case comparison is Unicode-aware.

JVM

Native

1.0

LITERAL

Enables literal parsing of the pattern.

Common

JVM

Native

1.0

MULTILINE

Enables multiline mode.

JVM

Native

1.0

UNIX_LINES

Enables Unix lines mode. In this mode, only the '\n' is recognized as a line terminator.