Summary of regular-expression constructs

Backslashes, escapes, and quoting

The backslash character ('\') serves to introduce escaped constructs, as defined in the table above, as well as to quote characters that otherwise would be interpreted as unescaped constructs. Thus the expression matches a single backslash and matches a left brace.

It is an error to use a backslash prior to any alphabetic character that does not denote an escaped construct; these are reserved for future extensions to the regular-expression language. A backslash may be used prior to a non-alphabetic character regardless of whether that character is part of an unescaped construct.

Backslashes within string literals in Java source code are interpreted as required by the Java Language Specification Unicode escapes character escapes. It is therefore necessary to double backslashes in string literals that represent regular expressions to protect them from interpretation by the Java bytecode compiler. The string literal, for example, matches a single backspace character when interpreted as a regular expression, while matches a word boundary. The string literal is illegal and leads to a compile-time error; in order to match the string the string literal must be used.

Character Classes

Character classes may appear within other character classes, and may be composed by the union operator (implicit) and the intersection operator (&&). The union operator denotes a class that contains every character that is in at least one of its operand classes. The intersection operator denotes a class that contains every character that is in both of its operand classes.

The precedence of character-class operators is as follows, from highest to lowest:

1	Literal escape	\x
2	Grouping	[...]
3	Range	a-z
4	Union	[a-e][i-u]
5	Intersection	[a-z&&[aeiou]]

Note that a different set of meta characters are in effect inside a character class than outside a character class. For instance, the regular expression loses its special meaning inside a character class, while the expression becomes a range forming meta character.

Line terminators

A is a one- or two-character sequence that marks the end of a line of the input character sequence. The following are recognized as line terminators:

• A new line (line feed) character ('\n'),
• A carriage-return character followed immediately by a new line character ("\r\n"),
• A stand-alone carriage-return character ('\r'),
• A next-line character ('\u0085'),
• A line-separator character ('\u2028'), or
• A paragraph-separator character ('\u2029).

If mode is activated, then the only line terminators recognized are new line characters.

The regular expression matches any character except a line terminator unless the flag is specified.

By default, the regular expressions ignore line terminators and only match at the beginning and the end, respectively, of the entire input sequence. If mode is activated then matches at the beginning of input and after any line terminator except at the end of input. When in MULTILINE matches just before a line terminator or the end of the input sequence.

Groups and capturing

Capturing groups are numbered by counting their opening parentheses from left to right. In the expression, for example, there are four such groups:

1	((A)(B(C)))
2	(A)
3	(B(C))
4	(C)

Group zero always stands for the entire expression.

Capturing groups are so named because, during a match, each subsequence of the input sequence that matches such a group is saved. The captured subsequence may be used later in the expression, via a back reference, and may also be retrieved from the matcher once the match operation is complete.

The captured input associated with a group is always the subsequence that the group most recently matched. If a group is evaluated a second time because of quantification then its previously-captured value, if any, will be retained if the second evaluation fails. Matching the string against the expression, for example, leaves group two set to. All captured input is discarded at the beginning of each match.

Groups beginning withare pure, groups that do not capture text and do not count towards the group total.

Unicode support

This class is in conformance with Level 1 of Unicode Technical Standard #18: Unicode Regular Expression Guidelines, plus RL2.1 Canonical Equivalents.

Unicode escape sequences such as in Java source code are processed as described inof the Java Language Specification. Such escape sequences are also implemented directly by the regular-expression parser so that Unicode escapes can be used in expressions that are read from files or from the keyboard. Thus the strings, while not equal, compile into the same pattern, which matches the character with hexadecimal value.

Unicode blocks and categories are written with the constructs as in Perl matches if the input has the property, while \P{prop} does not match if the input has that property. Blocks are specified with a prefix. Categories may be specified with an optional prefix. Both denote the category of Unicode letters. Blocks and categories can be used both inside and outside of a character class.

The supported categories are those of The Unicode Standard in the version specified by the class. The category names are those defined in the Standard, both normative and informative.

Comparison to Perl 5

The engine performs traditional NFA-based matching with ordered alternation as occurs in Perl 5.

Perl constructs not supported by this class:

• The conditional constructs
• The embedded code constructs
• The embedded comment syntax
• The preprocessing operations

Constructs supported by this class but not by Perl:

• Possessive quantifiers, which greedily match as much as they can and do not back off, even when doing so would allow the overall match to succeed.
• Character-class union and intersection as described.

Notable differences from Perl:

• In Perl, are always interpreted as back references; a backslash-escaped number greater than is treated as a back reference if at least that many sub-expressions exist, otherwise it is interpreted, if possible, as an octal escape. In this class octal escapes must always begin with a zero. In this class,are always interpreted as back references, and a larger number is accepted as a back reference if at least that many sub-expressions exist at that point in the regular expression, otherwise the parser will drop digits until the number is smaller or equal to the existing number of groups or it is one digit.
• Perl uses the flag to request a match that resumes where the last match left off. This functionality is provided implicitly by the class: Repeated invocations of the method will resume where the last match left off, unless the matcher is reset.
• In Perl, embedded flags at the top level of an expression affect the whole expression. In this class, embedded flags always take effect at the point at which they appear, whether they are at the top level or within a group; in the latter case, flags are restored at the end of the group just as in Perl.
• Perl is forgiving about malformed matching constructs, as in the expression, as well as dangling brackets, as in the expression, and treats them as literals. This class also accepts dangling brackets but is strict about dangling meta characters like +, ? and *, and will throw a PatternSyntaxException if it encounters them.

For a more precise description of the behavior of regular expression constructs, please see Mastering Regular Expressions, 2nd Edition, Jeffrey E. F. Friedl, O'Reilly and Associates, 2002.