Класс Pattern

public final class Pattern extends Object implements Serializable

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

Регулярное выражение, заданное в виде строки, сначала должно быть скомпилировано в экземпляр этого класса. Полученный шаблон затем может использоваться для создания объекта 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 не являются безопасными для такого использования.

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

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

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

(?<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').

Группа с именем всё ещё нумеруется как описано в Номере группы.

Захваченный ввод, связанный с группой, всегда является подпоследовательностью, которой группа соответствовала в последний раз. Если группа оценивается второй раз из-за квантификации, то ее ранее захваченное значение, если оно есть, будет сохранено, если второе вычисление завершится неудачно. Сопоставление строки "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.

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

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

Скрипты, блоки, категории и бинарные свойства Юникода записываются с помощью конструкций \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} обозначают категорию символов Юникода. Как и скрипты и блоки, категории также могут быть заданы с помощью ключевого слова general_category (или его сокращённой формы gc) как в general_category=Lu или gc=Lu.

Поддерживаемые категории — это категории Стандарта Юникода в версии, указанной классом Character. Имена категорий определены в Стандарте, как нормативные, так и информационные.

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

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

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

predefined and posix character classes in Unicode mode

Классы	Соответствия
\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 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. В этом классе восьмеричные escapes всегда должны начинаться с нуля. В этом классе, \1 по \9 всегда интерпретируются как обратные ссылки, и большее число принимается как обратная ссылка, если по крайней мере столько подвыражений существует в этой точке регулярного выражения, иначе анализатор опустит цифры, пока число не станет меньше или равно существующему числу групп или не станет однозначным.

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

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

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

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