| java.lang.Object
 org.apache.oro.text.regex.Perl5Compiler
| Perl5Compiler | | final public class Perl5Compiler implements PatternCompiler(Code) | | 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 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 .
version:
@version@
since:
1.0
See Also: PatternCompiler
See Also: MalformedPatternException
See Also: Perl5Pattern
See Also: Perl5Matcher |
| Field Summary | |
| final public static int | CASE_INSENSITIVE_MASK
A mask passed as an option to the
Perl5Compiler.compile compile methods
to indicate a compiled regular expression should be case insensitive. | | final public static int | DEFAULT_MASK
The default mask for the
Perl5Compiler.compile compile methods.
It is equal to 0.
The default behavior is for a regular expression to be case sensitive
and to not specify if it is multiline or singleline. | | final public static int | EXTENDED_MASK
A mask passed as an option to the
Perl5Compiler.compile compile methods
to indicate a compiled regular expression should be treated as a Perl5
extended pattern (i.e., a pattern using the /x modifier). | | final public static int | MULTILINE_MASK
A mask passed as an option to the
Perl5Compiler.compile compile methods
to indicate a compiled regular expression should treat input as having
multiple lines. | | final public static int | READ_ONLY_MASK
A mask passed as an option to the
Perl5Compiler.compile compile methods
to indicate that the resulting Perl5Pattern should be treated as a
read only data structure by Perl5Matcher, making it safe to share
a single Perl5Pattern instance among multiple threads without needing
synchronization. | | final public static int | SINGLELINE_MASK
A mask passed as an option to the
Perl5Compiler.compile compile methods
to indicate a compiled regular expression should treat input as being
a single line. |
| Method Summary | |
| public Pattern | compile(char[] pattern, int options)
Compiles a Perl5 regular expression into a Perl5Pattern instance that
can be used by a Perl5Matcher object to perform pattern matching.
Please see the user's guide for more information about Perl5 regular
expressions.
Parameters:
pattern - A Perl5 regular expression to compile.
Parameters:
options - A set of flags giving the compiler instructions onhow to treat the regular expression. | | public Pattern | compile(char[] pattern)
Same as calling compile(pattern, Perl5Compiler.DEFAULT_MASK);
Parameters:
pattern - A regular expression to compile. | | public Pattern | compile(String pattern)
Same as calling compile(pattern, Perl5Compiler.DEFAULT_MASK);
Parameters:
pattern - A regular expression to compile. | | public Pattern | compile(String pattern, int options)
Compiles a Perl5 regular expression into a Perl5Pattern instance that
can be used by a Perl5Matcher object to perform pattern matching.
Please see the user's guide for more information about Perl5 regular
expressions.
Parameters:
pattern - A Perl5 regular expression to compile.
Parameters:
options - A set of flags giving the compiler instructions onhow to treat the regular expression. | | final public static String | quotemeta(char[] expression)
Given a character string, returns a Perl5 expression that interprets
each character of the original string literally. | | final public static String | quotemeta(String expression)
Given a character string, returns a Perl5 expression that interprets
each character of the original string literally. |
| CASE_INSENSITIVE_MASK | | final public static int CASE_INSENSITIVE_MASK(Code) | | A mask passed as an option to the
Perl5Compiler.compile compile methods
to indicate a compiled regular expression should be case insensitive.
|
| DEFAULT_MASK | | final public static int DEFAULT_MASK(Code) | | The default mask for the
Perl5Compiler.compile compile methods.
It is equal to 0.
The default behavior is for a regular expression to be case sensitive
and to not specify if it is multiline or singleline. When MULITLINE_MASK
and SINGLINE_MASK are not defined, the ^, $, and .
metacharacters are
interpreted according to the value of isMultiline() in Perl5Matcher.
The default behavior of Perl5Matcher is to treat the Perl5Pattern
as though MULTILINE_MASK were enabled. If isMultiline() returns false,
then the pattern is treated as though SINGLINE_MASK were set. However,
compiling a pattern with the MULTILINE_MASK or SINGLELINE_MASK masks
will ALWAYS override whatever behavior is specified by the setMultiline()
in Perl5Matcher.
|
| EXTENDED_MASK | | final public static int EXTENDED_MASK(Code) | | A mask passed as an option to the
Perl5Compiler.compile compile methods
to indicate a compiled regular expression should be treated as a Perl5
extended pattern (i.e., a pattern using the /x modifier). This
option tells the compiler to ignore whitespace that is not backslashed or
within a character class. It also tells the compiler to treat the
# character as a metacharacter introducing a comment as in
Perl. In other words, the # character will comment out any
text in the regular expression between it and the next newline.
The intent of this option is to allow you to divide your patterns
into more readable parts. It is provided to maintain compatibility
with Perl5 regular expressions, although it will not often
make sense to use it in Java.
|
| MULTILINE_MASK | | final public static int MULTILINE_MASK(Code) | | A mask passed as an option to the
Perl5Compiler.compile compile methods
to indicate a compiled regular expression should treat input as having
multiple lines. This option affects the interpretation of
the ^ and $ metacharacters. When this mask is used,
the ^ metacharacter matches at the beginning of every line,
and the $ metacharacter matches at the end of every line.
Additionally the . metacharacter will not match newlines when
an expression is compiled with MULTILINE_MASK , which is its
default behavior.
|
| READ_ONLY_MASK | | final public static int READ_ONLY_MASK(Code) | | A mask passed as an option to the
Perl5Compiler.compile compile methods
to indicate that the resulting Perl5Pattern should be treated as a
read only data structure by Perl5Matcher, making it safe to share
a single Perl5Pattern instance among multiple threads without needing
synchronization. Without this option, Perl5Matcher reserves the right
to store heuristic or other information in Perl5Pattern that might
accelerate future matches. When you use this option, Perl5Matcher will
not store or modify any information in a Perl5Pattern. Use this option
when you want to share a Perl5Pattern instance among multiple threads
using different Perl5Matcher instances.
|
| SINGLELINE_MASK | | final public static int SINGLELINE_MASK(Code) | | A mask passed as an option to the
Perl5Compiler.compile compile methods
to indicate a compiled regular expression should treat input as being
a single line. This option affects the interpretation of
the ^ and $ metacharacters. When this mask is used,
the ^ metacharacter matches at the beginning of the input,
and the $ metacharacter matches at the end of the input.
The ^ and $ metacharacters will not match at the beginning
and end of lines occurring between the begnning and end of the input.
Additionally, the . metacharacter will match newlines when
an expression is compiled with SINGLELINE_MASK , unlike its
default behavior.
|
| compile | | public Pattern compile(char[] pattern, int options) throws MalformedPatternException(Code) | | Compiles a Perl5 regular expression into a Perl5Pattern instance that
can be used by a Perl5Matcher object to perform pattern matching.
Please see the user's guide for more information about Perl5 regular
expressions.
Parameters:
pattern - A Perl5 regular expression to compile.
Parameters:
options - A set of flags giving the compiler instructions onhow to treat the regular expression. The flagsare a logical OR of any number of the five MASKconstants. For example: regex =compiler.compile(pattern, Perl5Compiler.CASE_INSENSITIVE_MASK |Perl5Compiler.MULTILINE_MASK); This says to compile the pattern so that it treatsinput as consisting of multiple lines and to performmatches in a case insensitive manner. A Pattern instance constituting the compiled regular expression.This instance will always be a Perl5Pattern and can be reliablycasted to a Perl5Pattern.
exception:
MalformedPatternException - If the compiled expressionis not a valid Perl5 regular expression. |
| compile | | public Pattern compile(char[] pattern) throws MalformedPatternException(Code) | | Same as calling compile(pattern, Perl5Compiler.DEFAULT_MASK);
Parameters:
pattern - A regular expression to compile. A Pattern instance constituting the compiled regular expression.This instance will always be a Perl5Pattern and can be reliablycasted to a Perl5Pattern.
exception:
MalformedPatternException - If the compiled expressionis not a valid Perl5 regular expression. |
| compile | | public Pattern compile(String pattern) throws MalformedPatternException(Code) | | Same as calling compile(pattern, Perl5Compiler.DEFAULT_MASK);
Parameters:
pattern - A regular expression to compile. A Pattern instance constituting the compiled regular expression.This instance will always be a Perl5Pattern and can be reliablycasted to a Perl5Pattern.
exception:
MalformedPatternException - If the compiled expressionis not a valid Perl5 regular expression. |
| compile | | public Pattern compile(String pattern, int options) throws MalformedPatternException(Code) | | Compiles a Perl5 regular expression into a Perl5Pattern instance that
can be used by a Perl5Matcher object to perform pattern matching.
Please see the user's guide for more information about Perl5 regular
expressions.
Parameters:
pattern - A Perl5 regular expression to compile.
Parameters:
options - A set of flags giving the compiler instructions onhow to treat the regular expression. The flagsare a logical OR of any number of the five MASKconstants. For example: regex =compiler.compile("^\\w+\\d+$",Perl5Compiler.CASE_INSENSITIVE_MASK |Perl5Compiler.MULTILINE_MASK);This says to compile the pattern so that it treatsinput as consisting of multiple lines and to performmatches in a case insensitive manner. A Pattern instance constituting the compiled regular expression.This instance will always be a Perl5Pattern and can be reliablycasted to a Perl5Pattern.
exception:
MalformedPatternException - If the compiled expressionis not a valid Perl5 regular expression. |
| quotemeta | | final public static String quotemeta(char[] expression)(Code) | | Given a character string, returns a Perl5 expression that interprets
each character of the original string literally. In other words, all
special metacharacters are quoted/escaped. This method is useful for
converting user input meant for literal interpretation into a safe
regular expression representing the literal input.
In effect, this method is the analog of the Perl5 quotemeta() builtin
method.
Parameters:
expression - The expression to convert. A String containing a Perl5 regular expression corresponding toa literal interpretation of the pattern. |
| quotemeta | | final public static String quotemeta(String expression)(Code) | | Given a character string, returns a Perl5 expression that interprets
each character of the original string literally. In other words, all
special metacharacters are quoted/escaped. This method is useful for
converting user input meant for literal interpretation into a safe
regular expression representing the literal input.
In effect, this method is the analog of the Perl5 quotemeta() builtin
method.
Parameters:
pattern - The pattern to convert. A String containing a Perl5 regular expression corresponding toa literal interpretation of the pattern. |
|
|