Класс Pattern

public final class Pattern extends Object implements Serializable

Скомпилированное представление регулярного выражения.

Регулярное выражение, заданное в виде строки, необходимо сначала скомпилировать в экземпляр этого класса. Полученный шаблон можно использовать для создания объекта Matcher, который сможет сопоставлять произвольные последовательности символов с регулярным выражением. Всё состояние, связанное с выполнением сопоставления, хранится в объекте matcher, поэтому многие объекты matcher могут использовать один и тот же шаблон.

Таким образом, типичная последовательность вызовов выглядит следующим образом:

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

В этом классе определён метод matches для удобства случаев, когда регулярное выражение используется только один раз. Этот метод компилирует выражение и сопоставляет с ним входную последовательность за один вызов. Оператор

boolean b = Pattern.matches("a*b", "aaaaab");

эквивалентен трём приведённым выше операторам, однако при повторном сопоставлении он менее эффективен, поскольку не позволяет повторно использовать скомпилированный шаблон.

Экземпляры этого класса неизменяемы и безопасны для использования несколькими параллельными потоками. Экземпляры класса Matcher небезопасны для такого использования.

Сводка конструкций регулярных выражений

Конструкции регулярных выражений и соответствующие им совпадения

Конструкция	Совпадение
Символы
x	Символ x
\\	Символ обратной косой черты
\0n	Символ с восьмеричным значением 0n (0 <= n <= 7)
\0nn	Символ с восьмеричным значением 0nn (0 <= n <= 7)
\0mnn	Символ с восьмеричным значением 0mnn (0 <= m <= 3, 0 <= n <= 7)
\xhh	Символ с шестнадцатеричным значением 0xhh
\uhhhh	Символ с шестнадцатеричным значением 0xhhhh
\x{h...h}	Символ с шестнадцатеричным значением 0xh...h (Character.MIN_CODE_POINT <= 0xh...h <= Character.MAX_CODE_POINT)
\N{name}	Символ с именем символа Unicode 'name'
\t	Символ табуляции ('\u0009')
\n	Символ новой строки (перевода строки) ('\u000A')
\r	Символ возврата каретки ('\u000D')
\f	Символ перевода страницы ('\u000C')
\a	Символ оповещения (звонка) ('\u0007')
\e	Символ выхода ('\u001B')
\cx	Управляющий символ, соответствующий x
Классы символов
[abc]	a, b или c (простой класс)
[^abc]	Любой символ, кроме a, b или c (отрицание)
[a-zA-Z]	От a до z или от A до Z включительно (диапазон)
[a-d[m-p]]	От a до d или от m до p: [a-dm-p] (объединение)
[a-z&&[def]]	d, e или f (пересечение)
[a-z&&[^bc]]	От a до z, кроме b и c: [ad-z] (вычитание)
[a-z&&[^m-p]]	От a до z, но не от m до p: [a-lq-z](вычитание)
Предопределённые классы символов
.	Любой символ (может совпадать или не совпадать с разделителями строк)
\d	Цифра: [0-9], если не установлен флаг UNICODE_CHARACTER_CLASS. См. раздел Поддержка Unicode.
\D	Символ, не являющийся цифрой: [^0-9]
\h	Символ горизонтального пробела: [ \t\xA0\u1680\u180e\u2000-\u200a\u202f\u205f\u3000]
\H	Символ, не являющийся горизонтальным пробелом: [^\h]
\s	Пробельный символ: [ \t\n\x0B\f\r], если не установлен флаг UNICODE_CHARACTER_CLASS. См. раздел Поддержка Unicode.
\S	Символ, не являющийся пробельным: [^\s]
\v	Символ вертикального пробела: [\n\x0B\f\r\x85\u2028\u2029]
\V	Символ, не являющийся вертикальным пробелом: [^\v]
\w	Символ слова: [a-zA-Z_0-9], если не установлен флаг UNICODE_CHARACTER_CLASS. См. раздел Поддержка Unicode.
\W	Символ, не являющийся символом слова: [^\w]
Классы символов POSIX (только US-ASCII)
\p{Lower}	Строчная буква: [a-z]
\p{Upper}	Заглавная буква:[A-Z]
\p{ASCII}	Все символы ASCII:[\x00-\x7F]
\p{Alpha}	Буква:[\p{Lower}\p{Upper}]
\p{Digit}	Десятичная цифра: [0-9]
\p{Alnum}	Буква или цифра:[\p{Alpha}\p{Digit}]
\p{Punct}	Знак пунктуации: один из !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
\p{Graph}	Видимый символ: [\p{Alnum}\p{Punct}]
\p{Print}	Печатаемый символ: [\p{Graph}\x20]
\p{Blank}	Пробел или символ табуляции: [ \t]
\p{Cntrl}	Управляющий символ: [\x00-\x1F\x7F]
\p{XDigit}	Шестнадцатеричная цифра: [0-9a-fA-F]
\p{Space}	Пробельный символ: [ \t\n\x0B\f\r]
Классы java.lang.Character (простой тип символа Java)
\p{javaLowerCase}	Эквивалентно java.lang.Character.isLowerCase()
\p{javaUpperCase}	Эквивалентно java.lang.Character.isUpperCase()
\p{javaWhitespace}	Эквивалентно java.lang.Character.isWhitespace()
\p{javaMirrored}	Эквивалентно java.lang.Character.isMirrored()
Классы для письменностей, блоков, категорий и двоичных свойств Unicode
\p{IsLatin}	Символ латинской письменности (письменность)
\p{InGreek}	Символ из греческого блока (блок)
\p{Lu}	Заглавная буква (категория)
\p{IsAlphabetic}	Буквенный символ (двоичное свойство)
\p{Sc}	Символ валюты
\P{InGreek}	Любой символ, кроме символов греческого блока (отрицание)
[\p{L}&&[^\p{Lu}]]	Любая буква, кроме заглавной (вычитание)
Средства сопоставления границ
^	Начало строки
$	Конец строки
\b	Граница слова: в начале или конце строки, если там находится символ слова (\w); или между словом (\w) и символом, не являющимся символом слова (\W), в любом порядке.
\b{g}	Граница расширенного графемного кластера Unicode
\B	Не граница слова: [^\b]
\A	Начало входных данных
\G	Конец предыдущего совпадения
\Z	Конец входных данных перед последним разделителем, если он есть
\z	Конец входных данных
Средство сопоставления перевода строки
\R	Любая последовательность символов перевода строки Unicode; эквивалентно \u000D\u000A|[\u000A\u000B\u000C\u000D\u0085\u2028\u2029]
Средство сопоставления расширенной графемы Unicode
\X	Любой расширенный графемный кластер Unicode
Жадные квантификаторы
X?	X один раз или ни разу
X*	X ноль или более раз
X+	X один или более раз
X{n}	X ровно n раз
X{n,}	X не менее n раз
X{n,m}	X не менее n, но не более m раз
Нежадные квантификаторы
X??	X один раз или ни разу
X*?	X ноль или более раз
X+?	X один или более раз
X{n}?	X ровно n раз
X{n,}?	X не менее n раз
X{n,m}?	X не менее n, но не более m раз
Притяжательные квантификаторы
X?+	X один раз или ни разу
X*+	X ноль или более раз
X++	X один или более раз
X{n}+	X ровно n раз
X{n,}+	X не менее n раз
X{n,m}+	X не менее n, но не более m раз
Логические операторы
XY	X, за которым следует Y
X|Y	X или Y
(X)	X как захватывающая группа
Обратные ссылки
\n	То, что совпало с n-й захватывающей группой
\k<name>	То, что совпало с именованной захватывающей группой "name"
Экранирование
\	Ничего; экранирует следующий символ
\Q	Ничего; экранирует все символы до \E
\E	Ничего; завершает экранирование, начатое конструкцией \Q
Специальные конструкции (именованные захватывающие и незахватывающие группы)
(?<name>X)	X как именованная захватывающая группа
(?:X)	X как незахватывающая группа
(?idmsuxU-idmsuxU)	Ничего; включает или отключает флаги сопоставления i d m s u x U
(?idmsuxU-idmsuxU:X)	X как незахватывающая группа с указанными флагами i d m s u x U
(?=X)	X посредством утверждения предварительного просмотра нулевой ширины с положительным условием
(?!X)	X посредством утверждения предварительного просмотра нулевой ширины с отрицательным условием
(?<=X)	X посредством утверждения ретроспективного просмотра нулевой ширины с положительным условием
(?<!X)	X посредством утверждения ретроспективного просмотра нулевой ширины с отрицательным условием
(?>X)	X как независимая незахватывающая группа

