Class Pattern

java.lang.Object
java.util.regex.Pattern
All Implemented Interfaces:
Serializable
public final classPatternextendsObjectimplementsSerializable
A compiled representation of a regular expression.

A regular expression, specified as a string, must first be compiled into an instance of this class. The resulting pattern can then be used to create aMatcher object that can match arbitrarycharacter sequences against the regular expression. All of the state involved in performing a match resides in the matcher, so many matchers can share the same pattern.

A typical invocation sequence is thus

 Pattern p = Pattern.compile("a*b"); Matcher m = p.matcher("aaaaab"); boolean b = m.matches();

Amatches method is defined by this class as a convenience for when a regular expression is used just once. This method compiles an expression and matches an input sequence against it in a single invocation. The statement

 boolean b = Pattern.matches("a*b", "aaaaab");
is equivalent to the three statements above, though for repeated matches it is less efficient since it does not allow the compiled pattern to be reused.

Instances of this class are immutable and are safe for use by multiple concurrent threads. Instances of theMatcher class are not safe for such use.

Summary of regular-expression constructs

Regular expression constructs, and what they match
ConstructMatches
Characters
xThe characterx
\\The backslash character
\0nThe character with octal value0n (0 <= n <= 7)
\0nnThe character with octal value0nn (0 <= n <= 7)
\0mnnThe character with octal value0mnn (0 <= m <= 3, 0 <= n <= 7)
\xhhThe character with hexadecimal value0xhh
\uhhhhThe character with hexadecimal value 0xhhhh
\x{h...h}The character with hexadecimal value0xh...h (Character.MIN_CODE_POINT  <= 0xh...h <= Character.MAX_CODE_POINT)
\N{name}The character with Unicode character name'name'
\tThe tab character ('\u0009')
\nThe newline (line feed) character ('\u000A')
\rThe carriage-return character ('\u000D')
\fThe form-feed character ('\u000C')
\aThe alert (bell) character ('\u0007')
\eThe escape character ('\u001B')
\cxThe control character corresponding tox
Character classes
[abc]a,b, orc (simple class)
[^abc]Any character excepta,b, orc (negation)
[a-zA-Z]a throughz orA throughZ, inclusive (range)
[a-d[m-p]]a throughd, orm throughp:[a-dm-p] (union)
[a-z&&[def]]d,e, orf (intersection)
[a-z&&[^bc]]a throughz, except forb andc:[ad-z] (subtraction)
[a-z&&[^m-p]]a throughz, and notm throughp:[a-lq-z](subtraction)
Predefined character classes
.Any character (may or may not matchline terminators)
\dA digit:[0-9] if UNICODE_CHARACTER_CLASS is not set. SeeUnicode Support.
\DA non-digit:[^0-9]
\hA horizontal whitespace character:[ \t\xA0\u1680\u180e\u2000-\u200a\u202f\u205f\u3000]
\HA non-horizontal whitespace character:[^\h]
\sA whitespace character:[ \t\n\x0B\f\r] if UNICODE_CHARACTER_CLASS is not set. SeeUnicode Support.
\SA non-whitespace character:[^\s]
\vA vertical whitespace character:[\n\x0B\f\r\x85\u2028\u2029]
\VA non-vertical whitespace character:[^\v]
\wA word character:[a-zA-Z_0-9] if UNICODE_CHARACTER_CLASS is not set. SeeUnicode Support.
\WA non-word character:[^\w]
POSIX character classes (US-ASCII only)
\p{Lower}A lower-case alphabetic character:[a-z]
\p{Upper}An upper-case alphabetic character:[A-Z]
\p{ASCII}All ASCII:[\x00-\x7F]
\p{Alpha}An alphabetic character:[\p{Lower}\p{Upper}]
\p{Digit}A decimal digit:[0-9]
\p{Alnum}An alphanumeric character:[\p{Alpha}\p{Digit}]
\p{Punct}Punctuation: One of!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
\p{Graph}A visible character:[\p{Alnum}\p{Punct}]
\p{Print}A printable character:[\p{Graph}\x20]
\p{Blank}A space or a tab:[ \t]
\p{Cntrl}A control character:[\x00-\x1F\x7F]
\p{XDigit}A hexadecimal digit:[0-9a-fA-F]
\p{Space}A whitespace character:[ \t\n\x0B\f\r]
java.lang.Character classes (simplejava character type)
\p{javaLowerCase}Equivalent to java.lang.Character.isLowerCase()
\p{javaUpperCase}Equivalent to java.lang.Character.isUpperCase()
\p{javaWhitespace}Equivalent to java.lang.Character.isWhitespace()
\p{javaMirrored}Equivalent to java.lang.Character.isMirrored()
Classes for Unicode scripts, blocks, categories and binary properties
\p{IsLatin}A Latin script character (script)
\p{InGreek}A character in the Greek block (block)
\p{Lu}An uppercase letter (category)
\p{IsAlphabetic}An alphabetic character (binary property)
\p{Sc}A currency symbol
\P{InGreek}Any character except one in the Greek block (negation)
[\p{L}&&[^\p{Lu}]]Any letter except an uppercase letter (subtraction)
Boundary matchers
^The beginning of a line
$The end of a line
\bA word boundary: at the beginning or at the end of a line if a word character (\w) appears there; or between a word (\w) and a non-word character (\W), in either order.
\b{g}A Unicode extended grapheme cluster boundary
\BA non-word boundary:[^\b]
\AThe beginning of the input
\GThe end of the previous match
\ZThe end of the input but for the finalterminator, if any
\zThe end of the input
Linebreak matcher
\RAny Unicode linebreak sequence, is equivalent to\u000D\u000A|[\u000A\u000B\u000C\u000D\u0085\u2028\u2029]
Unicode Extended Grapheme matcher
\XAny Unicode extended grapheme cluster
Greedy quantifiers
X?X, once or not at all
X*X, zero or more times
X+X, one or more times
X{n}X, exactlyn times
X{n,}X, at leastn times
X{n,m}X, at leastn but not more thanm times
Reluctant quantifiers
X??X, once or not at all
X*?X, zero or more times
X+?X, one or more times
X{n}?X, exactlyn times
X{n,}?X, at leastn times
X{n,m}?X, at leastn but not more thanm times
Possessive quantifiers
X?+X, once or not at all
X*+X, zero or more times
X++X, one or more times
X{n}+X, exactlyn times
X{n,}+X, at leastn times
X{n,m}+X, at leastn but not more thanm times
Logical operators
XYX followed byY
X|YEitherX orY
(X)X, as acapturing group
Back references
\nWhatever thenthcapturing group matched
\k<name>Whatever thenamed-capturing group "name" matched
Quotation
\Nothing, but quotes the following character
\QNothing, but quotes all characters until\E
\ENothing, but ends quoting started by\Q
Special constructs (named-capturing and non-capturing)
(?<name>X)X, as a named-capturing group
(?:X)X, as a non-capturing group
(?idmsuxU-idmsuxU) Nothing, but turns match flagsidmsuxU on - off
(?idmsuxU-idmsuxU:X)  X, as anon-capturing group with the given flagsidmsuxU on - off
(?=X)X, via zero-width positive lookahead
(?!X)X, via zero-width negative lookahead
(?<=X)X, via zero-width positive lookbehind
(?<!X)X, via zero-width negative lookbehind
(?>X)X, as an independent, non-capturing group

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 byThe Java Language Specification as either Unicode escapes (section3.3) or other character escapes (section3.10.6). 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.

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:

