Tarefa Ant de Congelamento da API

Propósito

Esta tarefa identifica APIs que foram incluídas, modificadas ou removidas com relação a uma linha de base de API. Esta tarefa é destinada a validar alterações de não API que ocorrem após um congelamento de API.

Uso

Descrição

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

<apitooling.apifreeze 	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 nome do arquivo de relatório a ser gerado.

Ele deve ser especificado usando um caminho absoluto.
Esse deve ser um local de arquivo, não um diretório.
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:
# ECLIPSE MEMBERS
org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object;
# ECLIPSE BUNDLES org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_ERROR
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_WARNING
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_ELCL_COLLAPSEALL # NON-ECLIPSE BUNDLES com.ibm.icu
R:javax\..* ...
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:
# ECLIPSE MEMBERS
org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object;
# ECLIPSE BUNDLES org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_ERROR
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_WARNING
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_ELCL_COLLAPSEALL # NON-ECLIPSE BUNDLES com.ibm.icu
R:javax\..* ...
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.apifreeze 		baseline="D:\eclipse\3.4.1\eclipse"
		profile="D:\eclipse-SDK-I20081118-0800-linux-gtk.tar.gz"
		report="D:\report\report.xml"
		excludelist="D:\exclude_list.txt" 		debug="true" 	/>

Isto executará a tarefa criando report.xml dentro da pasta D:\report. Isto usará a lista de exclusão D:\exclude_list_external.txt para reduzir o número de problemas a relatar.

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

Referência relacionada

Tarefa Ant de Análise
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 Reprovação da API
Tarefa Ant de Conversão do Relatório de Reprovação da API
Tarefa Ant de Conversão do Relatório de Uso da API