class

RegexMatcher

class RegexMatcher : Obj

RegexMatcher is used in matching operations on a regular expression.

methods groupCount

Return the number of capturing groups or zero if no match

find

Attempt to find the next match

start

Return the start index of the given group

end

Return end index+1 of the given group

replaceFirst

Replace the first sequence which matches the pattern with the given replacment string

matches

Match the entire region against the pattern

replaceAll

Replace every sequence which matches the pattern with the given replacement string

group

Return the substring captured by the matching operation

end Int end(Int group)

Return end index+1 of the given group. Throw exception if failed to match input or group index is invalid.

find Bool find()

Attempt to find the next match. If a match is made then return true - additional info is available via the group, start, and end methods. Return false if a match cannot be made.

group Str? group(Int group)

Return the substring captured by the matching operation. Group index zero denotes the entire pattern and capturing groups are indexed from left to right starting at one. Return null if group failed to match part of the input. Throw exception if failed to match input or group index is invalid.

groupCount Int groupCount()

Return the number of capturing groups or zero if no match. Group zero is not included.

matches Bool matches()

Match the entire region against the pattern. If a match is made then return true - additional info is available via the group, start, and end methods. Return false if a match cannot be made.

replaceAll Str replaceAll(Str replacement)

Replace every sequence which matches the pattern with the given replacement string.

replaceFirst Str replaceFirst(Str replacement)

Replace the first sequence which matches the pattern with the given replacment string.

start Int start(Int group)

Return the start index of the given group. Throw exception if failed to match input or group index is invalid.

Haxall 4.0.5 ∙ 24-Feb-2026 14:33 EST