Esta tarefa processa as Pesquisas de utilização da API num perfil relativo a uma linha de base. Regista as referências a tipos, métodos e campos que estão agora em falta do perfil.
O nome da tarefa Ant é: apitooling.apiusescanproblems. Para ser utilizada, o ficheiro jar apitooling-ant.jar tem de estar no caminho de classe de ant.
<apitooling.apiusescanproblems profile="..." report="..." apiusescans="..." excludelist="..." includelist="..." preferences="..." debug="..." />
| Atributo | Descrição | Necessário |
| profile | Este atributo especifica a localização do produto ou perfil actual que pretende processar contra as Pesquisas de utilização da API.
Pode ser um ficheiro .zip, .jar, .tgz ou .tar.gz, ou um directório que corresponda a um pasta de instalação do Eclipse. Este directório é onde se encontra o executável do Eclipse. A localização é especificada utilizando um caminho absoluto. |
Sim |
| report | Define a localização da saída de dados em que os relatórios são gerados.
Assim que a tarefa for concluída, os relatórios ficam disponíveis neste directório. É criada uma subpasta para cada componente que tem problemas para ser comunicados. Cada subpasta contém um ficheiro chamado "report.xml". A localização é especificada utilizando um caminho absoluto. |
Sim |
| apiusescans | Este atributo especifica uma lista separada por vírgulas das localizações da Pesquisas de utilização da API contra as quais pretende verificar o perfil.
Pode ser um ficheiro .zip ou um directório que corresponda a um relatório de Pesquisa de utilização da API. Este é o directório onde pode encontrar a pasta XML na Pesquisa de utilização. |
Sim |
| excludelist | Define a localização da lista de exclusão.
A localização da lista de exclusões especifica um ficheiro de texto que lista os lotes a excluir da análise. Por predefinição, todos os lotes no perfil serão analisados. Os atributos da lista de exclusões e inclusões podem ser utilizados, de forma selectiva, para incluir e excluir lotes. A lista de inclusões dissemina o conjunto de lotes a analisar (quando omitidos, todos os lotes são incluídos), e a lista de exclusões é então aplicada. Cada linha do ficheiro especifica:
A localização é especificada utilizando um caminho absoluto. A seguir encontra-se um exemplo de uma lista de exclusões: # DOC BUNDLES 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 # NON-ECLIPSE BUNDLES com.ibm.icu com.jcraft.jsch R:javax\..* ... |
Não |
| includelist | Defina a localização da lista de inclusões. A localização da lista de inclusões especifica um ficheiro de texto que lista os lotes a incluir da análise. Por predefinição, todos os lotes no perfil serão analisados. Os atributos da lista de exclusões e inclusões podem ser utilizados, de forma selectiva, para incluir e excluir lotes. A lista de inclusões dissemina o conjunto de lotes a analisar (quando omitidos, todos os lotes são incluídos), e a lista de exclusões é então aplicada. Cada linha do ficheiro especifica:
A localização é especificada utilizando um caminho absoluto. A seguir encontra-se um exemplo de uma lista de inclusões: # DOC BUNDLES org.eclipse.jdt.doc.isv org.eclipse.jdt.doc.user org.eclipse.pde.doc.user R:org.eclipse.platform.doc.* # NON-ECLIPSE BUNDLES com.ibm.icu com.jcraft.jsch R:javax\..* ... |
Não |
| preferências | Define as preferências para a tarefa.
As preferências são utilizadas para configurar níveis de gravidade de problemas. Existem três valores possíveis para o nível de gravidade de problemas: Ignorar, Aviso ou Erro. O conjunto de problemas detectado é definido pelas chaves de preferências de problemas correspondentes nas ferramentas da API. A localização é especificada utilizando um caminho absoluto. Se a localização indicada não existir, as preferências não serão estabelecidas. As linhas que começam por '#' são ignoradas. O formato do ficheiro de preferências é semelhante ao seguinte: #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 encontradas em org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes. |
Não |
| debug | Define o valor de depuração.
Os valores possíveis são: true, false
A predefiniçã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 irá executar a tarefa criando ficheiros report.xml dentro da pasta D:\reports\xml. Os tipos, métodos e campos das pesquisas de utilização
serão processados no perfil em D:\eclipse\3.7\eclipse e os que estão em falta serão registados.
Irá utilizar a lista de exclusões do ficheiro D:\exclude_list_external.txt para reduzir o número de lotes para os problemas a registas.
As gravidades dos problemas serão geradas conforme especificado por D:\tests_api\org.eclipse.pde.api.tools.prefs.
Uma vez que a depuração está activada, aparecerá alguma indicação de rastreio na consola ant.

Tarefa Ant de análise da API
Tarefa ant de congelamento da API
Tarefa ant de geração de ficheiros
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 conversão de relatórios de utilização da API
Tarefa ant de desactualização da API
Tarefa ant de conversão de relatórios de desactualização da API