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 Perl5Matcher  

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

All Implemented Interfaces:

PatternMatcher

---

public final class Perl5Matcher

extends java.lang.Object

implements PatternMatcher

The Perl5Matcher class is used to match regular expressions (conforming to the Perl5 regular expression syntax) generated by Perl5Compiler.

Perl5Compiler and Perl5Matcher are designed with the intent that you use a separate instance of each per thread to avoid the overhead of both synchronization and concurrent access (e.g., a match that takes a long time in one thread will block the progress of another thread with a shorter match). If you want to use a single instance of each in a concurrent program, you must appropriately protect access to the instances with critical sections. If you want to share Perl5Pattern instances between concurrently executing instances of Perl5Matcher, you must compile the patterns with Perl5Compiler.READ_ONLY_MASK 55 .

Since:

1.0

Version:

@version@

---

Field Summary
private  int[]	__beginMatchOffsets
private  int	__bol
private  boolean	__caseInsensitive
private  int	__currentOffset
private  Perl5Repetition	__currentRep
private static int	__DEFAULT_LAST_MATCH_END_OFFSET
private  int[]	__endMatchOffsets
private  int	__endOffset
private  int	__eol
private static char	__EOS
private  int	__expSize
private static int	__INITIAL_NUM_OFFSETS
private  char[]	__input
private  int	__inputOffset
private  int	__lastMatchInputEndOffset
private  Perl5MatchResult	__lastMatchResult
private  int	__lastParen
private  boolean	__lastSuccess
private  boolean	__multiline
private  int	__numParentheses
private  char[]	__originalInput
private  char	__previousChar
private  char[]	__program
private  java.util.Stack	__stack

 

Constructor Summary

Perl5Matcher()

 

Method Summary
private static boolean	__compare(char[] s1, int s1Offs, char[] s2, int s2Offs, int n)
private static int	__findFirst(char[] input, int current, int endOffset, char[] mustString)
private  void	__initInterpreterGlobals(Perl5Pattern expression, char[] input, int beginOffset, int endOffset, int currentOffset)
private  boolean	__interpret(Perl5Pattern expression, char[] input, int beginOffset, int endOffset, int currentOffset)
private  boolean	__match(int offset)
private  boolean	__matchUnicodeClass(char code, char[] __program, int offset, char opcode)
private  void	__popState()
private  void	__pushState(int parenFloor)
private  int	__repeat(int offset, int max)
private  void	__setLastMatchResult()
private  boolean	__tryExpression(int offset)
(package private)  char[]	_toLower(char[] input)
boolean	contains(char[] input, Pattern pattern)           Determines if a string (represented as a char[]) contains a pattern.
boolean	contains(PatternMatcherInput input, Pattern pattern)           Determines if the contents of a PatternMatcherInput, starting from the current offset of the input contains a pattern.
boolean	contains(java.lang.String input, Pattern pattern)           Determines if a string contains a pattern.
MatchResult	getMatch()           Fetches the last match found by a call to a matches() or contains() method.
boolean	isMultiline()
boolean	matches(char[] input, Pattern pattern)           Determines if a string (represented as a char[]) exactly matches a given pattern.
boolean	matches(PatternMatcherInput input, Pattern pattern)           Determines if the contents of a PatternMatcherInput instance exactly matches a given pattern.
boolean	matches(java.lang.String input, Pattern pattern)           Determines if a string exactly matches a given pattern.
boolean	matchesPrefix(char[] input, Pattern pattern)           Determines if a prefix of a string (represented as a char[]) matches a given pattern.
boolean	matchesPrefix(char[] input, Pattern pattern, int offset)           Determines if a prefix of a string (represented as a char[]) matches a given pattern, starting from a given offset into the string.
boolean	matchesPrefix(PatternMatcherInput input, Pattern pattern)           Determines if a prefix of a PatternMatcherInput instance matches a given pattern.
boolean	matchesPrefix(java.lang.String input, Pattern pattern)           Determines if a prefix of a string matches a given pattern.
void	setMultiline(boolean multiline)           Set whether or not subsequent calls to matches() 55 or contains() 55 should treat the input as consisting of multiple lines.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

__EOS

private static final char __EOS

See Also:

Constant Field Values

---

__INITIAL_NUM_OFFSETS

