Assistente de Padrões de Uso da API

Este assistente ajuda a orientar sobre a criação de padrões de expressão regular para controlar uma análise de Uso de API.

Para ativar o assistente, utilize as seguintes etapas:

  1. Durante a criação de uma nova configuração de ativação de Relatório de Uso de API, alterne para a guia Padrões.
  2. Na guia, pressione o botão Incluir...

Opção

Descrição

Padrão

Tipos de Padrão Esta listagem mostra todos os padrões que podem ser criados com o assistente. Primeiro elemento na lista
Descrição Mostra a descrição legível do tipo de padrão selecionado na listagem Tipos de Padrão.  

A primeira página do assistente permite selecionar o tipo de padrão que você gostaria de criar. As descrições de cada padrão são fornecidas para ajudar você escolher - basta selecionar o padrão e a descrição é exibida no campo Descrição.

Assistente do Padrão de Uso da API - Página de Seleção de Padrão

Padrões de Archive

Quando a análise de uso da API é concluída, todas as pastas e archives em um pacote configurável são varridas; assegurando que todos os arquivos de classe sejam analisados. Em alguns casos, um pacote configurável pode conter um archive com versões antigas de arquivos de classe (por exemplo) que você não deseja analisar. Neste caso, um padrão de archive pode ser usado para ignorar completamente um archive específico ou todos os archives correspondentes a uma determinada expressão regular.

Opção

Descrição

Padrão

Nome do Pacote O nome simbólico completo do pacote configurável ao qual aplicar esse padrão. Por exemplo: org.eclipse.pde.api.tools. empty
Nome do Archive O nome completo ou a expressão regular do(s) archive(s) ao qual aplicar o padrão. Por exemplo: *.jar - que ignorará qualquer arquivo JAR aninhado. empty

Assistente do Padrão de Uso da API - Criando Padrões de Archive

Padrões de Pacote

Ao extrair referências para análise, o mecanismo de procura de Uso da API usa metadados do pacote configurável para determinar se uma referência é interna ou não. Em alguns casos, um pacote configurável não foi configurado para descrever de forma adequada quais classes são internas e quais não são. Um Padrão de Pacote permite aumentar esses pacotes configuráveis com formato incorreto - somente do ponto de vista do mecanismo de procura, o pacote configurável real não é alterado de maneira alguma - para descrever qual é interno ou qual não é.

Opção

Descrição

Padrão

Padrão O padrão de expressão regular com relação ao qual fazer a correspondência de pacotes. Por exemplo: .*\.internal\..*. empty
Padrão de API Se o padrão deve fazer com que os pacotes correspondentes sejam considerados como API ou não. checked

Assistente do Padrão de Uso da API - Criando Padrões de Pacote

Padrões de Conversão de Relatórios

Quando uma análise de uso da API é concluída, pode haver uma grande quantidade de informações para verificar. Com um padrão de conversão de relatório assim, você pode reduzir as informações de referência apresentadas nos relatórios HTML para ver apenas o que é de seu interesse. Para fazer isso, você pode criar padrões de exclusão usados para remover as referências que são relatadas.

Opção

Descrição

Padrão

Filtrar referências a esse padrão Permite ignorar as referências de relatório ao padrão. Por exemplo, se o padrão era org\.eclipse\.jdt\..*, selecionar essa opção não relatará nenhuma referência feita ao JDT. selected
Filtrar referências a partir deste padrão Permite ignorar as referências de relatório ao padrão. Por exemplo, se o padrão era org\.eclipse\.jdt\..*, selecionar essa opção não relatará nenhuma referência a partir do JDT.  
Padrão O padrão de expressão regular. empty

Assistente do Padrão de Uso da API - Criando Padrões de Conversão de Relatório

Tarefas relacionadas

Configurando as Ferramentas da API

Referência relacionada

Ação de Configuração das Ferramentas da API
Menu de Ferramentas do PDE
Relatórios de Uso da API