Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / Java

Matcher.group() e Matcher.group(int): correspondência completa e grupos

Após uma correspondência bem-sucedida, obtém todo o texto correspondente ou apenas o texto de um grupo de captura. O grupo 0 representa a correspondência completa.

Versão: Java SE 21

Sintaxe

public String group()
public String group(int group)

No Java SE 21, java.util.regex.Matcher disponibiliza três sobrecargas de group que devolvem um String. Esta entrada descreve group() e group(int); a terceira sobrecarga, group(String), devolve o texto capturado por um grupo com nome. Matcher.group() devolve todo o excerto correspondente da entrada e é equivalente a group(0). Com um índice de 1 a groupCount(), Matcher.group(int) devolve o texto capturado pelo grupo escolhido. Os grupos de captura são numerados da esquerda para a direita pela ordem dos parênteses de abertura. Um grupo sem captura (?:...) não recebe número e groupCount() não inclui o grupo 0.

Lê os grupos depois de matches(), find() ou lookingAt() devolver true. matches() verifica toda a região atual da entrada, find() procura o próximo excerto correspondente e lookingAt() verifica se há uma correspondência no início da região, sem exigir que a cubra por completo. Os métodos group não procuram correspondências. Lê os valores de que precisas antes da tentativa seguinte ou de chamar reset().

Se houver uma correspondência, mas o grupo escolhido não participar nela, group(int) devolve null. Se o grupo participar e corresponder a zero caracteres, devolve a cadeia de caracteres vazia "". Antes da primeira tentativa, após uma tentativa falhada ou após reset() sem nova tentativa, as duas sobrecargas lançam IllegalStateException. Com um estado de correspondência válido, um índice fora do intervalo provoca IndexOutOfBoundsException. Alterar o padrão com usePattern(...) após uma correspondência bem-sucedida elimina os dados dos grupos; antes da tentativa seguinte, ambas as sobrecargas podem devolver null.

Exemplos

import java.util.regex.Matcher;
import java.util.regex.Pattern;

public class Main {
    public static void main(String[] args) {
        Pattern pattern = Pattern.compile("(ID)-([0-9]+)([A-Z])?([ ]*)");
        Matcher matcher = pattern.matcher("item: ID-42");

        if (matcher.find()) {
            System.out.println("group() = [" + matcher.group() + "]");
            System.out.println("group(0) = [" + matcher.group(0) + "]");
            System.out.println("group(1) = [" + matcher.group(1) + "]");
            System.out.println("group(2) = [" + matcher.group(2) + "]");
            System.out.println("group(3) = " + matcher.group(3));
            System.out.println("group(4) = [" + matcher.group(4) + "]");
        }
    }
}

Resultado

group() = [ID-42]
group(0) = [ID-42]
group(1) = [ID]
group(2) = [42]
group(3) = null
group(4) = []

`find()` encontra `ID-42` em `item: ID-42`. O grupo 3 não participa porque a letra opcional não está presente. O grupo 4 corresponde a zero espaços, pelo que `[]` mostra uma cadeia de caracteres vazia.

Lições relacionadas

  • Java · Lição 70 · Básico · Versão: 2

Fontes