private static final int __INITIAL_NUM_OFFSETS

See Also:

Constant Field Values

---

__multiline

private boolean __multiline

---

__lastSuccess

private boolean __lastSuccess

---

__caseInsensitive

private boolean __caseInsensitive

---

__previousChar

private char __previousChar

---

__input

private char[] __input

---

__originalInput

private char[] __originalInput

---

__currentRep

private Perl5Repetition __currentRep

---

__numParentheses

private int __numParentheses

---

__bol

private int __bol

---

__eol

private int __eol

---

__currentOffset

private int __currentOffset

---

__endOffset

private int __endOffset

---

__program

private char[] __program

---

__expSize

private int __expSize

---

__inputOffset

private int __inputOffset

---

__lastParen

private int __lastParen

---

__beginMatchOffsets

private int[] __beginMatchOffsets

---

__endMatchOffsets

private int[] __endMatchOffsets

---

__stack

private java.util.Stack __stack

---

__lastMatchResult

private Perl5MatchResult __lastMatchResult

---

__DEFAULT_LAST_MATCH_END_OFFSET

private static final int __DEFAULT_LAST_MATCH_END_OFFSET

See Also:

Constant Field Values

---

__lastMatchInputEndOffset

private int __lastMatchInputEndOffset

Constructor Detail

Perl5Matcher

public Perl5Matcher()

Method Detail

__compare

private static boolean __compare(char[] s1,
                                 int s1Offs,
                                 char[] s2,
                                 int s2Offs,
                                 int n)

---

__findFirst

private static int __findFirst(char[] input,
                               int current,
                               int endOffset,
                               char[] mustString)

---

__pushState

private void __pushState(int parenFloor)

---

__popState

private void __popState()

---

__initInterpreterGlobals

private void __initInterpreterGlobals(Perl5Pattern expression,
                                      char[] input,
                                      int beginOffset,
                                      int endOffset,
                                      int currentOffset)

---

__setLastMatchResult

private void __setLastMatchResult()

---

__interpret

private boolean __interpret(Perl5Pattern expression,
                            char[] input,
                            int beginOffset,
                            int endOffset,
                            int currentOffset)

---

__matchUnicodeClass

private boolean __matchUnicodeClass(char code,
                                    char[] __program,
                                    int offset,
                                    char opcode)

---

__tryExpression

private boolean __tryExpression(int offset)

---

__repeat

private int __repeat(int offset,
                     int max)

---

__match

private boolean __match(int offset)

---

setMultiline

public void setMultiline(boolean multiline)

Set whether or not subsequent calls to matches() 55 or contains() 55 should treat the input as consisting of multiple lines. The default behavior is for input to be treated as consisting of multiple lines. This method should only be called if the Perl5Pattern used for a match was compiled without either of the Perl5Compiler.MULTILINE_MASK or Perl5Compiler.SINGLELINE_MASK flags, and you want to alter the behavior of how the ^, $, and . metacharacters are interpreted on the fly. The compilation options used when compiling a pattern ALWAYS override the behavior specified by setMultiline(). See Perl5Compiler for more details.

---

isMultiline

public boolean isMultiline()

---

_toLower

char[] _toLower(char[] input)

---

matchesPrefix

public boolean matchesPrefix(char[] input,
                             Pattern pattern,
                             int offset)

Determines if a prefix of a string (represented as a char[]) matches a given pattern, starting from a given offset into the string. If a prefix of the string matches the pattern, a MatchResult instance representing the match is made accesible via getMatch() 55 .

This method is useful for certain common token identification tasks that are made more difficult without this functionality.

Specified by:

matchesPrefix in interface PatternMatcher

---

matchesPrefix

public boolean matchesPrefix(char[] input,
                             Pattern pattern)

Determines if a prefix of a string (represented as a char[]) matches a given pattern. If a prefix of the string matches the pattern, a MatchResult instance representing the match is made accesible via getMatch() 55 .

This method is useful for certain common token identification tasks that are made more difficult without this functionality.

Specified by:

matchesPrefix in interface PatternMatcher

---

matchesPrefix

public boolean matchesPrefix(java.lang.String input,
                             Pattern pattern)

Determines if a prefix of a string matches a given pattern. If a prefix of the string matches the pattern, a MatchResult instance representing the match is made accesible via getMatch() 55 .

