Класс Pattern

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Номер группы

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

Группа нуль всегда соответствует всему выражению.

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

Имя группы

Группе захвата также можно присвоить "имя", named-capturing group, и затем на нее можно сослаться в дальнейшем по "имени". Имена групп состоят из следующих символов. Первый символ должен быть letter.

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

Группа захвата с именем всё равно нумеруется, как описано в разделе Номер группы.

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

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

Поддержка Юникода

Этот класс соответствует уровню 1 Технического стандарта Юникода №18: Регулярные выражения Юникода, плюс RL2.1 Канонические эквиваленты.

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

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

Скрипты, блоки, категории и бинарные свойства Юникода записываются с помощью конструкций \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-классы символов соответствуют рекомендациям Приложения C: Свойства совместимости Стандарта регулярных выражений Юникода, когда указан флаг UNICODE_CHARACTER_CLASS.

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

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

Двигатель Pattern выполняет традиционное сопоставление на основе NFA с упорядоченной альтернацией, как в Perl 5.

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

• Предопределённые классы символов (символ Юникода)

  \X Сопоставление Юникода расширенного кластера графем

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

• Конструкции символов с именем, \N{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.

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

Поля

UNIX_LINES

public static final int UNIX_LINES

См. также:

Значения постоянных полей

CASE_INSENSITIVE

public static final int CASE_INSENSITIVE

См. также:

Значения постоянных полей

COMMENTS

public static final int COMMENTS

См. также:

Значения постоянных полей

MULTILINE

public static final int MULTILINE

См. также:

Значения постоянных полей

LITERAL

public static final int LITERAL

С:

1.5

См. также:

Значения постоянных полей

DOTALL

public static final int DOTALL

См. также:

Значения постоянных полей

UNICODE_CASE

public static final int UNICODE_CASE

См. также:

Значения постоянных полей

CANON_EQ

public static final int CANON_EQ

См. также:

Значения постоянных полей

UNICODE_CHARACTER_CLASS

public static final int UNICODE_CHARACTER_CLASS

С:

1.7

См. также:

Значения постоянных полей

Методы

compile

public static Pattern compile(String regex)

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

Параметры:

regex - Выражение для компиляции

Возвращает:

Заданное регулярное выражение, скомпилированное в шаблон

Исключения:

PatternSyntaxException - Если синтаксис выражения некорректен

compile

public static Pattern compile(String regex,
                              int flags)

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

Параметры:

regex - Выражение для компиляции

flags - Флаги сопоставления, битовая маска, которая может включать CASE_INSENSITIVE, MULTILINE, DOTALL, UNICODE_CASE, CANON_EQ, UNIX_LINES, LITERAL, UNICODE_CHARACTER_CLASS и COMMENTS

Возвращает:

Заданное регулярное выражение, скомпилированное в шаблон с заданными флагами

Исключения:

IllegalArgumentException - Если установлены битовые значения, отличные от соответствующих определённым флагам сопоставления, в flags

PatternSyntaxException - Если синтаксис выражения некорректен

pattern

public String pattern()

Возвращает регулярное выражение, из которого был скомпилирован этот шаблон.

Возвращает:

Источник этого шаблона

toString

public String toString()

Переопределяет:

toString в классе Object

Возвращает:

Строковое представление этого шаблона

С:

1.5

matcher

public Matcher matcher(CharSequence input)

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

Параметры:

input - Последовательность символов для сопоставления

Возвращает:

Новый сопоставитель для этого шаблона

flags

public int flags()

Возвращает флаги сопоставления этого шаблона.

Возвращает:

Флаги сопоставления, указанные при компиляции этого шаблона

matches

public static boolean matches(String regex,
                              CharSequence input)

Pattern.matches(regex, input);

Pattern.compile(regex).matcher(input).matches()

Параметры:

regex - Выражение для компиляции

input - Последовательность символов для сопоставления

Возвращает:

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

Исключения:

PatternSyntaxException - Если синтаксис выражения некорректен

split

public String[] split(CharSequence input,
                      int limit)

Параметры:

input - Последовательность символов, которая должна быть разделена

limit - Пороговое значение результата, как описано выше

Возвращает:

Массив строк, вычисленный путем разделения ввода по совпадениям с этим шаблоном

split

public String[] split(CharSequence input)

Параметры:

input - Последовательность символов, которая должна быть разделена

Возвращает:

Массив строк, вычисленный путем разделения ввода по совпадениям с этим шаблоном

quote

public static String quote(String s)

Параметры:

s - Строка, которая должна быть записана как литерал

Возвращает:

Литеральное строковое представление

С:

1.5

asPredicate

public Predicate<String> asPredicate()

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

Возвращает:

Предикат, который может быть использован для сопоставления строки

С:

1.8

splitAsStream

public Stream<String> splitAsStream(CharSequence input)

Параметры:

input - Последовательность символов, которая должна быть разделена

Возвращает:

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

С:

1.8

См. также:

split(CharSequence)