Tarefa ant de geração de ficheiros de Ferramentas API

Finalidade

Esta tarefa é executada para gerar todos os ficheiros necessários pelas Ferramentas da API dentro de um lote binário. Esta tarefa é executada durante as construções do Eclipse ou durante a exportação de lotes para todos os projectos que têm uma natureza de Ferramentas da API.

Agora, apenas o ficheiro .api_description é criado.

Utilização

Descrição

O nome da tarefa ant é: apitooling.apigeneration. Para ser utilizado, o ficheiro jar apitooling-ant.jar tem de estar no caminho de classes Ant.

<apitooling.apigeneration
	projectname="..."
	project="..."
	binary="..."
	target="..."
	debug="..."
/>

Parâmetros

Atributo Descrição Necessário
projectname Define o nome do projecto Sim
projecto Define a localização do projecto.

Esta definição corresponde à pasta que contém todos os ficheiros de origem do projecto especificado.

A localização é especificada utilizando um caminho absoluto.
Sim
binário Define as localizações binárias.

Esta definição corresponde a uma lista de pastas ou ficheiros jar que contêm todos os ficheiros .class do projecto especificado. São separados pelo separador de caminhos da plataforma. Cada entrada tem de existir.

As localizações deverão ser especificadas utilizando um caminho absoluto.
Sim
target Define a localização do destino.

Esta definição corresponde à pasta em que os ficheiros gerados são gerados.

A localização é especificada utilizando um caminho absoluto.
Sim
debug Define o valor de depuração.

Os valores possíveis são: true, false
A predefinição é false.
Não
extraManifests Define as localizações de ficheiros manifest extra.

Esta definição corresponde a uma lista de localizações de ficheiros MANIFEST.MF extra que podem ser estabelecidos para fornecer mais pacotes da API para analisar. São separados pelo separador de caminhos da plataforma. Cada entrada tem de existir.

Se o caminho não for absoluto, será processado relativamente ao directório de trabalho actual.

Os ficheiros jar podem ser especificados em vez do ficheiro MANIFEST.MF. Se for especificado um ficheiro jar, o respectivo ficheiro MANIFEST.MF será lido, caso exista.
Não
extraSourceLocations Define as localizações de origem extra.

Esta definição corresponde a uma lista de localizações de ficheiros de origem que serão analisados. São separados pelo separador de caminhos da plataforma. Cada entrada tem de existir.

As localizações deverão ser especificadas utilizando um caminho absoluto.
Não
allowNonapiproject Permita que a tarefa seja executada em projectos activados por Ferramentas que não sejam da API.

Se esta tarefa for executada num projecto que não tem uma natureza de Ferramentas da API, nenhum ficheiro api_description será gerado já que se assume que o projecto não suporta Ferramentas da API. Em alguns casos, não é necessário gerar o ficheiro de descrição em projectos sem a natureza. Definir o parâmetro como true irá fazer com que a tarefa não irá verificar uma natureza.
Não

Exemplos

 <apitooling.apigeneration
  projectname="org.eclipse.jdt.core_3.5.0.v_927"
  project="d:\eclipse\org.eclipse.jdt.core"

  binary="d:\eclipse\org.eclipse.jdt.core\bin;d:\eclipse\org.eclipse.jdt.core\antbin"
  target="d:\plugins\org.eclipse.jdt.core"
  debug="true"
 />

Isto irá criar um ficheiro designado .api_description dentro da pasta d:\plugins\org.eclipse.jdt.core baseado na origem contida em d:\eclipse\org.eclipse.jdt.core e os ficheiros .class contidos em d:\eclipse\org.eclipse.jdt.core\bin.

Referência relacionada

Tarefa ant de análise
Tarefa ant de congelamento da API de Ferramentas API
Tarefa ant de utilização da API
Tarefa ant de conversão de relatórios de análise
Tarefa ant de conversão de relatórios de congelamento da API
Tarefa ant de desactualização da API
Tarefa ant de conversão de relatórios de desactualização da API
Tarefa ant de conversão de relatórios de utilização da API