Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> oro >> text >> [ regex overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.apache.oro.text.regex
Class Perl5MatchResult  

java.lang.Object
  org.apache.oro.text.regex.Perl5MatchResult

All Implemented Interfaces:

MatchResult

---

final class Perl5MatchResult

extends java.lang.Object

implements MatchResult

A class used to store and access the results of a Perl5Pattern match.

Since:

1.0

Version:

@version@

---

Field Summary
(package private)  int[]	_beginGroupOffset           Arrays containing the beginning and end offsets of the pattern groups matched within the actual matched pattern contained in the variable match.
(package private)  int[]	_endGroupOffset           Arrays containing the beginning and end offsets of the pattern groups matched within the actual matched pattern contained in the variable match.
(package private)  java.lang.String	_match           The entire string that matched the pattern.
(package private)  int	_matchBeginOffset           The character offset into the line or stream where the match begins.

 

Constructor Summary
(package private)	Perl5MatchResult(int groups)           Constructs a MatchResult able to store match information for a number of subpattern groups.

 

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.
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.
java.lang.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.
java.lang.String	toString()           The same as group(0).

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

_matchBeginOffset

int _matchBeginOffset

The character offset into the line or stream where the match begins. Pattern matching methods that look for matches a line at a time should use this field as the offset into the line of the match. Methods that look for matches independent of line boundaries should use this field as the offset into the entire text stream.

---

_beginGroupOffset

int[] _beginGroupOffset

Arrays containing the beginning and end offsets of the pattern groups matched within the actual matched pattern contained in the variable match. Pattern matching methods that do not match subgroups, will only contain entries for group 0, which always refers to the entire pattern. beginGroupOffset contains the start offset of the groups, indexed by group number, which will always be 0 for group 0. endGroupOffset contains the ending offset + 1 of the groups. A group matching the null string will have beginGroupOffset and endGroupOffset entries of equal value. Following a convention established by the GNU regular expression library for the C language, groups that are not part of a match contain -1 as their begin and end offsets.

---

_endGroupOffset

int[] _endGroupOffset

Arrays containing the beginning and end offsets of the pattern groups matched within the actual matched pattern contained in the variable match. Pattern matching methods that do not match subgroups, will only contain entries for group 0, which always refers to the entire pattern. beginGroupOffset contains the start offset of the groups, indexed by group number, which will always be 0 for group 0. endGroupOffset contains the ending offset + 1 of the groups. A group matching the null string will have beginGroupOffset and endGroupOffset entries of equal value. Following a convention established by the GNU regular expression library for the C language, groups that are not part of a match contain -1 as their begin and end offsets.

---

_match

java.lang.String _match

The entire string that matched the pattern.

Constructor Detail

Perl5MatchResult

Perl5MatchResult(int groups)

Constructs a MatchResult able to store match information for a number of subpattern groups.

Method Detail

length

public int length()

Description copied from interface: MatchResult

A convenience method returning the length of the entire match. If you want to get the length of a particular subgroup you should use the MatchResult.group(int) 55 method to get the string and then access its length() method as follows:

 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();
 

Specified by:

length in interface MatchResult

---

groups

public int groups()

Specified by:

groups in interface MatchResult

---

group

public java.lang.String group(int group)

Description copied from interface: MatchResult

Returns the contents of the parenthesized subgroups of a match, counting parentheses from left to right and starting from 1. Group 0 always refers to the entire match. For example, if the pattern 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.

Specified by:

group in interface MatchResult

---

begin

public int begin(int group)

Specified by:

begin in interface MatchResult

---

end

public int end(int group)

Specified by:

end in interface MatchResult

---

beginOffset

public int beginOffset(int group)

Returns an offset marking the beginning of the pattern match relative to the beginning of the input.

Specified by:

beginOffset in interface MatchResult

---

endOffset

public int endOffset(int group)

Returns an offset marking the end of the pattern match relative to the beginning of the input.

Specified by:

endOffset in interface MatchResult

---

toString

public java.lang.String toString()

The same as group(0).

Specified by:

toString in interface MatchResult

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> oro >> text >> [ regex overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---