This method is useful for certain common token identification tasks that are made more difficult without this functionality.

Specified by:

matchesPrefix in interface PatternMatcher

---

matchesPrefix

public boolean matchesPrefix(PatternMatcherInput input,
                             Pattern pattern)

Determines if a prefix of a PatternMatcherInput instance matches a given pattern. If there is a match, a MatchResult instance representing the match is made accesible via getMatch() 55 . Unlike the contains(PatternMatcherInput, Pattern) 55 method, the current offset of the PatternMatcherInput argument is not updated. However, unlike the matches(PatternMatcherInput, Pattern) 55 method, matchesPrefix() will start its search from the current offset rather than the begin offset of the PatternMatcherInput.

This method is useful for certain common token identification tasks that are made more difficult without this functionality.

Specified by:

matchesPrefix in interface PatternMatcher

---

matches

public boolean matches(char[] input,
                       Pattern pattern)

Determines if a string (represented as a char[]) exactly matches a given pattern. If there is an exact match, a MatchResult instance representing the match is made accesible via getMatch() 55 . The pattern must be a Perl5Pattern instance, otherwise a ClassCastException will be thrown. You are not required to, and indeed should NOT try to (for performance reasons), catch a ClassCastException because it will never be thrown as long as you use a Perl5Pattern as the pattern parameter.

Note: matches() is not the same as sticking a ^ in front of your expression and a $ at the end of your expression in Perl5 and using the =~ operator, even though in many cases it will be equivalent. matches() literally looks for an exact match according to the rules of Perl5 expression matching. Therefore, if you have a pattern foo|foot and are matching the input foot it will not produce an exact match. But foot|foo will produce an exact match for either foot or foo. Remember, Perl5 regular expressions do not match the longest possible match. From the perlre manpage:

Alternatives are tried from left to right, so the first alternative found for which the entire expression matches, is the one that is chosen. This means that alternatives are not necessarily greedy. For example: when matching foo|foot against "barefoot", only the "foo" part will match, as that is the first alternative tried, and it successfully matches the target string.

Specified by:

matches in interface PatternMatcher

---

matches

public boolean matches(java.lang.String input,
                       Pattern pattern)

Determines if a string exactly matches a given pattern. If there is an exact match, a MatchResult instance representing the match is made accesible via getMatch() 55 . The pattern must be a Perl5Pattern instance, otherwise a ClassCastException will be thrown. You are not required to, and indeed should NOT try to (for performance reasons), catch a ClassCastException because it will never be thrown as long as you use a Perl5Pattern as the pattern parameter.

Note: matches() is not the same as sticking a ^ in front of your expression and a $ at the end of your expression in Perl5 and using the =~ operator, even though in many cases it will be equivalent. matches() literally looks for an exact match according to the rules of Perl5 expression matching. Therefore, if you have a pattern foo|foot and are matching the input foot it will not produce an exact match. But foot|foo will produce an exact match for either foot or foo. Remember, Perl5 regular expressions do not match the longest possible match. From the perlre manpage:

Alternatives are tried from left to right, so the first alternative found for which the entire expression matches, is the one that is chosen. This means that alternatives are not necessarily greedy. For example: when matching foo|foot against "barefoot", only the "foo" part will match, as that is the first alternative tried, and it successfully matches the target string.

Specified by:

matches in interface PatternMatcher

---

matches

public boolean matches(PatternMatcherInput input,
                       Pattern pattern)

Determines if the contents of a PatternMatcherInput instance exactly matches a given pattern. If there is an exact match, a MatchResult instance representing the match is made accesible via getMatch() 55 . Unlike the contains(PatternMatcherInput, Pattern) 55 method, the current offset of the PatternMatcherInput argument is not updated. You should remember that the region between the begin (NOT the current) and end offsets of the PatternMatcherInput will be tested for an exact match.

The pattern must be a Perl5Pattern instance, otherwise a ClassCastException will be thrown. You are not required to, and indeed should NOT try to (for performance reasons), catch a ClassCastException because it will never be thrown as long as you use a Perl5Pattern as the pattern parameter.

