Java Doc for PatternMatcher.java in  » Library » jakarta-oro-2.0.8 » org » apache » oro » text » regex » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Library » jakarta oro 2.0.8 » org.apache.oro.text.regex 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.oro.text.regex.PatternMatcher

All known Subclasses:   org.apache.oro.text.awk.AwkMatcher,  org.apache.oro.text.regex.Perl5Matcher,
PatternMatcher
public interface PatternMatcher (Code)
The PatternMatcher interface defines the operations a regular expression matcher must implement. However, the types of the Pattern implementations recognized by a matcher are not restricted. Typically PatternMatcher instances will only recognize a specific type of Pattern. For example, the Perl5Matcher only recognizes Perl5Pattern instances. However, none of the PatternMatcher methods are required to throw an exception in case of the use of an invalid pattern. This is done for efficiency reasons, although usually a CastClassException will be thrown by the Java runtime system if you use the wrong Pattern implementation. It is the responsibility of the programmer to make sure he uses the correct Pattern instance with a given PatternMatcher instance. The current version of this package only contains the Perl5 suite of pattern matching classes, but future ones for other regular expression grammars may be added and users may also create their own implementations of the provided interfaces. Therefore the programmer should be careful not to mismatch classes.
version:
   @version@
since:
   1.0
See Also:   Pattern
See Also:   PatternCompiler
See Also:   MatchResult




Method Summary
public  booleancontains(String input, Pattern pattern)
     Determines if a string contains a pattern.
public  booleancontains(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 PatternMatcher.getMatch() .
public  booleancontains(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 PatternMatcher.getMatch() .
public  MatchResultgetMatch()
     Fetches the last match found by a call to a matches() or contains() method.

A MatchResult instance containing the pattern match foundby the last call to any one of the matches() or contains()methods.

public  booleanmatches(String input, Pattern pattern)
     Determines if a string exactly matches a given pattern.
public  booleanmatches(char[] input, Pattern pattern)
     Determines if a string (represented as a char[]) exactly matches a given pattern.
public  booleanmatches(PatternMatcherInput input, Pattern pattern)
     Determines if the contents of a PatternMatcherInput instance exactly matches a given pattern.
public  booleanmatchesPrefix(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 PatternMatcher.getMatch() .

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


Parameters:
  input - The char[] to test for a prefix match.
Parameters:
  pattern - The Pattern to be matched.
Parameters:
  offset - The offset at which to start searching for the prefix.

public  booleanmatchesPrefix(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 PatternMatcher.getMatch() .

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


Parameters:
  input - The String to test for a prefix match.
Parameters:
  pattern - The Pattern to be matched.

public  booleanmatchesPrefix(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 PatternMatcher.getMatch() .

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


Parameters:
  input - The char[] to test for a prefix match.
Parameters:
  pattern - The Pattern to be matched.

public  booleanmatchesPrefix(PatternMatcherInput input, Pattern pattern)
     Determines if a prefix of a PatternMatcherInput instance matches a given pattern.



Method Detail
contains
public boolean contains(String input, Pattern pattern)(Code)
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 PatternMatcher.getMatch() . 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.


Parameters:
  input - The String to test for a match.
Parameters:
  pattern - The Pattern to be matched. True if the input contains a pattern match, false otherwise.




contains
public boolean contains(char[] input, Pattern pattern)(Code)
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 PatternMatcher.getMatch() . 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.


Parameters:
  input - The String to test for a match.
Parameters:
  pattern - The Pattern to be matched. True if the input contains a pattern match, false otherwise.




contains
public boolean contains(PatternMatcherInput input, Pattern pattern)(Code)
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 PatternMatcher.getMatch() . 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.

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.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.
 }
 


Parameters:
  input - The PatternMatcherInput to test for a match.
Parameters:
  pattern - The Pattern to be matched. True if the input contains a pattern match, false otherwise.




getMatch
public MatchResult getMatch()(Code)
Fetches the last match found by a call to a matches() or contains() method.

A MatchResult instance containing the pattern match foundby the last call to any one of the matches() or contains()methods. If no match was found by the last call,returns null.




matches
public boolean matches(String input, Pattern pattern)(Code)
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 PatternMatcher.getMatch() .


Parameters:
  input - The String to test for an exact match.
Parameters:
  pattern - The Pattern to be matched. True if input matches pattern, false otherwise.




matches
public boolean matches(char[] input, Pattern pattern)(Code)
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 PatternMatcher.getMatch() .


Parameters:
  input - The char[] to test for a match.
Parameters:
  pattern - The Pattern to be matched. True if input matches pattern, false otherwise.




matches
public boolean matches(PatternMatcherInput input, Pattern pattern)(Code)
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 PatternMatcher.getMatch() . Unlike the PatternMatcher.contains(PatternMatcherInput,Pattern) method, the current offset of the PatternMatcherInput argument is not updated. You should remember that the region between the begin and end offsets of the PatternMatcherInput will be tested for an exact match.


Parameters:
  input - The PatternMatcherInput to test for a match.
Parameters:
  pattern - The Pattern to be matched. True if input matches pattern, false otherwise.




matchesPrefix
public boolean matchesPrefix(char[] input, Pattern pattern, int offset)(Code)
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 PatternMatcher.getMatch() .

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


Parameters:
  input - The char[] to test for a prefix match.
Parameters:
  pattern - The Pattern to be matched.
Parameters:
  offset - The offset at which to start searching for the prefix. True if input matches pattern, false otherwise.




matchesPrefix
public boolean matchesPrefix(String input, Pattern pattern)(Code)
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 PatternMatcher.getMatch() .

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


Parameters:
  input - The String to test for a prefix match.
Parameters:
  pattern - The Pattern to be matched. True if input matches pattern, false otherwise.




matchesPrefix
public boolean matchesPrefix(char[] input, Pattern pattern)(Code)
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 PatternMatcher.getMatch() .

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


Parameters:
  input - The char[] to test for a prefix match.
Parameters:
  pattern - The Pattern to be matched. True if input matches pattern, false otherwise.




matchesPrefix
public boolean matchesPrefix(PatternMatcherInput input, Pattern pattern)(Code)
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 PatternMatcher.getMatch() . Unlike the PatternMatcher.contains(PatternMatcherInput,Pattern) method, the current offset of the PatternMatcherInput argument is not updated. You should remember that the region starting from the begin offset of the PatternMatcherInput will be tested for a prefix match.

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


Parameters:
  input - The PatternMatcherInput to test for a prefix match.
Parameters:
  pattern - The Pattern to be matched. True if input matches pattern, false otherwise.




www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.