| java.lang.Object
 gnu.regexp.REMatch
| REMatch | | final public class REMatch implements Serializable,Cloneable(Code) | | 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 |
| Constructor Summary | |
| | REMatch(int subs, int anchor, int eflags)
|
| Method Summary | |
| void | assignFrom(REMatch other)
| | void | clear(int index)
Clears the current match and moves the offset to the new index. | | public Object | clone()
| | void | finish(CharIndexed text)
| | public int | getEndIndex()
Returns the index within the input string where the match in
its entirety ends. | | public int | getEndIndex(int sub)
Returns the index within the input string used to generate this match
where subexpression number sub ends, or -1 if
the subexpression does not exist. | | public int | getStartIndex()
Returns the index within the input text where the match in its entirety
began. | | public int | getStartIndex(int sub)
Returns the index within the input string used to generate this match
where subexpression number sub begins, or -1 if
the subexpression does not exist. | | public int | getSubEndIndex(int sub)
Returns the index within the input string used to generate this match
where subexpression number sub ends, or -1 if
the subexpression does not exist. | | public int | getSubStartIndex(int sub)
Returns the index within the input string used to generate this match
where subexpression number sub begins, or -1 if
the subexpression does not exist. | | public String | substituteInto(String input)
Substitute the results of this match to create a new string.
This is patterned after PERL, so the tokens to watch out for are
$0 through $9. | | public String | toString()
Returns the string matching the pattern. | | public String | toString(int sub)
Returns the string matching the given subexpression. |
| REMatch | | REMatch(int subs, int anchor, int eflags)(Code) | | |
| clear | | void clear(int index)(Code) | | Clears the current match and moves the offset to the new index.
|
| getEndIndex | | public int getEndIndex()(Code) | | 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.
|
| getEndIndex | | public int getEndIndex(int sub)(Code) | | Returns the index within the input string used to generate this match
where subexpression number sub ends, or -1 if
the subexpression does not exist. The initial position is zero.
Parameters:
sub - Subexpression index |
| getStartIndex | | public int getStartIndex()(Code) | | Returns the index within the input text where the match in its entirety
began.
|
| getStartIndex | | public int getStartIndex(int sub)(Code) | | Returns the index within the input string used to generate this match
where subexpression number sub begins, or -1 if
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)(Code) | | Returns the index within the input string used to generate this match
where subexpression number sub ends, or -1 if
the subexpression does not exist. The initial position is zero.
Parameters:
sub - Subexpression index |
| getSubStartIndex | | public int getSubStartIndex(int sub)(Code) | | Returns the index within the input string used to generate this match
where subexpression number sub begins, or -1 if
the subexpression does not exist. The initial position is zero.
Parameters:
sub - Subexpression index |
| substituteInto | | public String substituteInto(String input)(Code) | | Substitute the results of this match to create a new string.
This is patterned after PERL, so the tokens to watch out for are
$0 through $9. $0 matches
the full substring matched; $n matches
subexpression number n.
Parameters:
input - A string consisting of literals and $n tokens. |
| toString | | public String toString()(Code) | | 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);
|
| toString | | public String toString(int sub)(Code) | | 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. |
|
|