Note: matches() is not the same as sticking a ^ in front of your expression and a $ at the end of your expression in Perl5 and using the =~ operator, even though in many cases it will be equivalent. matches() literally looks for an exact match according to the rules of Perl5 expression matching. Therefore, if you have a pattern foo|foot and are matching the input foot it will not produce an exact match. But foot|foo will produce an exact match for either foot or foo. Remember, Perl5 regular expressions do not match the longest possible match. From the perlre manpage:

Alternatives are tried from left to right, so the first alternative found for which the entire expression matches, is the one that is chosen. This means that alternatives are not necessarily greedy. For example: when matching foo|foot against "barefoot", only the "foo" part will match, as that is the first alternative tried, and it successfully matches the target string.

Specified by:

matches in interface PatternMatcher

---

contains

public boolean contains(java.lang.String input,
                        Pattern pattern)

Determines if a string contains a pattern. If the pattern is matched by some substring of the input, a MatchResult instance representing the first such match is made acessible via getMatch() 55 . If you want to access subsequent matches you should either use a PatternMatcherInput object or use the offset information in the MatchResult to create a substring representing the remaining input. Using the MatchResult offset information is the recommended method of obtaining the parts of the string preceeding the match and following the match.

The pattern must be a Perl5Pattern instance, otherwise a ClassCastException will be thrown. You are not required to, and indeed should NOT try to (for performance reasons), catch a ClassCastException because it will never be thrown as long as you use a Perl5Pattern as the pattern parameter.

Specified by:

contains in interface PatternMatcher

---

contains

public boolean contains(char[] input,
                        Pattern pattern)

Determines if a string (represented as a char[]) contains a pattern. If the pattern is matched by some substring of the input, a MatchResult instance representing the first such match is made acessible via getMatch() 55 . If you want to access subsequent matches you should either use a PatternMatcherInput object or use the offset information in the MatchResult to create a substring representing the remaining input. Using the MatchResult offset information is the recommended method of obtaining the parts of the string preceeding the match and following the match.

The pattern must be a Perl5Pattern instance, otherwise a ClassCastException will be thrown. You are not required to, and indeed should NOT try to (for performance reasons), catch a ClassCastException because it will never be thrown as long as you use a Perl5Pattern as the pattern parameter.

Specified by:

contains in interface PatternMatcher

---

contains

public boolean contains(PatternMatcherInput input,
                        Pattern pattern)

Determines if the contents of a PatternMatcherInput, starting from the current offset of the input contains a pattern. If a pattern match is found, a MatchResult instance representing the first such match is made acessible via getMatch() 55 . The current offset of the PatternMatcherInput is set to the offset corresponding to the end of the match, so that a subsequent call to this method will continue searching where the last call left off. You should remember that the region between the begin and end offsets of the PatternMatcherInput are considered the input to be searched, and that the current offset of the PatternMatcherInput reflects where a search will start from. Matches extending beyond the end offset of the PatternMatcherInput will not be matched. In other words, a match must occur entirely between the begin and end offsets of the input. See PatternMatcherInput for more details.

As a side effect, if a match is found, the PatternMatcherInput match offset information is updated. See the PatternMatcherInput.setMatchOffsets(int, int) 55 method for more details.

The pattern must be a Perl5Pattern instance, otherwise a ClassCastException will be thrown. You are not required to, and indeed should NOT try to (for performance reasons), catch a ClassCastException because it will never be thrown as long as you use a Perl5Pattern as the pattern parameter.

This method is usually used in a loop as follows:

 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.err.println("Bad pattern.");
   System.err.println(e.getMessage());
   return;
 }

 input   = new PatternMatcherInput(someStringInput);

 while(matcher.contains(input, pattern)) {
   result = matcher.getMatch();  
   // Perform whatever processing on the result you want.
 }

 

Specified by:

contains in interface PatternMatcher

---

getMatch

public MatchResult getMatch()

Fetches the last match found by a call to a matches() or contains() method. If you plan on modifying the original search input, you must call this method BEFORE you modify the original search input, as a lazy evaluation technique is used to create the MatchResult. This reduces the cost of pattern matching when you don't care about the actual match and only care if the pattern occurs in the input. Otherwise, a MatchResult would be created for every match found, whether or not the MatchResult was later used by a call to getMatch().

Specified by:

getMatch in interface PatternMatcher

---

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

---