Java
java.util.regex- About
- Backtracking engine. In Java source every backslash is doubled; the spellings here are what the engine receives.
- Verified on
- OpenJDK 25.0.5
Offsets are counted in UTF-16 code units. - Found in
- java.util.regex, Kotlin, Scala, Elasticsearch scripts
its own documentation - Flags
Uunicode classdunix linesiignore casemmultilinesdotalluunicode casexverbose
Character classes 14 of 26
| Syntax | Matches | Notes | Try |
|---|---|---|---|
. |
Any characterAny single character. Whether that includes a newline depends on the dialect and its flags. | Does not match a newline. |
test |
[abc]not[^abc] |
One of a set of characters | test | |
[a-z] |
One of a range of characters | test | |
[\]] |
Backslash escape inside a setInside a bracket expression a backslash takes the special meaning from the next character. Where this is missing, a backslash there is a member like any other. | test | |
[\d] |
Class escape inside a setA class escape such as the one for a digit, used as a member of a bracket expression. | test | |
[\D] |
Negated class escape inside a setA negated class escape, such as the one for anything but a digit, used as a member of a bracket expression. | test | |
\dnot\D |
Digit | ASCII digits only: |
test |
\w[[:alnum:]_]not\W |
Word characterA letter, a digit or an underscore. | ASCII only: |
test |
\snot\S |
Whitespace | Does not match the no-break space. |
test |
\hnot\H |
Horizontal whitespaceA space or a tab, but not a line break. | test | |
\vnot\V |
Vertical whitespaceA line break character of any kind. | test | |
| n/a | Any character except newlineNever matches a newline, whatever the flags. | not in Java Tried: |
who has it |
\R |
Any line break sequenceOne line break, with CR LF taken as a single unit. | test | |
| n/a | Alphabetic character (shorthand) | not in Java Tried: |
who has it |
| n/a | Lowercase letter (shorthand) | not in Java Tried: |
who has it |
| n/a | Uppercase letter (shorthand) | not in Java Tried: |
who has it |
| n/a | Hexadecimal digit (shorthand) | not in Java Tried: |
who has it |
[X&&Y] |
Class intersectionCharacters that are in both classes. | test | |
[X&&[^Y]] |
Class subtractionCharacters in the first class that are not in the second. | test | |
| n/a | Head-of-word character (shorthand)A letter or the underscore: what a word may start with. | not in Java Tried: |
who has it |
| n/a | Octal digit (shorthand) | not in Java Tried: |
who has it |
| n/a | Identifier characterA character allowed in an identifier. In Vim the set comes from the 'isident' option. | not in Java Tried: |
who has it |
| n/a | Keyword characterA character allowed in a keyword. In Vim the set comes from the 'iskeyword' option. | not in Java Tried: |
who has it |
| n/a | File name characterA character allowed in a file name. In Vim the set comes from the 'isfname' option. | not in Java Tried: |
who has it |
| n/a | Printable characterA character that is displayed as itself. In Vim the set comes from the 'isprint' option. | not in Java Tried: |
who has it |
| n/a | Any single byteOne code unit, even where that is part of a longer character, and even a newline. | not in Java Tried: |
who has it |
Anchors 8 of 14
| Syntax | Matches | Notes | Try |
|---|---|---|---|
^ |
Start of the text or lineStart of the text. With a multiline flag, or always in some dialects, also the start of each line. | test | |
$ |
End of the text or line | Also matches before a newline that ends the text. |
test |
\A |
Start of the textStart of the text only, whatever the flags. | test | |
\z |
End of the textThe very end of the text, whatever the flags. | test | |
\Z |
End of the text, or before a final newline | test | |
\b |
Word boundaryThe position between a word character and a non-word character or an end of the text. | ASCII word characters only: a letter outside ASCII counts as a non-word character. |
test |
\B |
Not a word boundary | test | |
| n/a | Start of a word | not in Java Tried: |
who has it |
| n/a | End of a word | not in Java Tried: |
who has it |
\G |
Where the previous match endedThe position where the last match stopped, or the start of the text for the first match. | test | |
| n/a | Reset the start of the matchEverything matched so far is required but left out of the reported match. | not in Java Tried: |
who has it |
| n/a | Start of symbolBefore a run of word and symbol characters, such as an identifier with an underscore in it. | not in Java Tried: |
who has it |
| n/a | End of symbol | not in Java Tried: |
who has it |
| n/a | Cursor positionWhere the editor's cursor is in the buffer being searched. | not in Java The nearest boundary matcher is doc Not run on an engine: taken from the documentation. |
who has it |
Quantifiers 9 of 9
| Syntax | Matches | Notes | Try |
|---|---|---|---|
X? |
Zero or one | test | |
X* |
Zero or more | test | |
X+ |
One or more | test | |
X{N} |
Exactly N times | test | |
X{N,} |
N or more times | test | |
X{0,M} |
At most M times | test | |
X{N,M} |
Between N and M times | test | |
X*?X+?X?? |
Lazy quantifierRepeat as few times as possible instead of as many as possible. | test | |
X*+X++X?+ |
Possessive quantifierRepeat as many times as possible and never give any of it back. | test |
Groups and alternation 7 of 16
| Syntax | Matches | Notes | Try |
|---|---|---|---|
(X) |
Capture group | test | |
(?:X) |
Non-capturing group | test | |
(?<NAME>X) |
Named capture group | test | |
X|Y |
Alternation | Takes the first alternative that matches, even when a later one is longer. |
test |
\N |
Backreference by numberThe same text that capture group N matched. | test | |
\k<NAME> |
Backreference by name | test | |
| n/a | Backreference by relative positionThe group N groups back from here. | not in Java Tried: |
who has it |
(?>X) |
Atomic groupOnce the group has matched, the engine never tries a different way to match it. | test | |
| n/a | Branch reset groupEvery alternative numbers its capture groups from the same start. | not in Java Tried: |
who has it |
| n/a | ConditionalMatch one pattern if a capture group took part, otherwise another. | not in Java Tried: |
who has it |
| n/a | Recurse into the whole pattern | not in Java Tried: |
who has it |
| n/a | Call a group as a subroutineMatch the pattern of capture group N again at this point, not the text it matched. | not in Java Tried: |
who has it |
| n/a | Comment | not in Java Tried: |
who has it |
| n/a | Explicitly numbered groupA capture group that is given its number, whatever its position. | not in Java Tried: |
who has it |
| n/a | Call an earlier group by relative positionMatch the pattern of the Nth group before this point again. | not in Java Tried: |
who has it |
| n/a | Call a later group by relative positionMatch the pattern of the Nth group after this point here as well. | not in Java Tried: |
who has it |
Lookaround 4 of 4
Escape sequences 14 of 16
| Syntax | Matches | Notes | Try |
|---|---|---|---|
\. |
Escape a special characterTake the next character literally. | test | |
\QTEXT\E |
Quote a run of textTake everything between the markers literally. | test | |
\t |
Tab | test | |
\n |
Newline | test | |
\r |
Carriage return | test | |
\f |
Form feed | test | |
| n/a | Vertical tab | not in Java Tried: |
who has it |
\a |
Alert (bell) | test | |
| n/a | Backspace | not in Java Tried: |
who has it |
\e |
Escape character | test | |
\cC |
Control characterThe control character typed as Ctrl plus the letter. | test | |
\0OOO |
Character by octal code | test | |
\xHH |
Character by two-digit hex code | test | |
\uHHHH\x{HHHH} |
Character by Unicode code point | test | |
\N{CHARNAME} |
Character by Unicode name | test | |
\00\x00\u0000 |
NUL characterThe character with code 0. | An octal escape needs at least one digit after the leading zero ( doc Not run on an engine: taken from the documentation. |
Flags and modes 9 of 14
| Syntax | Matches | Notes | Try |
|---|---|---|---|
flag i(?i) |
Ignore case | test | |
flag m(?m) |
MultilineThe line anchors also match at the start and end of every line. | test | |
flag s(?s) |
Dot matches newline | test | |
flag x(?x) |
Free spacingWhitespace in the pattern is ignored, and a # starts a comment. | test | |
| n/a | Swap greedy and lazy | not in Java Tried: |
who has it |
(?FLAGS) |
Turn a mode on inside the patternApplies from this point to the end of the pattern or the enclosing group. | test | |
(?FLAGS) |
Turn a mode on in the middle of the patternThe mode applies from where the flag stands, not to what comes before it. Some dialects accept an inline flag only at the very start of the pattern. | test | |
(?FLAGS:X) |
Turn a mode on for one group | test | |
(?-FLAGS) |
Turn a mode off inside the pattern | test | |
| n/a | ASCII-only classesMakes the shorthand classes such as the digit class match ASCII characters only. | not in Java The shorthand classes are ASCII-only by default. Tried: |
who has it |
(?U) |
Unicode classesMakes the shorthand classes such as the digit class match by Unicode property. | test | |
| n/a | No automatic capturePlain parentheses group without capturing; only named groups capture. | not in Java Tried: |
who has it |
| n/a | Locale-dependent classesClasses and case folding follow the current locale. | not in Java Case folding is US-ASCII by default and Unicode with doc Not run on an engine: taken from the documentation. |
who has it |
| n/a | Native character set rulesPerl's rules from before 5.14: the pattern and the text decide between native and Unicode rules. | not in Java The inline flag letter doc Not run on an engine: taken from the documentation. |
who has it |
POSIX named classes 0 of 1
| Syntax | Matches | Notes | Try |
|---|---|---|---|
| n/a | POSIX named classA named set of characters, written inside a bracket expression. | not in Java Tried: |
who has it |
POSIX collating symbols 0 of 2
| Syntax | Matches | Notes | Try |
|---|---|---|---|
| n/a | Equivalence classEvery character that collates the same as X in the current locale. | not in Java Tried: |
who has it |
| n/a | Collating symbol by nameA single collating element, written by its POSIX name inside a bracket expression. | not in Java Tried: |
who has it |
Unicode properties 4 of 4
| Syntax | Matches | Notes | Try |
|---|---|---|---|
\p{NAME}not\P{NAME} |
Unicode general category | 36 names: |
test |
\p{IsNAME}not\P{IsNAME} |
Unicode script | 8 names: |
test |
\X |
Extended grapheme clusterOne character as a reader sees it: a base character with its combining marks. | test | |
\b{NAME} |
Unicode text boundaryA boundary as Unicode's segmentation rules define it, which is not the same as a boundary between word and non-word characters. | 1 names: Not here: |
test |
Syntax table classes 0 of 2
| Syntax | Matches | Notes | Try |
|---|---|---|---|
| n/a | Syntax classA character with the given role in the syntax table: whitespace, word, symbol, punctuation, a bracket. | not in Java Tried: |
who has it |
| n/a | Character categoryA character in one of the editor's character categories, most of which are scripts. | not in Java Tried: |
who has it |
Host language 9 of 15
| Syntax | Matches | Notes | Try |
|---|---|---|---|
"PATTERN" |
Pattern in source codeHow a pattern is written where it is used: a regex literal with its delimiters, or the kind of string the documentation recommends. | No regex literal; the pattern is an ordinary string literal, so every backslash is doubled: doc Not run on an engine: taken from the documentation. |
|
Pattern.compile(PATTERN, FLAGS) |
Flags outside the patternWhere flags such as case-insensitive go when they are not written inside the pattern. | FLAGS is a bit mask of doc Not run on an engine: taken from the documentation. |
|
Pattern.compile(PATTERN) |
Compile once and reuseBuild a pattern object and keep it. | The doc Not run on an engine: taken from the documentation. |
|
Pattern.compile(PATTERN).matcher(TEXT).find() |
Search a textTest whether the pattern matches anywhere in a text, or get the first match. |
doc Not run on an engine: taken from the documentation. |
|
Pattern.compile(PATTERN).matcher(TEXT).results()while (m.find()) { m.group(); } |
Every matchGet all the matches that do not overlap. |
doc Not run on an engine: taken from the documentation. |
|
TEXT.replaceAll(PATTERN, REPLACEMENT)TEXT.replaceFirst(PATTERN, REPLACEMENT)Pattern.compile(PATTERN).matcher(TEXT).replaceAll(REPLACEMENT) |
Replace matches |
doc Not run on an engine: taken from the documentation. |
|
m.group(NUM)m.group("NAME") |
Captured group, in codeRead what a group captured after a match. |
doc Not run on an engine: taken from the documentation. |
|
$NUM${NAME} |
Captured group, in replacement text | Digits after doc Not run on an engine: taken from the documentation. |
|
$0 |
Whole match, in replacement text | Group zero is the entire match. A literal dollar sign is written doc Not run on an engine: taken from the documentation. |
|
| n/a | Match once until resetA match operator that succeeds one time only, until it is reset. | not in Java doc Not run on an engine: taken from the documentation. |
who has it |
| n/a | Keep the position after a failed matchIn a repeated search, a failed match does not send the next one back to the start. | not in Java The documentation defines where doc Not run on an engine: taken from the documentation. |
who has it |
| n/a | Keep the matched text for laterAsk for the matched text, and the text around it, to be saved. | not in Java No flag is needed or offered: doc Not run on an engine: taken from the documentation. |
who has it |
| n/a | Interpolate and compile only onceA pattern literal with variables in it is built the first time and never again. | not in Java Patterns are strings, with no interpolating literal to freeze; calling doc Not run on an engine: taken from the documentation. |
who has it |
| n/a | Code inside a patternHost-language code that runs when the match reaches it. | not in Java Named explicitly among the Perl constructs this class does not support. doc Not run on an engine: taken from the documentation. |
who has it |
| n/a | Pattern computed during the matchCode inside the pattern whose result is matched as a pattern at that point. | not in Java Named explicitly among the Perl constructs this class does not support. doc Not run on an engine: taken from the documentation. |
who has it |
Every row was run on the engine named above, except the rows marked doc: those describe something no regex engine can run by itself, such as the syntax of the host language, and are taken from the documentation they link to. For a row marked "not in Java", the spelling other dialects use was tried and the line starting "Tried" says what it did here; that shows the spelling does not work, not that no other spelling exists.