Tato úloha vezme daný snímek použití rozhraní API, pokusí se ji znovu vyřešit v rámci daného vydání kandidátského produktu a nahlásí případné nevyřešené odkazy.
Název úlohy Ant je: apitooling.apimigration. Chcete-li ji použít, soubor JAR apitooling-ant.jar musí být v cestě ke třídě nástroje Ant.
<apitooling.apimigration
candidate="..."
usescan="..."
scopepattern="..."
referencepattern="..."
excludelist="..."
includelist="..."
report="..."
debug="..."
/>
| Atribut | Popis | Nezbytné |
| candidate |
Tento atribut určuje produkt, který chcete použít jako kandidáta migrace.
Může to být soubor .zip, .jar, .tgz, .tar.gz nebo adresář, který odpovídá instalačnímu adresáři Eclipse. To je adresář, v němž se nachází spustitelný soubor Eclipse. |
Ano |
| usescan |
Tento atribut určuje snímek použití produktu, který chcete porovnat s kandidátem na migraci. Atribut usescan je určen pomocí absolutní cesty ke kořenovému adresáři snímku použití. |
Ano |
| scopepattern |
Tento atribut určuje regulární výraz používaný k sestavení rozsahu prvků, kde se mají hledat odkazy typu from v umístění produktu. Vzorek musí být dobře naformátovaný regulární výraz, odpovídající této definici. |
Ne |
| referencepattern |
Nastaví vzorek regulárního výrazu používaného k sestavení rozsahu prvků, kde se mají hledat odkazy typu to v umístění produktu. Vzorek musí být dobře naformátovaný regulární výraz, odpovídající této definici. |
Ne |
| excludelist |
Nastavte umístění vylučovacího seznamu. Umístění vylučovacího seznamu určuje textový soubor obsahující seznam balíků, které se mají vyloučit z analýzy. Standardně se analyzují všechny balíky v profilu. Atributy zahrnovacího a vylučovacího seznamu lze použít k selektivnímu zahrnutí a vyloučení balíků. Seznam zahrnutí naplní sadu balíků, které se mají analyzovat (když je vynechán, zahrnou se všechny balíky), a poté se použije vylučovací seznam. Každý řádek souboru určuje jedno z následujících:
Umístění se zadává pomocí absolutní cesty. Následuje příklad vylučovacího seznamu: # EXCLUDED BUNDLES R:org\.eclipse\..*\.doc\..* ... |
Ne |
| includelist |
Nastavte umístění seznamu zahrnutí. Umístění seznamu zahrnutí určuje textový soubor obsahující seznam balíků, které se mají zahrnout do analýzy. Standardně se analyzují všechny balíky v profilu. Atributy zahrnovacího a vylučovacího seznamu lze použít k selektivnímu zahrnutí a vyloučení balíků. Seznam zahrnutí naplní sadu balíků, které se mají analyzovat (když je vynechán, zahrnou se všechny balíky), a poté se použije vylučovací seznam. Každý řádek souboru určuje jedno z následujících:
Umístění se zadává pomocí absolutní cesty. Následuje příklad seznamu zahrnutí: # INCLUDED BUNDLES R:org\.eclipse\..* ... |
Ne |
| report |
Nastavte umístění výstupu, kam se vygenerují sestavy. Jakmile je úloha dokončena, v tomto adresáři jsou k dispozici sestavy v hierarchické struktuře. Pro každou komponentu, na kterou odkazuje jiný balík, se vytvoří podsložka. Každá podsložka obsahuje soubor s názvem "[název balíku].xml". V této složce je další podsložka (s názvem "[název odkazujícího balíku].xml") pro každý balík, který odkazuje na balík obsahující složky. Uvnitř složky odkazujícího balíku je jedna ze tří podsložek (API, PRIVATE nebo OTHER) obsahujících odkazy na typy, metody nebo pole příslušného druhu. Do adresáře sestavy se zapíší dva další speciální soubory, "not_searched.xml" a "no_apidescription.xml", které obsahují informace o balících z baseline, v kterých nebyly hledány informace o využití a které v sobě neobsahovaly soubor .api_description. Umístění se zadává pomocí absolutní cesty. Například:
kořen
|
+-- "not_searched.xml"
+-- "no_apidescription.xml"
+-- název balíku s využitím
|
+--název odkazujícího balíku
|
+-- [API nebo PRIVATE nebo OTHER]
|
+--[type_ nebo method_ nebo field_]references.xml
|
Ano |
| ladění |
Nastavte hodnotu ladění. Možné hodnoty jsou: true,
falseVýchozí hodnota je false.
|
Ne |
<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"
/>
Tím se spustí úloha, která vytvoří soubory *.xml ve složce /eclipse/apimigration/xml. Tato úloha znovu vyřeší všechny odkazy v umístění určeném atributem usescan - definováno regulárním výrazem .* - proti kandidátskému produktu, jehož identifikátor začíná na org.eclipse (definováno regulárním výrazem org\.eclipse.*). Ke snížení počtu hlášených problémů se použije vylučovací seznam v souboru D:\exclude_list_external.txt.
Pokud je povoleno ladění, na konzole Ant se zobrazí určitá ladicí trasování.
Úloha Ant zmrazení API
Úloha Ant generování souboru
Úloha Ant převodu sestavy analýzy
Úloha Ant převodu sestavy zmrazení API
Úloha Ant nepřípustnosti rozhraní API
Úloha Ant převodu sestavy nepřípustnosti rozhraní API
Úloha Ant převodu sestavy využití API
Úloha ANT převodu sestavy migrace použití rozhraní API