Обратные косые черты, экранирование и заключение в кавычки

Символ обратной косой черты ('\') используется для введения экранированных конструкций, определённых в таблице выше, а также для экранирования символов, которые в противном случае интерпретировались бы как неэкранированные конструкции. Так, выражение \\ соответствует одной обратной косой черте, а \{ — открывающей фигурной скобке.

Использование обратной косой черты перед любой буквой, не обозначающей экранированную конструкцию, является ошибкой; такие последовательности зарезервированы для будущих расширений языка регулярных выражений. Обратную косую черту можно использовать перед небуквенным символом независимо от того, является ли этот символ частью неэкранированной конструкции.

Обратные косые черты в строковых литералах исходного кода Java интерпретируются в соответствии с требованиями Спецификации языка Java либо как Unicode-экранирования (раздел §3.3), либо как другие символьные экранирования (раздел §3.10.6). Поэтому обратные косые черты в строковых литералах, представляющих регулярные выражения, необходимо удваивать, чтобы компилятор байт-кода Java не интерпретировал их. Например, строковый литерал "\b" при интерпретации как регулярное выражение соответствует одному символу возврата на шаг, тогда как "\\b" соответствует границе слова. Строковый литерал "\(hello\)" недопустим и приводит к ошибке компиляции; чтобы сопоставить строку (hello), необходимо использовать строковый литерал "\\(hello\\)".

Классы символов

Классы символов могут входить в состав других классов символов и объединяться с помощью оператора объединения (неявного) и оператора пересечения (&&). Оператор объединения обозначает класс, содержащий каждый символ, принадлежащий хотя бы одному из классов-операндов. Оператор пересечения обозначает класс, содержащий каждый символ, принадлежащий обоим классам-операндам.

Приоритет операторов классов символов, от высшего к низшему:

Приоритет операторов классов символов.

Приоритет	Название	Пример
1	Экранирование литерала	\x
2	Группировка	[...]
3	Диапазон	a-z
4	Объединение	[a-e][i-u]
5	Пересечение	[a-z&&[aeiou]]

Обратите внимание, что внутри класса символов действует другой набор метасимволов, чем за его пределами. Например, регулярное выражение . теряет специальное значение внутри класса символов, тогда как выражение - становится метасимволом, задающим диапазон.

Разделители строк

Разделитель строки — это последовательность из одного или двух символов, обозначающая конец строки входной последовательности символов. Распознаются следующие разделители строк:

• Символ новой строки (перевода строки) ('\n'),
• Символ возврата каретки, непосредственно за которым следует символ новой строки ("\r\n"),
• Отдельный символ возврата каретки ('\r'),
• Символ перехода на следующую строку ('\u0085'),
• Символ-разделитель строк ('\u2028') или
• Символ-разделитель абзацев ('\u2029').

Если активирован режим UNIX_LINES, распознаются только символы новой строки в качестве разделителей строк.

Регулярное выражение . соответствует любому символу, кроме разделителя строк, если не указан флаг DOTALL.

Если режим MULTILINE не активирован, регулярное выражение ^ игнорирует разделители строк и соответствует только началу всей входной последовательности. Регулярное выражение $ соответствует концу всей входной последовательности, а также позиции непосредственно перед последним разделителем строк, если за ним не следует других входных символов. Другие разделители строк игнорируются, включая последний, если за ним следуют другие входные символы.

Если активирован режим MULTILINE, выражение ^ соответствует началу входных данных и позиции после любого разделителя строк, кроме конца входных данных. В режиме MULTILINE выражение $ соответствует позиции непосредственно перед разделителем строк или концом входной последовательности.

Группы и захват

Номер группы

Захватывающим группам назначаются номера в порядке расположения открывающих скобок слева направо. Например, в выражении ((A)(B(C))) есть четыре такие группы:

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

Номер ноль всегда обозначает всё выражение.

Захватывающие группы так называются потому, что при сопоставлении сохраняется каждая подпоследовательность входной последовательности, соответствующая такой группе. Захваченную подпоследовательность можно использовать далее в выражении с помощью обратной ссылки, а также получить из объекта сопоставления после завершения операции сопоставления.

Имя группы

Захватывающей группе также можно назначить «имя» — named-capturing group, а затем ссылаться на неё далее по этому «имени». Имена групп состоят из следующих символов. Первый символ должен быть letter.

• Заглавные буквы от 'A' до 'Z' (от '\u0041' до '\u005a'),
• Строчные буквы от 'a' до 'z' (от '\u0061' до '\u007a'),
• Цифры от '0' до '9' (от '\u0030' до '\u0039'),

Номер named-capturing group по-прежнему назначается, как описано в разделе Номер группы.

Захваченные входные данные, связанные с группой, всегда представляют собой подпоследовательность, которой группа соответствовала в последний раз. Если группа вычисляется повторно из-за квантификатора, её ранее захваченное значение, если оно есть, сохраняется, если повторное вычисление завершается неудачей. Например, сопоставление строки "aba" с выражением (a(b)?)+ оставляет для группы два значение "b". Все захваченные входные данные отбрасываются в начале каждого сопоставления.

Группы, начинающиеся с (?, являются либо чистыми незахватывающими группами, которые не захватывают текст и не учитываются при подсчёте общего числа групп, либо именованными захватывающими группами.

Поддержка Unicode

Этот класс соответствует уровню 1 Технического стандарта Unicode № 18: регулярные выражения Unicode, а также RL2.1 «Канонические эквиваленты» и RL2.2 «Расширенные графемные кластеры».

Управляющие последовательности Unicode, такие как \u2014 в исходном коде Java, обрабатываются, как описано в разделе §3.3 документа Спецификация языка Java. Такие управляющие последовательности также реализованы непосредственно в анализаторе регулярных выражений, поэтому escape-последовательности Unicode можно использовать в выражениях, считанных из файлов или с клавиатуры. Таким образом, строки "\u2014" и "\\u2014", хотя и не равны, компилируются в один и тот же шаблон, который соответствует символу с шестнадцатеричным значением 0x2014.

Символ Unicode также можно задать непосредственно с помощью шестнадцатеричной записи (значения кодовой точки в шестнадцатеричном формате), как описано в конструкции \x{...}. Например, дополнительный символ U+2011F можно задать как \x{2011F} вместо двух последовательных управляющих последовательностей Unicode для суррогатной пары \uD840\uDD1F.

Имена символов Unicode поддерживаются конструкцией именованного символа \N{...}; например, \N{WHITE SMILING FACE} задаёт символ \u263A. Имена символов, поддерживаемые этим классом, — это допустимые имена символов Unicode, соответствующие Character.codePointOf(name).

Расширенные графемные кластеры Unicode поддерживаются механизмом сопоставления графемных кластеров \X и соответствующим механизмом сопоставления границ \b{g}.

Скрипты, блоки, категории и двоичные свойства Unicode записываются с помощью конструкций \p и \P, как в Perl. \p{prop} соответствует входным данным, если они обладают свойством prop, тогда как \P{prop} не соответствует входным данным, если они обладают этим свойством.

Скрипты, блоки, категории и двоичные свойства можно использовать как внутри, так и вне класса символов.

Скрипты указываются либо с префиксом Is, как в IsHiragana, либо с помощью ключевого слова script (или его краткой формы sc), как в script=Hiragana или sc=Hiragana.

Поддерживаемые в Pattern имена скриптов — это допустимые имена скриптов, принимаемые и определённые методом UnicodeScript.forName.

Блоки указываются с префиксом In, как в InMongolian, либо с помощью ключевого слова block (или его краткой формы blk), как в block=Mongolian или blk=Mongolian.

Поддерживаемые в Pattern имена блоков — это допустимые имена блоков, принимаемые и определённые методом UnicodeBlock.forName.

Категории можно указывать с необязательным префиксом Is: и \p{L}, и \p{IsL} обозначают категорию букв Unicode. Как и скрипты и блоки, категории также можно указать с помощью ключевого слова general_category (или его краткой формы gc), как в general_category=Lu или gc=Lu.

Поддерживаются категории из Стандарта Unicode в версии, указанной для класса Character. Имена категорий соответствуют именам, определённым в Стандарте, как нормативным, так и информативным.

Двоичные свойства указываются с префиксом Is, как в IsAlphabetic. В Pattern поддерживаются следующие двоичные свойства:

• 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

Следующие предопределённые классы символов и классы символов POSIX соответствуют рекомендациям из приложения C: свойства совместимости Технического стандарта Unicode № 18: регулярные выражения Unicode, если указан флаг UNICODE_CHARACTER_CLASS.

предопределённые классы символов и классы POSIX в режиме Unicode

Классы	Соответствует
\p{Lower}	Строчная буква:\p{IsLowercase}
\p{Upper}	Заглавная буква:\p{IsUppercase}
\p{ASCII}	Любой символ ASCII:[\x00-\x7F]
\p{Alpha}	Алфавитный символ:\p{IsAlphabetic}
\p{Digit}	Десятичная цифра:\p{IsDigit}
\p{Alnum}	Буквенно-цифровой символ:[\p{IsAlphabetic}\p{IsDigit}]
\p{Punct}	Знак пунктуации:\p{IsPunctuation}
\p{Graph}	Видимый символ: [^\p{IsWhite_Space}\p{gc=Cc}\p{gc=Cs}\p{gc=Cn}]
\p{Print}	Печатаемый символ: [\p{Graph}\p{Blank}&&[^\p{Cntrl}]]
\p{Blank}	Пробел или символ табуляции: [\p{IsWhite_Space}&&[^\p{gc=Zl}\p{gc=Zp}\x0a\x0b\x0c\x0d\x85]]
\p{Cntrl}	Управляющий символ: \p{gc=Cc}
\p{XDigit}	Шестнадцатеричная цифра: [\p{gc=Nd}\p{IsHex_Digit}]
\p{Space}	Пробельный символ:\p{IsWhite_Space}
\d	Цифра: \p{IsDigit}
\D	Символ, не являющийся цифрой: [^\d]
\s	Пробельный символ: \p{IsWhite_Space}
\S	Символ, не являющийся пробельным: [^\s]
\w	Словесный символ: [\p{Alpha}\p{gc=Mn}\p{gc=Me}\p{gc=Mc}\p{Digit}\p{gc=Pc}\p{IsJoin_Control}]
\W	Символ, не являющийся словесным: [^\w]

Категории, соответствующие логическим методам java.lang.Character ismethodname (за исключением устаревших), доступны с помощью того же синтаксиса \p{prop}, где указанное свойство имеет имя javamethodname.

Сравнение с Perl 5

Механизм Pattern выполняет традиционное сопоставление на основе NFA с упорядоченным чередованием, как в Perl 5.

Конструкции Perl, не поддерживаемые этим классом:

• Конструкции обратных ссылок \g{n} для захватывающей группы с номером n и \g{name} для именованной захватывающей группы.

• Условные конструкции (?(condition)X) и (?(condition)X|Y),

• Конструкции со встроенным кодом (?{code}) и (??{code}),

• Синтаксис встроенных комментариев (?#comment) и

• Операции предварительной обработки \l \u, \L и \U.

Конструкции, поддерживаемые этим классом, но не Perl:

• Объединение и пересечение классов символов, как описано выше.

Примечательные отличия от Perl:

• В Perl значения от \1 до \9 всегда интерпретируются как обратные ссылки; число с обратной косой чертой, большее 9, считается обратной ссылкой, если существует как минимум столько подвыражений, иначе оно интерпретируется, если возможно, как восьмеричная escape-последовательность. В этом классе восьмеричные escape-последовательности всегда должны начинаться с нуля. В этом классе значения от \1 до \9 всегда интерпретируются как обратные ссылки, а большее число принимается как обратная ссылка, если на этом месте регулярного выражения уже существует как минимум столько подвыражений; в противном случае анализатор будет отбрасывать цифры, пока число не станет меньше или равным имеющемуся числу групп либо не останется одна цифра.

• В Perl флаг g запрашивает сопоставление, которое продолжается с места завершения предыдущего сопоставления. Этот функционал неявно предоставляется классом Matcher: повторные вызовы метода find продолжают сопоставление с места завершения предыдущего, если только объект сопоставления не был сброшен.

• В Perl встроенные флаги в начале выражения влияют на всё выражение. В этом классе встроенные флаги всегда начинают действовать в том месте, где они указаны, независимо от того, находятся ли они на верхнем уровне или внутри группы; во втором случае действие флагов завершается в конце группы, как и в Perl.

• Режим свободного форматирования в Perl (в этом классе называемый режимом комментариев), обозначаемый в регулярном выражении конструкцией (?x) (или флагом COMMENTS при компиляции выражения), не игнорирует пробелы внутри классов символов. В этом классе пробелы внутри классов символов необходимо экранировать, чтобы в режиме комментариев они считались частью регулярного выражения.

Более точное описание поведения конструкций регулярных выражений см. в книге Освоение регулярных выражений, 3-е издание, Джеффри Э. Ф. Фридл, O'Reilly and Associates, 2006.