## Overview

This module provides APIs for searching, splitting, and replacing the set of characters of a string. These APIs are using a 
regular expression as a `String` to perform these operations by finding the string matches.

[Regular expressions](https://en.wikipedia.org/wiki/Regular_expression), are notations for describing sets of 
character strings. If a particular string is in the set described by a regular expression, the regular expression matches that string.

For information on the operations, which you can perform with the regex module, see the below **Functions**.


Checks whether the given string matches the provided `regex`.
```ballerina
boolean isMatched = regex:matches("Ballerina is great", "Ba[a-z ]+");
```



matches

stringToMatch

string

regex

`true` if the provided string matches the regex or else
`false`


boolean

Replaces each occurrence of the substrings, which match the provided
`regex` from the given original string value with the
provided replacement string.
```ballerina
string result = regex:replaceAll("Ballerina is great", "\\s+", "_");
```



replaceAll

The original string to replace the occurrences of the
substrings that match the provided `regex`


originalString

The regex to match the substrings in the `originalString` to be replaced


The `replacement` string to replace the subsgrings, which
match the `regex`


replacement

The resultant string with the replaced substrings


Replaces the first substring that matches the given `regex` with
the provided `replacement` string.
```ballerina
string result = regex:replaceFirst("Ballerina is great", "\\s+", "_");
```



replaceFirst

The regex to match the first substring in the `originalString` to
be replaced


The `replacement` string to replace the first substring, which
matches the `regex`


The resultant string with the replaced substring


Returns an array of strings by splitting a string using the provided
delimiter.
```ballerina
string[] result = regex:split("Ballerina is great", " ");
```



split

receiver

delimiter

An array of strings containing the individual strings that are split


This module provides APIs for searching, splitting, and replacing the set of characters of a string. These APIs are using a 


ballerina/regex1.0.11.0.11.0.00.7.0-beta.20.7.0-beta.10.7.0-alpha8

Overview

Functions

ballerina/regex
1.0.1
1.0.1 1.0.0 0.7.0-beta.2 0.7.0-beta.1 0.7.0-alpha8