Product Documentation

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 as either Unicode escapes or other 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 "b", for example, matches a single backspace character when interpreted as a regular expression, while "b" matches a word boundary. The string literal "(hello)" is illegal and leads to a compile-time error; in order to match the string (hello) the string literal "(hello)" must be used.

Line terminators

A line terminator 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 newline (line feed) character ('n')
• A carriage-return character followed immediately by a newline character ("rn")
• A standalone carriage-return character ('r')
• A next-line character ('u0085')
• A line-separator character ('u2028')
• A paragraph-separator character ('u2029).

If UNIX_LINES mode is activated, then the only line terminators recognized are newline characters. The regular expression . matches any character except a line terminator unless the DOTALL flag is specified.

Groups and capturing

Capturing groups are numbered by counting their opening parentheses from left to right. In the expression ((A)(B(C))), 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 "aba" against the expression (a(b)?)+, for example, leaves group two set to "b". All captured input is discarded at the beginning of each match. Groups beginning with (? are pure, non-capturing groups that do not capture text and do not count towards the group total.

Unicode support

This class follows Unicode Technical Report #18: Unicode Regular Expression Guidelines, implementing its second level of support though with a slightly different concrete syntax. Unicode escape sequences such as u2014 in Java source code are processed as described in §3.3 of 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 "u2014" and "u2014", while not equal, compile into the same pattern, which matches the character with hexadecimal value 0x2014. Unicode blocks and categories are written with the p and P constructs as in Perl. p{prop} matches if the input has the property prop, while P{{prop} does not match if the input has that property. Blocks are specified with the prefix In, as in InMongolian.

Categories may be specified with the optional prefix Is: Both p{L} and p{IsL} denote the category of Unicode letters. Blocks and categories can be used both inside and outside of a character class. The supported blocks and categories are those of The Unicode Standard, Version 3.0. The block names are those defined in Chapter 14 and in the file Blocks-3.txt of the Unicode Character Database except that the spaces are removed; "Basic Latin", for example, becomes "BasicLatin".

Comparison to Perl 5

Perl constructs not supported by this class:

• The conditional constructs (?{X}) and (?(condition)X|Y)
• The embedded code constructs (?{code}) and (??{code})
• The embedded comment syntax (?#comment)
• The preprocessing operations l u, L, and U.
  • 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. 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]]

    Notable differences from Perl:

    • In Perl, 1 through 9 are always interpreted as back references; a backslash-escaped number greater than 9 is treated as a back reference if at least that many subexpressions 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, 1 through 9 are always interpreted as back references, and a larger number is accepted as a back reference if at least that many subexpressions 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 g flag to request a match that resumes where the last match left off. This functionality is provided implicitly by the Matcher class: Repeated invocations of the find 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 *a, as well as dangling brackets, as in the expression abc], and treats them as literals. This class also accepts dangling brackets but is strict about dangling metacharacters 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, Jeffrey E. F. Friedl, O'Reilly and Associates, 1997.