Precedence of character class operators.
PrecedenceNameExample
1Literal escape    \x
2Grouping[...]
3Rangea-z
4Union[a-e][i-u]
5Intersection[a-z&&[aeiou]]

Note that a different set of metacharacters 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 metacharacter.

Line terminators

Aline 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 ("\r\n"),
  • A standalone carriage-return character ('\r'),
  • A next-line character ('\u0085'),
  • A line-separator character ('\u2028'), or
  • A paragraph-separator character ('\u2029').

IfUNIX_LINES mode is activated, then the only line terminators recognized are newline characters.

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

IfMULTILINE mode is not activated, the regular expression^ ignores line terminators and only matches at the beginning of the entire input sequence. The regular expression$ matches at the end of the entire input sequence, but also matches just before the last line terminator if this is not followed by any other input character. Other line terminators are ignored, including the last one if it is followed by other input characters.

IfMULTILINE mode is activated then^ matches at the beginning of input and after any line terminator except at the end of input. When inMULTILINE mode$ matches just before a line terminator or the end of the input sequence.

Groups and capturing

Group number

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.

Group name

A capturing group can also be assigned a "name", anamed-capturing group, and then be back-referenced later by the "name". Group names are composed of the following characters. The first character must be aletter.

  • The uppercase letters'A' through'Z' ('\u0041' through '\u005a'),
  • The lowercase letters'a' through'z' ('\u0061' through '\u007a'),
  • The digits'0' through'9' ('\u0030' through '\u0039'),

