org.apache.oro.text.regex
public interface MatchResult
A MatchResult instance contains a pattern match and its saved groups. You can access the entire match directly using the MatchResult method with an argument of 0, or by the toString method which is defined to return the same thing. It is also possible to obtain the beginning and ending offsets of a match relative to the input producing the match by using the MatchResult and MatchResult methods. The MatchResult and MatchResult are useful in some circumstances and return the begin and end offsets of the subgroups of a match relative to the beginning of the match.
You might use a MatchResult as follows:
int groups; PatternMatcher matcher; PatternCompiler compiler; Pattern pattern; PatternMatcherInput input; MatchResult result; compiler = new Perl5Compiler(); matcher = new Perl5Matcher(); try { pattern = compiler.compile(somePatternString); } catch(MalformedPatternException e) { System.out.println("Bad pattern."); System.out.println(e.getMessage()); return; } input = new PatternMatcherInput(someStringInput); while(matcher.contains(input, pattern)) { result = matcher.getMatch(); // Perform whatever processing on the result you want. // Here we just print out all its elements to show how its // methods are used. System.out.println("Match: " + result.toString()); System.out.println("Length: " + result.length()); groups = result.groups(); System.out.println("Groups: " + groups); System.out.println("Begin offset: " + result.beginOffset(0)); System.out.println("End offset: " + result.endOffset(0)); System.out.println("Saved Groups: "); // Start at 1 because we just printed out group 0 for(int group = 1; group < groups; group++) { System.out.println(group + ": " + result.group(group)); System.out.println("Begin: " + result.begin(group)); System.out.println("End: " + result.end(group)); } }
Since: 1.0
Version: 2.0.8
See Also: PatternMatcher
Method Summary | |
---|---|
int | begin(int group) |
int | beginOffset(int group)
Returns an offset marking the beginning of the pattern match
relative to the beginning of the input from which the match
was extracted.
|
int | end(int group) |
int | endOffset(int group)
Returns an offset marking the end of the pattern match
relative to the beginning of the input from which the match was
extracted.
|
String | group(int group)
Returns the contents of the parenthesized subgroups of a match,
counting parentheses from left to right and starting from 1.
|
int | groups() |
int | length()
A convenience method returning the length of the entire match.
|
String | toString()
Returns the same as group(0).
|
Parameters: group The pattern subgroup.
Returns: The offset into group 0 of the first token in the indicated pattern subgroup. If a group was never matched or does not exist, returns -1. Be aware that a group that matches the null string at the end of a match will have an offset equal to the length of the string, so you shouldn't blindly use the offset to index an array or String.
Parameters: group The pattern subgroup.
Returns: The offset of the first token in the indicated pattern subgroup. If a group was never matched or does not exist, returns -1.
Parameters: group The pattern subgroup.
Returns: Returns one plus the offset into group 0 of the last token in the indicated pattern subgroup. If a group was never matched or does not exist, returns -1. A group matching the null string will return its start offset.
Parameters: group The pattern subgroup.
Returns: Returns one plus the offset of the last token in the indicated pattern subgroup. If a group was never matched or does not exist, returns -1. A group matching the null string will return its start offset.
foo(\d+)
is used to extract a match
from the input abfoo123
, then group(0)
will return foo123
and group(1)
will return
123
. group(2)
will return
null
because there is only one subgroup in the original
pattern.
Parameters: group The pattern subgroup to return.
Returns: A string containing the indicated pattern subgroup. Group 0 always refers to the entire match. If a group was never matched, it returns null. This is not to be confused with a group matching the null string, which will return a String of length 0.
Returns: The number of groups contained in the result. This number includes the 0th group. In other words, the result refers to the number of parenthesized subgroups plus the entire match itself.
int length = -1; // Use -1 to indicate group doesn't exist MatchResult result; String subgroup; // Initialization of result omitted subgroup = result.group(1); if(subgroup != null) length = subgroup.length();
The length() method serves as a more a more efficient way to do:
length = result.group(0).length();
Returns: The length of the match.
Returns: A string containing the entire match.