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

Резюме по построению регулярных выражений

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

Построение	Сопоставляемое

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

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

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

Приоритет операторов классов символов следующий, от наивысшего к наименьшему:

Precedence of character class operators.

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

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

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

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

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

предопределенные и posix классы символов в режиме Юникода

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

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

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

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

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