org.apache.oro.text.regex
Class Perl5Compiler

Safe: 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.

EXTENDED_MASKEnabled: A mask passed as an option to the compile methods
to indicate a compiled regular expression should be treated as a Perl5
extended pattern (i.e., a pattern using the /x modifier).

static int

MULTILINE_MASKEnabled: A mask passed as an option to the compile methods
to indicate a compiled regular expression should treat input as having
multiple lines.

static int

READ_ONLY_MASKEnabled: A mask passed as an option to the 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.

static int

SINGLELINE_MASKEnabled: A mask passed as an option to the compile methods
to indicate a compiled regular expression should treat input as being
a single line.

__HEX_DIGIT

__input

__sawBackreference

__modifierFlags

__numParentheses

private int __numParentheses

__programSize

private int __programSize

__cost

private int __cost

__program

private char[] __program

DEFAULT_MASK

public static final int DEFAULT_MASK

Enabled: The default mask for the 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.

CASE_INSENSITIVE_MASK

public static final int CASE_INSENSITIVE_MASK

Enabled: A mask passed as an option to the compile methods
to indicate a compiled regular expression should be case insensitive.

MULTILINE_MASK

public static final int MULTILINE_MASK

Enabled: A mask passed as an option to the 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.
The SINGLELINE_MASK and MULTILINE_MASK should not be
used together.

SINGLELINE_MASK

public static final int SINGLELINE_MASK

Enabled: A mask passed as an option to the 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.
The SINGLELINE_MASK and MULTILINE_MASK should not be
used together.

EXTENDED_MASK

public static final int EXTENDED_MASK

Enabled: A mask passed as an option to the 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.

READ_ONLY_MASK

public static final int READ_ONLY_MASK

Enabled: A mask passed as an option to the 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.

Constructor Detail

Perl5Compiler

public Perl5Compiler()

Enabled:

Method Detail

quotemeta

Enabled: 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.

Returns:

A String containing a Perl5 regular expression corresponding to
a literal interpretation of the pattern.

quotemeta

Enabled: 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.

Returns:

A String containing a Perl5 regular expression corresponding to
a literal interpretation of the pattern.

compile

Enabled: 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.

compile

Enabled: 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.