Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Home >> All >> org >> apache >> oro >> text >> [ regex Javadoc ]

• org.apache.oro.text.regex: Javadoc index of package org.apache.oro.text.regex.


Package Samples:

• org.apache.oro.text.regex

Classes:

• Perl5Substitution: Perl5Substitution implements a Substitution consisting of a literal string, but allowing Perl5 variable interpolation referencing saved groups in a match. This class is intended for use with Util.substitute 55 . The substitution string may contain variable interpolations referring to the saved parenthesized groups of the search pattern. A variable interpolation is denoted by $1 , or $2 , or $3 , etc. If you want such expressions to be interpreted literally, you should set the numInterpolations parameter to INTERPOLATE_NONE . It is easiest to explain what an interpolated variable does by giving ...
• MatchResult: The MatchResult interface allows PatternMatcher implementors to return results storing match information in whatever format they like, while presenting a consistent way of accessing that information. However, MatchResult implementations should strictly follow the behavior described for the interface methods. A MatchResult instance contains a pattern match and its saved groups. You can access the entire match directly using the group(int) 55 method with an argument of 0, or by the toString() 55 method which is defined to return the same thing. It is also possible to obtain the beginning and ending ...
• PatternMatcherInput: The PatternMatcherInput class is used to preserve state across calls to the contains() methods of PatternMatcher instances. It is also used to specify that only a subregion of a string should be used as input when looking for a pattern match. All that is meant by preserving state is that the end offset of the last match is remembered, so that the next match is performed from that point where the last match left off. This offset can be accessed from the getCurrentOffset() 55 method and can be set with the setCurrentOffset(int) 55 method. You would use a PatternMatcherInput object when you want to ...
• Util: The Util class is a holder for useful static utility methods that can be generically applied to Pattern and PatternMatcher instances. This class cannot and is not meant to be instantiated. The Util class currently contains versions of the split() and substitute() methods inspired by Perl's split function and s operation respectively, although they are implemented in such a way as not to rely on the Perl5 implementations of the OROMatcher packages regular expression interfaces. They may operate on any interface implementations conforming to the OROMatcher API specification for the PatternMatcher, ...
• PatternCompiler: The PatternCompiler interface defines the operations a regular expression compiler must implement. However, the types of regular expressions recognized by a compiler and the Pattern implementations produced as a result of compilation are not restricted. A PatternCompiler instance is used to compile the string representation (either as a String or char[]) of a regular expression into a Pattern instance. The Pattern can then be used in conjunction with the appropriate PatternMatcher instance to perform pattern searches. A form of use might be: PatternCompiler compiler; PatternMatcher matcher; Pattern ...
• PatternMatcher: 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 ...
• Perl5Compiler: The Perl5Compiler class is used to create compiled regular expressions conforming to the Perl5 regular expression syntax. It generates Perl5Pattern instances upon compilation to be used in conjunction with a Perl5Matcher instance. Please see the user's guide for more information about Perl5 regular expressions. 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 ...
• Perl5Matcher: 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 ...
• Substitution: The Substitution interface provides a means for you to control how a substitution is performed when using the Util.substitute 55 method. Two standard implementations are provided, StringSubstitution and Perl5Substitution . To achieve custom control over the behavior of substitutions, you can create your own implementations. A common use for customization is to make a substitution a function of a match.
• Pattern: The Pattern interface allows multiple representations of a regular expression to be defined. In general, different regular expression compilers will produce different types of pattern representations. Some will produce state transition tables derived from syntax trees, others will produce byte code representations of an NFA, etc. The Pattern interface does not impose any specific internal pattern representation, and consequently, Pattern implementations are not meant to be interchangeable among differing PatternCompiler and PatternMatcher implementations. The documentation accompanying a specific ...
• Perl5Pattern: An implementation of the Pattern interface for Perl5 regular expressions. This class is compatible with the Perl5Compiler and Perl5Matcher classes. When a Perl5Compiler instance compiles a regular expression pattern, it produces a Perl5Pattern instance containing internal data structures used by Perl5Matcher to perform pattern matches. This class cannot be subclassed and cannot be directly instantiated by the programmer as it would not make sense. Perl5Pattern instances should only be created through calls to a Perl5Compiler instance's compile() methods. The class implements the Serializable interface ...
• Perl5Debug: The Perl5Debug class is not intended for general use and should not be instantiated, but is provided because some users may find the output of its single method to be useful. The Perl5Compiler class generates a representation of a regular expression identical to that of Perl5 in the abstract, but not in terms of actual data structures. The Perl5Debug class allows the bytecode program contained by a Perl5Pattern to be printed out for comparison with the program generated by Perl5 with the -r option.
• MalformedPatternException: A class used to signify the occurrence of a syntax error in a regular expression that is being compiled. The class is not declared final so that it may be subclassed for identifying more specific pattern comilation errors. However, at this point in time, this package does not subclass MalformedPatternException for any purpose. This does not preclude users and third party implementors of the interfaces of this package from subclassing it for their own purposes.
• StringSubstitution: StringSubstitution implements a Substitution consisting of a simple literal string. This class is intended for use with Util.substitute 55 .
• CharStringPointer: The CharStringPointer class is used to facilitate traversal of a char[] in the manner pointer traversals of strings are performed in C/C++. It is expected that the compiler will inline all the functions.
• OpCode: The OpCode class should not be instantiated. It is a holder of various constants and static methods pertaining to the manipulation of the op-codes used in a compiled regular expression.
• Perl5Repetition: Perl5Repetition is a support class for Perl5Matcher. It was originally defined as a top-level class rather than as an inner class to allow compilation for JDK 1.0.2.
• Perl5MatchResult: A class used to store and access the results of a Perl5Pattern match.

Home | Contact Us | Privacy Policy | Terms of Service