Tarefa Ant de Reprovação de API

Propósito

Esta tarefa executa uma análise de API completa de um perfil de API relativo a uma linha de base - procurando apenas membros (classes, campos, métodos) que foram reprovados/aprovados. O perfil é o estado atual de um produto em desenvolvimento. O perfil é comparado a uma linha de base de API para mudanças de reprovação (geralmente, o release anterior de um produto).

Uso

Descrição

O nome da tarefa Ant é: apitooling.apideprecation. Para ser usado, o arquivo jar apitooling-ant.jar deve estar no caminho de classe Ant.

<apitooling.apideprecation 	baseline="..."
	profile="..."
	report="..."
	excludelist="..."
	includelist="..."
	debug="..."
	eefile="..."
/>

Parâmetros

Atributo Descrição Necessário
baseline Este atributo especifica o local da linha de base de referência.

Pode ser um arquivo .zip, .jar, .tgz, .tar.gz, ou um diretório que corresponda à pasta de instalação do Eclipse. Este é o diretório no qual se localiza o Eclipse executável.

O local é especificado usando um caminho absoluto.
Sim
profile Este atributo especifica o local do produto ou perfil atual que você deseja comparar com relação à linha de base de referência.

Pode ser um arquivo .zip, .jar, .tgz, .tar.gz, ou um diretório que corresponda à pasta de instalação do Eclipse. Este é o diretório no qual se localiza o Eclipse executável.

O local é especificado usando um caminho absoluto.
Sim
report Configure o local de saída onde os relatórios serão gerados.

Depois que a tarefa for concluída, os relatórios estarão disponíveis neste diretório usando uma estrutura semelhante à raiz do filtro. Uma subpasta é criada para cada componente que tem problemas para ser relatado. Cada subpasta contém um arquivo chamado "report.xml".

Uma pasta especial chamada "allNonApiBundles" também é criada nesta pasta que também contém um arquivo chamado "report.xml". Este arquivo lista todos os pacotes configuráveis que não estão usando a natureza de Ferramentas da API.

O local é especificado usando um caminho absoluto.
Sim
excludelist Configure o local da lista de exclusão.

O local da lista de exclusão especifica um arquivo de texto listando pacotes configuráveis a serem excluídos da análise. Pelo padrão, todos os pacotes configuráveis no perfil são analisados. Os atributos da lista de inclusão e exclusão podem ser usados para seletivamente incluir e excluir pacotes configuráveis. Além disso, essa tarefa suporta a listagem de membros nas listas de inclusões e exclusões. A lista de inclusões fornece valores iniciais ao conjunto de pacotes configuráveis e membros a serem analisados (quando omitida, todos os pacotes configuráveis e membros são incluídos), e a lista de exclusões é então aplicada. Cada linha do arquivo especifica:
  • um nome de pacote configurável específico
  • um nome de membro específico
  • uma expressão regular contra a qual corresponder os nomes dos pacotes configuráveis ou membros (linhas com "R:")
  • um comentário (linhas com '#')

O local é especificado usando um caminho absoluto.
A seguir há um exemplo de lista de exclusão:
 # MEMBROS ECLIPSE

org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object;
 # PACOTES CONFIGURÁVEIS DO DOCUMENTO
 org.eclipse.jdt.doc.isv
 org.eclipse.jdt.doc.user
 org.eclipse.pde.doc.user
 org.eclipse.platform.doc.isv
 org.eclipse.platform.doc.user
 # PACOTES CONFIGURÁVEIS NÃO ECLIPSE
 com.ibm.icu
 com.jcraft.jsch
 javax.servlet
 javax.servlet.jsp
 ...
A lista de exclusão pode conter expressões regulares se a linha começar com "R:".
Não
includelist Configura o local da lista de inclusão.

O local da lista de inclusão especifica um arquivo de texto listando pacotes configuráveis a serem incluídos na análise. Pelo padrão, todos os pacotes configuráveis no perfil são analisados. Os atributos da lista de inclusão e exclusão podem ser usados para seletivamente incluir e excluir pacotes configuráveis. Além disso, essa tarefa suporta a listagem de membros nas listas de inclusões e exclusões. A lista de inclusões fornece valores iniciais ao conjunto de pacotes configuráveis e membros a serem analisados (quando omitida, todos os pacotes configuráveis e membros são incluídos), e a lista de exclusões é então aplicada. Cada linha do arquivo especifica:
  • um nome de pacote configurável específico
  • um nome de membro específico
  • uma expressão regular contra a qual corresponder os nomes dos pacotes configuráveis ou membros (linhas com "R:")
  • um comentário (linhas com '#')

O local é especificado usando um caminho absoluto.
A seguir há um exemplo de lista de inclusão:
 # MEMBROS ECLIPSE

org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object;
 # PACOTES CONFIGURÁVEIS DO DOCUMENTO
 org.eclipse.jdt.doc.isv
 org.eclipse.jdt.doc.user
 org.eclipse.pde.doc.user
 org.eclipse.platform.doc.isv
 org.eclipse.platform.doc.user
 # PACOTES CONFIGURÁVEIS NÃO ECLIPSE
 com.ibm.icu
 com.jcraft.jsch
 javax.servlet
 javax.servlet.jsp
 ...
Não
depuração Configure o valor da depuração.

Os valores possíveis são: true, false
O padrão é false.
Não
eefile Configure o arquivo de ambiente de execução a ser usado.

Por padrão, um arquivo de ambiente de execução correspondente a um ambiente de execução JavaSE-1.6 é usado.

O formato do arquivo é descrito nesta página wiki.

O arquivo é especificado usando um caminho absoluto.
Não

Exemplos

 <apitooling.apideprecation
  baseline="D:\eclipse\3.4.1\eclipse"
  profile="D:\eclipse-SDK-I20081118-0800-linux-gtk.tar.gz"

  report="D:\reports\xml"
  excludelist="D:\exclude_list_external.txt"
  debug="true"
 />

Isto executará a tarefa ao criar arquivos report.xml dentro da pasta D:\reports\xml. Isto usará a lista de exclusão para reduzir o número de problemas a serem relatados.

Como a depuração está ativada, aparecerão alguns rastreios de depuração no console Ant.

Referência relacionada

Tarefa Ant de Congelamento da API
Tarefa Ant de Geração de Arquivo
Tarefa Ant de Uso da API
Tarefa Ant de Conversão do Relatório de Análise
Tarefa Ant de Conversão de Relatório de Congelamento de API
Tarefa Ant de Conversão do Relatório de Uso da API
Tarefa Ant de Conversão do Relatório de Reprovação da API