Anamed-capturing group is still numbered as described inGroup number.

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 either pure,non-capturing groups that do not capture text and do not count towards the group total, ornamed-capturing group.

Unicode support

This class is in conformance with Level 1 ofUnicode Technical Standard #18: Unicode Regular Expressions, plus RL2.1 Canonical Equivalents and RL2.2 Extended Grapheme Clusters.

Unicode escape sequences such as\u2014 in Java source code are processed as described in section3.3 ofThe 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 value0x2014.

A Unicode character can also be represented by using itsHex notation (hexadecimal code point value) directly as described in construct\x{...}, for example a supplementary character U+2011F can be specified as\x{2011F}, instead of two consecutive Unicode escape sequences of the surrogate pair\uD840\uDD1F.

Unicode character names are supported by the named character construct\N{...}, for example,\N{WHITE SMILING FACE} specifies character\u263A. The character names supported by this class are the valid Unicode character names matched byCharacter.codePointOf(name).

Unicode extended grapheme clusters are supported by the grapheme cluster matcher\X and the corresponding boundary matcher\b{g}.

Unicode scripts, blocks, categories and binary properties are written with the\p and\P constructs as in Perl.\p{prop} matches if the input has the propertyprop, while\P{prop} does not match if the input has that property.

Scripts, blocks, categories and binary properties can be used both inside and outside of a character class.

Scripts are specified either with the prefixIs, as inIsHiragana, or by using thescript keyword (or its short formsc) as inscript=Hiragana orsc=Hiragana.

The script names supported byPattern are the valid script names accepted and defined byUnicodeScript.forName.

Blocks are specified with the prefixIn, as inInMongolian, or by using the keywordblock (or its short formblk) as inblock=Mongolian orblk=Mongolian.

The block names supported byPattern are the valid block names accepted and defined byUnicodeBlock.forName.

Categories may be specified with the optional prefixIs: Both\p{L} and\p{IsL} denote the category of Unicode letters. Same as scripts and blocks, categories can also be specified by using the keywordgeneral_category (or its short formgc) as ingeneral_category=Lu orgc=Lu.

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

Binary properties are specified with the prefixIs, as inIsAlphabetic. The supported binary properties byPattern are

  • Alphabetic
  • Ideographic
  • Letter
  • Lowercase
  • Uppercase
  • Titlecase
  • Punctuation
  • Control
  • White_Space
  • Digit
  • Hex_Digit
  • Join_Control
  • Noncharacter_Code_Point
  • Assigned
  • Emoji
  • Emoji_Presentation
  • Emoji_Modifier
  • Emoji_Modifier_Base
  • Emoji_Component
  • Extended_Pictographic

The followingPredefined Character classes andPOSIX character classes are in conformance with the recommendation ofAnnex C: Compatibility Properties ofUnicode Technical Standard #18: Unicode Regular Expressions, whenUNICODE_CHARACTER_CLASS flag is specified.

