com.oracle.truffle.regex.result

Class RegexResult

java.lang.Object

com.oracle.truffle.regex.AbstractRegexObject

com.oracle.truffle.regex.AbstractConstantKeysObject

com.oracle.truffle.regex.result.RegexResult

All Implemented Interfaces:

com.oracle.truffle.api.interop.TruffleObject

Direct Known Subclasses:

LazyResult, NoMatchResult, SingleIndexArrayResult, SingleResult

public abstract class RegexResult
extends AbstractConstantKeysObject

RegexResult is a TruffleObject that represents the result of matching a regular expression against a string. It can be obtained as the result of a RegexObject's exec method and has the following properties:

1. boolean isMatch: true if a match was found, false otherwise.
2. int groupCount: number of capture groups present in the regular expression, including group 0. If the result is no match, this property is undefined.
3. TruffleObject getStart(int groupNumber): returns the position where the beginning of the capture group with the given number was found. If the result is no match, the returned value is undefined. Capture group number 0 denotes the boundaries of the entire expression. If no match was found for a particular capture group, the returned value is -1.
4. TruffleObject end: returns the position where the end of the capture group with the given number was found. If the result is no match, the returned value is undefined. Capture group number 0 denotes the boundaries of the entire expression. If no match was found for a particular capture group, the returned value is -1.