Tarefa Ant de Comparação

Propósito

Esta tarefa executa uma comparação completa de um perfil de API relativo a uma linha de base.

Uso

Descrição

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

<apitooling.compare 	baseline="..."
	profile="..."
	report="..."
	excludelist="..."
	includelist="..."
	components="..."
	visibility="..."
	debug="..."
/>

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 o relatório será gerado.

Depois que a tarefa for concluída, o relatório chamado "compare.xml" estará disponíveis neste diretório.

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. A lista de inclusão fornece o valor inicial do conjunto de pacotes configuráveis a ser analisado (quando omitido, todos os pacotes configuráveis são incluídos) e a lista de exclusão é então aplicada. Cada linha do arquivo especifica:
  • um nome de pacote configurável específico
  • uma expressão regular com a qual corresponder os nomes dos pacotes configuráveis (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:
 # 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
 # Exclude all pde bundles
 R:org\.eclipse\.pde\..*
 ...
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. A lista de inclusão fornece o valor inicial do conjunto de pacotes configuráveis a ser analisado (quando omitido, todos os pacotes configuráveis são incluídos) e a lista de exclusão é então aplicada. Cada linha do arquivo especifica:
  • um nome de pacote configurável específico
  • uma expressão regular com a qual corresponder os nomes dos pacotes configuráveis (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:
 # 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
 # Exclude all pde bundles
 R:org\.eclipse\.pde\..*
 ...
Não
depuração Configure o valor da depuração.

Os valores possíveis são: true, false
O padrão é false.
Não
componentes Configure o local da lista de componentes.

A lista dos componentes contém todos os nomes dos componentes que devem ser comparados. Se for omitida, todos os componentes a partir da linha de base especificada são comparados.
O local é especificado usando um caminho absoluto.
O formato do arquivo da lista dos componentes se parece com o seguinte:
 # 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
 # Include all pde bundles
 R:org\.eclipse\.pde\..*
 ...
A lista dos componentes pode conter expressões regulares se a linha começar com "R:".
Não
visibilidade Configure o valor de visibilidade.

Os valores possível são: API, ALL
O padrão é API.
Não

Exemplos

	<apitooling.compare 		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"
	/>

Isso executará a tarefa criando os arquivos compare.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