Esta tarefa fornece uma determinada pesquisa de utilização da API e tenta processá-la novamente a partir de uma determinada edição do produto candidato e regista quaisquer referências não processadas.
O nome da tarefa ant é: apitooling.apimigration. Para ser utilizado, o
ficheiro jar apitooling-ant.jar tem de estar no caminho de classes
Ant.
<apitooling.apimigration
candidate="..."
usescan="..."
scopepattern="..."
referencepattern="..."
excludelist="..."
includelist="..."
report="..."
debug="..."
/>
| Atributo | Descrição | Necessário |
| candidate |
Este atributo especifica o produto que pretende utilizar como candidato de migração. 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. |
Sim |
| usescan |
Este atributo especifica a pesquisa de utilização do produto que pretende comparar com o candidato da migração. O atributo usescan é especificado utilizando um caminho absoluto para a raiz da pesquisa de utilização. |
Sim |
| scopepattern |
Este atributo especifica o padrão de expressão regular utilizado para construir o âmbito de elementos a pesquisar para encontrar referências à localização do produto.
O padrão tem de ser uma expressão regular bem formatada conforme se define aqui. |
Não |
| referencepattern |
Defina o padrão de expressão regular utilizado para construir o âmbito dos elementos para pesquisar referências na localização do produto.
O padrão tem de ser uma expressão regular bem formatada conforme se define aqui. |
Não |
| 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: # EXCLUDED BUNDLES R:org\.eclipse\..*\.doc\..* ... |
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: # INCLUDED BUNDLES R:org\.eclipse\..* ... |
Não |
| report |
Define a localização da saída de dados em que os relatórios são gerados.
Após a conclusão da tarefa, existem relatórios disponíveis no directório indicado que utilizam uma estrutura hierárquica. É criada uma subpasta para cada componente que tem outro agrupamento que o refere. Cada subpasta contém um ficheiro chamado "[bundlename].xml". Dentro dessa pasta existe outra subpasta (com o nome "[nome agrupamento referenciado].xml") para cada agrupamento que faça referência ao agrupamento da pasta que o contém. Dentro da pasta de agrupamentos referenciados está uma das subpastas de árvore (API, PRIVATE ou OTHER) que contém as referências de tipo, método ou campo dessa categoria. No directório do relatório, são escritos também dois outros ficheiros especiais: "not_searched.xml" e "no_apidescription.xml", os quais contêm respectivamente informações sobre agrupamentos da linha de base em que não foi efectuada a pesquisa de informações de utilização e sobre agrupamentos que não continham um ficheiro .api_description. A localização é especificada utilizando um caminho absoluto. Por exemplo:
root
|
+-- "not_searched.xml"
+-- "no_apidescription.xml"
+-- bundle name with usage
|
+--referencing bundle name
|
+-- [API or PRIVATE or OTHER]
|
+--[type_ or method_ or field_]references.xml
|
Sim |
| debug |
Define o valor de depuração.
Os valores possíveis são: true,
falseA predefinição é false.
|
Não |
<apitooling.apimigration
candidate="/eclipse/sdk3.5"
usescan="/eclipse/scans/sdk3.4"
scopepattern=".*"
referencepattern="org\.eclipse.*"
excludelist="D:\exclude_list_external.txt"
report="/eclipse/apimigration/xml"
debug="true"
/>
Este exemplo irá executar os ficheiros de criação de tarefas *.xml dentro da pasta /eclipse/apimigration/xml.
A
tarefa irá reprocessar todas as referências de localização
usescan - definidas pela expressão
regular .* - contra o produto do candidato
cujo identificador começa por org.eclipse (definido pela
expressão regular org\.eclipse.*). Irá utilizar o ficheiro da lista de exclusões localizado em D:\exclude_list_external.txt para reduzir o número de problemas a registar.
Se a depuração estiver activada, aparecerá alguma indicação de rastreio na consola ant.
Tarefa ant de congelamento da API de Ferramentas API
Tarefa ant de geração de ficheiros
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
Tarefa ant de conversão de relatórios de migração de utilização da API