predefined and posix character classes in Unicode mode
ClassesMatches
\p{Lower}A lowercase character:\p{IsLowercase}
\p{Upper}An uppercase character:\p{IsUppercase}
\p{ASCII}All ASCII:[\x00-\x7F]
\p{Alpha}An alphabetic character:\p{IsAlphabetic}
\p{Digit}A decimal digit character:\p{IsDigit}
\p{Alnum}An alphanumeric character:[\p{IsAlphabetic}\p{IsDigit}]
\p{Punct}A punctuation character:\p{IsPunctuation}
\p{Graph}A visible character:[^\p{IsWhite_Space}\p{gc=Cc}\p{gc=Cs}\p{gc=Cn}]
\p{Print}A printable character:[\p{Graph}\p{Blank}&&[^\p{Cntrl}]]
\p{Blank}A space or a tab:[\p{IsWhite_Space}&&[^\p{gc=Zl}\p{gc=Zp}\x0a\x0b\x0c\x0d\x85]]
\p{Cntrl}A control character:\p{gc=Cc}
\p{XDigit}A hexadecimal digit:[\p{gc=Nd}\p{IsHex_Digit}]
\p{Space}A whitespace character:\p{IsWhite_Space}
\dA digit:\p{IsDigit}
\DA non-digit:[^\d]
\sA whitespace character:\p{IsWhite_Space}
\SA non-whitespace character:[^\s]
\wA word character:[\p{Alpha}\p{gc=Mn}\p{gc=Me}\p{gc=Mc}\p{Digit}\p{gc=Pc}\p{IsJoin_Control}]
\WA non-word character:[^\w]

Categories that behave like the java.lang.Character boolean ismethodname methods (except for the deprecated ones) are available through the same\p{prop} syntax where the specified property has the namejavamethodname.

Comparison to Perl 5

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

