Esta tarefa resolve as Varreduras de Uso da API em um perfil em relação a uma linha de base. Ela relata as referências aos tipos, métodos e campos que agora estão ausentes do perfil.
O nome da tarefa Ant é: apitooling.apiusescanproblems. Para ser usado, o arquivo jar apitooling-ant.jar deve estar no caminho de classe Ant.
<apitooling.apiusescanproblems profile="..." report="..." apiusescans="..." excludelist="..." includelist="..." preferences="..." debug="..." />
| Atributo | Descrição | Necessário |
| profile | Este atributo especifica o local do produto atual ou perfil contra o qual deseja resolver as Varreduras
de Uso da API.
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 estiver concluída, os relatórios estarão disponíveis neste diretório. Uma subpasta é criada para cada componente que tem problemas para ser relatado. Cada subpasta contém um arquivo chamado "report.xml". O local é especificado usando um caminho absoluto. |
Sim |
| apiusescans | Este atributo especifica a lista separada por vírgula dos locais das Varreduras de Uso da API contra os
quais deseja verificar o perfil.
Ele pode ser um arquivo .zip ou um diretório que corresponda ao relatório de Varredura de Uso da API. Esse é o diretório no qual é possível localizar a pasta XML na Varredura de Uso. |
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:
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 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. 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:
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 R:org.eclipse.platform.doc.* # PACOTES CONFIGURÁVEIS NÃO ECLIPSE com.ibm.icu com.jcraft.jsch R:javax\..* ... |
Não |
| preferences | Configure as preferências para a tarefa.
As preferências são usadas para configurar gravidades de problemas. As gravidades de problemas possuem três valores possíveis: Ignorar, Aviso ou Erro. O conjunto de problemas detectados é definido pelas chaves de preferência de problema correspondentes nas ferramentas da API. O local é especificado usando um caminho absoluto. Se o local fornecido não existir, as preferências não serão configuradas. As linhas que iniciam com '#' são ignoradas. O formato do arquivo de preferências é semelhante a este: #Thu Nov 20 17:35:06 EST 2008 API_USE_SCAN_TYPE_SEVERITY=Error API_USE_SCAN_METHOD_SEVERITY=Error API_USE_SCAN_FIELD_SEVERITY=ErrorAs chaves podem ser localizadas em org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes. |
Não |
| depuração | Configure o valor da depuração.
Os valores possíveis são: true, false
O padrão é false.
|
Não |
<apitooling.apiusescanproblems profile="D:\eclipse\3.7\eclipse" report="D:\reports\xml" apiusescans="D:\APIUseScan\ProductOne,D:\APIUseScan\ProductTwo" excludelist="D:\exclude_list_external.txt" preferences="D:\tests_api\org.eclipse.pde.api.tools.prefs" debug="true" />
Isto executará a tarefa ao criar arquivos report.xml dentro da pasta D:\reports\xml. Os
tipos, métodos e campos das varreduras de uso serão resolvidos no perfil em D:\eclipse\3.7\eclipse e os
ausentes serão relatados.
Ele usará a lista de exclusões no arquivo D:\exclude_list_external.txt para reduzir o número de pacotes
configuráveis para os quais relatar os problemas.
As gravidades de problemas serão geradas conforme especificado por D:\tests_api\org.eclipse.pde.api.tools.prefs.
Como a depuração está ativada, aparecerão alguns rastreios de depuração no console Ant.

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