Package gnu.regexp
Class REMatch
java.lang.Object
gnu.regexp.REMatch
- All Implemented Interfaces:
Serializable,Cloneable
An instance of this class represents a match
completed by a gnu.regexp matching function. It can be used
to obtain relevant information about the location of a match
or submatch.
- Author:
- Wes Biggs
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription(package private) voidassignFrom(REMatch other) (package private) voidclear(int index) Clears the current match and moves the offset to the new index.clone()(package private) voidfinish(CharIndexed text) intReturns the index within the input string where the match in its entirety ends.intgetEndIndex(int sub) Returns the index within the input string used to generate this match where subexpression number sub ends, or-1if the subexpression does not exist.intReturns the index within the input text where the match in its entirety began.intgetStartIndex(int sub) Returns the index within the input string used to generate this match where subexpression number sub begins, or-1if the subexpression does not exist.intgetSubEndIndex(int sub) Deprecated.Use getEndIndex(int) insteadintgetSubStartIndex(int sub) Deprecated.Use getStartIndex(int) instead.substituteInto(String input) Substitute the results of this match to create a new string.toString()Returns the string matching the pattern.toString(int sub) Returns the string matching the given subexpression.
-
Field Details
-
eflags
int eflags -
offset
int offset -
anchor
int anchor -
index
int index -
start
int[] start -
end
int[] end -
next
REMatch next
-
-
Constructor Details
-
REMatch
REMatch(int subs, int anchor, int eflags)
-
-
Method Details
-
clone
-
assignFrom
-
finish
-
clear
void clear(int index) Clears the current match and moves the offset to the new index. -
toString
Returns the string matching the pattern. This makes it convenient to write code like the following:REMatch myMatch = myExpression.getMatch(myString);
if (myMatch != null) System.out.println("Regexp found: "+myMatch); -
getStartIndex
public int getStartIndex()Returns the index within the input text where the match in its entirety began. -
getEndIndex
public int getEndIndex()Returns the index within the input string where the match in its entirety ends. The return value is the next position after the end of the string; therefore, a match created by the following call:REMatch myMatch = myExpression.getMatch(myString);can be viewed (given that myMatch is not null) by creating
String theMatch = myString.substring(myMatch.getStartIndex(), myMatch.getEndIndex());But you can save yourself that work, since the
toString()method (above) does exactly that for you. -
toString
Returns the string matching the given subexpression. The subexpressions are indexed starting with one, not zero. That is, the subexpression identified by the first set of parentheses in a regular expression could be retrieved from an REMatch by calling match.toString(1).- Parameters:
sub- Index of the subexpression.
-
getSubStartIndex
public int getSubStartIndex(int sub) Deprecated.Use getStartIndex(int) instead.Returns the index within the input string used to generate this match where subexpression number sub begins, or-1if the subexpression does not exist. The initial position is zero.- Parameters:
sub- Subexpression index
-
getStartIndex
public int getStartIndex(int sub) Returns the index within the input string used to generate this match where subexpression number sub begins, or-1if the subexpression does not exist. The initial position is zero.- Parameters:
sub- Subexpression index- Since:
- gnu.regexp 1.1.0
-
getSubEndIndex
public int getSubEndIndex(int sub) Deprecated.Use getEndIndex(int) insteadReturns the index within the input string used to generate this match where subexpression number sub ends, or-1if the subexpression does not exist. The initial position is zero.- Parameters:
sub- Subexpression index
-
getEndIndex
public int getEndIndex(int sub) Returns the index within the input string used to generate this match where subexpression number sub ends, or-1if the subexpression does not exist. The initial position is zero.- Parameters:
sub- Subexpression index
-
substituteInto
Substitute the results of this match to create a new string. This is patterned after PERL, so the tokens to watch out for are$0through$9.$0matches the full substring matched;$nmatches subexpression number n.- Parameters:
input- A string consisting of literals and$ntokens.
-