Perl constructs not supported by this class:

  • The backreference constructs,\g{n} for thenthcapturing group and\g{name} fornamed-capturing group.

  • The conditional constructs(?(condition)X) and(?(condition)X|Y),

  • The embedded code constructs(?{code}) and(??{code}),

  • The embedded comment syntax(?#comment), and

  • The preprocessing operations\l\u,\L, and\U.

Constructs supported by this class but not by Perl:

  • Character-class union and intersection as describedabove.

Notable differences from Perl:

  • In Perl,\1 through\9 are always interpreted as back references; a backslash-escaped number greater than9 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 theg flag to request a match that resumes where the last match left off. This functionality is provided implicitly by theMatcher class: Repeated invocations of thefind 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.

  • Free-spacing mode in Perl (calledcomments mode in this class) denoted by(?x) in the regular expression (or by theCOMMENTS flag when compiling the expression) will not ignore whitespace inside of character classes. In this class, whitespace inside of character classes must be escaped to be considered as part of the regular expression when in comments mode.

For a more precise description of the behavior of regular expression constructs, please seeMastering Regular Expressions, 3rd Edition, Jeffrey E. F. Friedl, O'Reilly and Associates, 2006.

Since:
1.4
External Specifications
See Also:

  • Field Details

    • UNIX_LINES

      public static final int UNIX_LINES
      Enables Unix lines mode.

      In this mode, only the'\n' line terminator is recognized in the behavior of.,^, and$.

      Unix lines mode can also be enabled via the embedded flag expression (?d).

      See Also:

    • CASE_INSENSITIVE

      public static final int CASE_INSENSITIVE
      Enables case-insensitive matching.

      By default, case-insensitive matching assumes that only characters in the US-ASCII charset are being matched. Unicode-aware case-insensitive matching can be enabled by specifying theUNICODE_CASE flag in conjunction with this flag.

      Case-insensitive matching can also be enabled via the embedded flag expression (?i).

      Specifying this flag may impose a slight performance penalty.

      See Also:

    • COMMENTS

      public static final int COMMENTS
      Permits whitespace and comments in pattern.

      In this mode, whitespace is ignored, and embedded comments starting with# are ignored until the end of a line. Comments mode ignores whitespace within a character class contained in a pattern string. Such whitespace must be escaped in order to be considered significant.

      Comments mode can also be enabled via the embedded flag expression (?x).

      See Also:

    • MULTILINE

      public static final int MULTILINE
      Enables multiline mode.

      In multiline mode the expressions^ and$ match just after or just before, respectively, a line terminator or the end of the input sequence. By default these expressions only match at the beginning and the end of the entire input sequence.

      Multiline mode can also be enabled via the embedded flag expression (?m).

      See Also:

    • LITERAL

      public static final int LITERAL
      Enables literal parsing of the pattern.

      When this flag is specified then the input string that specifies the pattern is treated as a sequence of literal characters. Metacharacters or escape sequences in the input sequence will be given no special meaning.

      The flags CASE_INSENSITIVE and UNICODE_CASE retain their impact on matching when used in conjunction with this flag. The other flags become superfluous.

      There is no embedded flag character for enabling literal parsing.

      Since:
      1.5
      See Also:

    • DOTALL

      public static final int DOTALL
      Enables dotall mode.

      In dotall mode, the expression. matches any character, including a line terminator. By default this expression does not match line terminators.

      Dotall mode can also be enabled via the embedded flag expression (?s). (Thes is a mnemonic for "single-line" mode, which is what this is called in Perl.)

      See Also:

    • UNICODE_CASE

      public static final int UNICODE_CASE
      Enables Unicode-aware case folding.

      When this flag is specified then case-insensitive matching, when enabled by theCASE_INSENSITIVE flag, is done in a manner consistent with the Unicode Standard. By default, case-insensitive matching assumes that only characters in the US-ASCII charset are being matched.

      Unicode-aware case folding can also be enabled via the embedded flag expression (?u).

      Specifying this flag may impose a performance penalty.

      See Also:

    • CANON_EQ

      public static final int CANON_EQ
      Enables canonical equivalence.

      When this flag is specified then two characters will be considered to match if, and only if, their full canonical decompositions match. The expression"a\u030A", for example, will match the string"\u00E5" when this flag is specified. By default, matching does not take canonical equivalence into account.

      There is no embedded flag character for enabling canonical equivalence.

      Specifying this flag may impose a performance penalty and a moderate risk of memory exhaustion.

      See Also:

    • UNICODE_CHARACTER_CLASS

      public static final int UNICODE_CHARACTER_CLASS
      Enables the Unicode version ofPredefined character classes andPOSIX character classes.

      When this flag is specified then the (US-ASCII only)Predefined character classes andPOSIX character classes are in conformance withUnicode Technical Standard #18: Unicode Regular ExpressionsAnnex C: Compatibility Properties.

      The UNICODE_CHARACTER_CLASS mode can also be enabled via the embedded flag expression (?U).

      The flag implies UNICODE_CASE, that is, it enables Unicode-aware case folding.

      Specifying this flag may impose a performance penalty.

      Since:
      1.7
      External Specifications
      See Also:

  • Method Details

    • compile

      public static Pattern compile(String regex)
      Compiles the given regular expression into a pattern.
      Parameters:
      regex - The expression to be compiled
      Returns:
      the given regular expression compiled into a pattern
      Throws:
      PatternSyntaxException - If the expression's syntax is invalid

    • compile

      public static Pattern compile(String regex, int flags)
      Compiles the given regular expression into a pattern with the given flags.

      SettingCANON_EQ among the flags may impose a moderate risk of memory exhaustion.

      Implementation Note:
      IfCANON_EQ is specified and the number of combining marks for any character is too large, anOutOfMemoryError is thrown.
      Parameters:
      regex - The expression to be compiled
      flags - Match flags, a bit mask that may includeCASE_INSENSITIVE,MULTILINE,DOTALL,UNICODE_CASE,CANON_EQ,UNIX_LINES,LITERAL,UNICODE_CHARACTER_CLASS andCOMMENTS
      Returns:
      the given regular expression compiled into a pattern with the given flags
      Throws:
      IllegalArgumentException - If bit values other than those corresponding to the defined match flags are set inflags
      PatternSyntaxException - If the expression's syntax is invalid

    • pattern

      public String pattern()
      Returns the regular expression from which this pattern was compiled.
      Returns:
      The source of this pattern

    • toString

      public String toString()

      Returns the string representation of this pattern. This is the regular expression from which this pattern was compiled.

      Overrides:
      toString in class Object
      Returns:
      The string representation of this pattern
      Since:
      1.5

    • matcher

      public Matcher matcher(CharSequence input)
      Creates a matcher that will match the given input against this pattern.
      Implementation Note:
      When aPattern is deserialized, compilation is deferred until a direct or indirect invocation of this method. Thus, if a deserialized pattern hasCANON_EQ among its flags and the number of combining marks for any character is too large, anOutOfMemoryError is thrown, as incompile(String, int).
      Parameters:
      input - The character sequence to be matched
      Returns:
      A new matcher for this pattern

    • flags

      public int flags()
      Returns this pattern's match flags.
      Returns:
      The match flags specified when this pattern was compiled

    • matches

      public static boolean matches(String regex,CharSequence input)
      Compiles the given regular expression and attempts to match the given input against it.

      An invocation of this convenience method of the form

       Pattern.matches(regex, input);
      behaves in exactly the same way as the expression
       Pattern.compile(regex).matcher(input).matches()

      If a pattern is to be used multiple times, compiling it once and reusing it will be more efficient than invoking this method each time.

      Parameters:
      regex - The expression to be compiled
      input - The character sequence to be matched
      Returns:
      whether or not the regular expression matches on the input
      Throws:
      PatternSyntaxException - If the expression's syntax is invalid

    • split

      public String[] split(CharSequence input, int limit)
      Splits the given input sequence around matches of this pattern.

      The array returned by this method contains each substring of the input sequence that is terminated by another subsequence that matches this pattern or is terminated by the end of the input sequence. The substrings in the array are in the order in which they occur in the input. If this pattern does not match any subsequence of the input then the resulting array has just one element, namely the input sequence in string form.

      When there is a positive-width match at the beginning of the input sequence then an empty leading substring is included at the beginning of the resulting array. A zero-width match at the beginning however never produces such empty leading substring.

      Thelimit parameter controls the number of times the pattern is applied and therefore affects the length of the resulting array.

      • If thelimit is positive then the pattern will be applied at mostlimit - 1 times, the array's length will be no greater thanlimit, and the array's last entry will contain all input beyond the last matched delimiter.

      • If thelimit is zero then the pattern will be applied as many times as possible, the array can have any length, and trailing empty strings will be discarded.

      • If thelimit is negative then the pattern will be applied as many times as possible and the array can have any length.

      The input"boo:and:foo", for example, yields the following results with these parameters:

      Split example showing regex, limit, and result
      RegexLimitResult
      :2{ "boo", "and:foo" }
      5{ "boo", "and", "foo" }
      -2{ "boo", "and", "foo" }
      o5{ "b", "", ":and:f", "", "" }
      -2{ "b", "", ":and:f", "", "" }
      0{ "b", "", ":and:f" }

      Parameters:
      input - The character sequence to be split
      limit - The result threshold, as described above
      Returns:
      The array of strings computed by splitting the input around matches of this pattern

    • splitWithDelimiters

      public String[] splitWithDelimiters(CharSequence input, int limit)
      Splits the given input sequence around matches of this pattern and returns both the strings and the matching delimiters.

      The array returned by this method contains each substring of the input sequence that is terminated by another subsequence that matches this pattern or is terminated by the end of the input sequence. Each substring is immediately followed by the subsequence (the delimiter) that matches this pattern,except for the last substring, which is not followed by anything. The substrings in the array and the delimiters are in the order in which they occur in the input. If this pattern does not match any subsequence of the input then the resulting array has just one element, namely the input sequence in string form.

      When there is a positive-width match at the beginning of the input sequence then an empty leading substring is included at the beginning of the resulting array. A zero-width match at the beginning however never produces such empty leading substring nor the empty delimiter.

      Thelimit parameter controls the number of times the pattern is applied and therefore affects the length of the resulting array.

      • If thelimit is positive then the pattern will be applied at mostlimit - 1 times, the array's length will be no greater than 2 ×limit - 1, and the array's last entry will contain all input beyond the last matched delimiter.
      • If thelimit is zero then the pattern will be applied as many times as possible, the array can have any length, and trailing empty strings, whether substrings or delimiters, will be discarded.
      • If thelimit is negative then the pattern will be applied as many times as possible and the array can have any length.

      The input"boo:::and::foo", for example, yields the following results with these parameters:

      Split example showing regex, limit, and result
      RegexLimitResult
      :+2{ "boo", ":::", "and::foo" }
      5{ "boo", ":::", "and", "::", "foo" }
      -1{ "boo", ":::", "and", "::", "foo" }
      o5{ "b", "o", "", "o", ":::and::f", "o", "", "o", "" }
      -1{ "b", "o", "", "o", ":::and::f", "o", "", "o", "" }
      0{ "b", "o", "", "o", ":::and::f", "o", "", "o" }

      Parameters:
      input - The character sequence to be split
      limit - The result threshold, as described above
      Returns:
      The array of strings computed by splitting the input around matches of this pattern, alternating substrings and matching delimiters
      Since:
      21

    • split

      public String[] split(CharSequence input)
      Splits the given input sequence around matches of this pattern.

      This method works as if by invoking the two-argumentsplit method with the given input sequence and a limit argument of zero. Trailing empty strings are therefore not included in the resulting array.

      The input"boo:and:foo", for example, yields the following results with these expressions:

      Split examples showing regex and result
      RegexResult
      :{ "boo", "and", "foo" }
      o{ "b", "", ":and:f" }

      Parameters:
      input - The character sequence to be split
      Returns:
      The array of strings computed by splitting the input around matches of this pattern

    • quote

      public static String quote(String s)
      Returns a literal patternString for the specifiedString.

      This method produces aString that can be used to create aPattern that would match the strings as if it were a literal pattern.

      Metacharacters or escape sequences in the input sequence will be given no special meaning.
      Parameters:
      s - The string to be literalized
      Returns:
      A literal string replacement
      Since:
      1.5

    • namedGroups

      public Map<String,Integer> namedGroups()
      Returns an unmodifiable map from capturing group names to group numbers. If there are no named groups, returns an empty map.
      Returns:
      an unmodifiable map from capturing group names to group numbers
      Since:
      20

    • asPredicate

      public Predicate<String> asPredicate()
      Creates a predicate that tests if this pattern is found in a given input string.
      API Note:
      This method creates a predicate that behaves as if it creates a matcher from the input sequence and then callsfind, for example a predicate of the form:
         s -> matcher(s).find();
      Returns:
      The predicate which can be used for finding a match on a subsequence of a string
      Since:
      1.8
      See Also:

    • asMatchPredicate

      public Predicate<String> asMatchPredicate()
      Creates a predicate that tests if this pattern matches a given input string.
      API Note:
      This method creates a predicate that behaves as if it creates a matcher from the input sequence and then callsmatches, for example a predicate of the form:
         s -> matcher(s).matches();
      Returns:
      The predicate which can be used for matching an input string against this pattern.
      Since:
      11
      See Also:

    • splitAsStream

      public Stream<String> splitAsStream(CharSequence input)
      Creates a stream from the given input sequence around matches of this pattern.

      The stream returned by this method contains each substring of the input sequence that is terminated by another subsequence that matches this pattern or is terminated by the end of the input sequence. The substrings in the stream are in the order in which they occur in the input. Trailing empty strings will be discarded and not encountered in the stream.

      If this pattern does not match any subsequence of the input then the resulting stream has just one element, namely the input sequence in string form.

      When there is a positive-width match at the beginning of the input sequence then an empty leading substring is included at the beginning of the stream. A zero-width match at the beginning however never produces such empty leading substring.

      If the input sequence is mutable, it must remain constant during the execution of the terminal stream operation. Otherwise, the result of the terminal stream operation is undefined.

      Parameters:
      input - The character sequence to be split
      Returns:
      The stream of strings computed by splitting the input around matches of this pattern
      Since:
      1.8
      See Also: