Класс 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 не являются безопасными для такого использования.

Обзор конструкций регулярных выражений

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

Конструкция	Сопоставляет

(?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 $ соответствует символу, предшествующему разделителю строки, или концу входной последовательности.

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

Номер группы

Захватывающие группы нумеруются путем подсчета открывающих круглых скобок слева направо. В выражении ((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. Такие последовательности экранирования также реализуются непосредственно парсером регулярных выражений, так что последовательности экранирования 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.

Поддерживаемые категории — это категории из The Unicode Standard в версии, указанной классом Character. Названия категорий — это те, которые определены в стандарте, как нормативные, так и информативные.

Бинарные свойства задаются с префиксом Is, как в IsAlphabetic. Поддерживаемые бинарные свойства Pattern:

• Алфавитный
• Идеографический
• Буква
• Строчная
• Прописная
• Заглавная
• Пунктуация
• Управляющий
• Пробел
• Цифра
• Шестнадцатеричная цифра
• Управляющий объединением
• Несимвольный код точки
• Присвоенный

Следующие предопределенные классы символов и классы символов POSIX соответствуют рекомендациям Приложения C: Свойства совместимости Unicode Technical Standard #18: Unicode Regular Expressions, когда установлен флаг 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 boolean isметод (за исключением устаревших), доступны через тот же синтаксис \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, обрабатывается как обратная ссылка, если существует не менее такое количество подвыражений, в противном случае оно интерпретируется, если возможно, как восьмеричный символ. В этом классе восьмеричные символы всегда должны начинаться с нуля. В этом классе \1 по \9 всегда интерпретируются как обратные ссылки, и большее число принимается как обратная ссылка, если в данной точке регулярного выражения существует не менее такое количество подвыражений, в противном случае парсер будет отбрасывать цифры до тех пор, пока число не станет меньше или равно существующему числу групп или не станет однозначным.

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

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

Для более точного описания поведения конструкций регулярных выражений, пожалуйста, обратитесь к Mastering Regular Expressions, 3rd Edition, Jeffrey E. F. Friedl, O'Reilly and Associates, 2006.