Module regex
ballerina/regex Ballerina library
Deprecated0.7.0-alpha8
Package overview
This package provides the following regex utility functions.
matches- Checks whether a string matches a given regex.replaceAll- Replaces every occurrence of a substring that matches a given regex in a string, with another string provided.replaceFirst- Replaces the first occurrence of a substring that matches a given regex in a string, with another string provided.split- Splits a string using a given regex delimiter and returns an array of the split elements.
Functions
matches
Isolated Function
Checks whether the given string matches the provided regex.
boolean isMatched = regex:matches("Ballerina is great", "Ba[a-z ]+");
Parameters
- stringToMatch string - The string to match the regex
- regex string - The regex to match the string
Return Type
- boolean -
trueif the provided string matches the regex or elsefalse
replaceAll
Isolated Function
Replaces each occurrence of the substrings, which match the provided regular expression from the given original string value with the provided replacement string.
string result = regex:replaceAll("Ballerina is great", "\s+", "_");
Parameters
- originalString string - The original string to replace the occurrences of the
substrings that match the provided
regex
- regex string - The regex to match the substrings in the
originalStringto be replaced
- replacement string - The
replacementstring to replace the subsgrings, which match theregex
Return Type
- string - The resultant string with the replaced substrings
replaceFirst
Isolated Function
Replaces the first substring that matches the given regular expression with
the provided replacement string.
string result = regex:replaceFirst("Ballerina is great", "\s+", "_");
Parameters
- originalString string - The original string to replace the occurrences of the
substrings that match the provided
regex
- regex string - The regex to match the first substring in the
originalStringto be replaced
- replacement string - The
replacementstring to replace the first substring, which matches theregex
Return Type
- string - The resultant string with the replaced substring
split
Isolated Function
Returns an array of strings by splitting a string using the provided delimiter.
string[] result = regex:split("Ballerina is great", " ");
Return Type
- string[] - An array of strings containing the individual strings that are split