Tämä tehtävä ajaa täydellisen ohjelmointirajapinta-analyysin perustasoon liittyvästä ohjelmointirajapinnan profiilista. Analyysi kattaa ohjelmointirajapinnan käytön, binaariyhteensopivuuden ja resurssijoukon versionumeron tarkistuksen. Profiili on kehitettävän tuotteen nykyinen tila. Järjestelmä vertaa profiilia ohjelmointirajapinnan perustasoon binaariyhteensopivuutta varten (yleensä tuotteen edellinen versio).
Analyysi ei kata @since-tunnisteiden tarkistusta, koska kaikki tarkistukset kohdistuvat binaarisiin luokkatiedostoihin (lähdettä ei analysoida).
Ant-tehtävän nimi on apitooling.analysis. Jar-tiedoston apitooling-ant.jar käyttö edellyttää, että tiedosto on Ant-tehtävän luokkapolussa.
<apitooling.analysis baseline="..." profile="..." report="..." filters="..." excludelist="..." includelist="..." preferences="..." debug="..." eefile="..." />
| Määrite | Kuvaus | Pakollinen |
| baseline | Tämä määrite ilmaisee viiteperustason sijainnin.
Sijainti voi olla .zip-, .jar-, .tgz- tai .tar.gz-tiedosto tai Eclipse-järjestelmän asennuskansiota vastaava hakemisto. Eclipse-järjestelmän ohjelmatiedosto on tässä hakemistossa. Sijainti määritetään absoluuttisen polun avulla. |
Kyllä |
| profile | Tämä määrite ilmaisee sen nykyisen tuotteen tai profiilin sijainnin, jota on tarkoitus verrata viiteperustasoon.
Sijainti voi olla .zip-, .jar-, .tgz- tai .tar.gz-tiedosto tai Eclipse-järjestelmän asennuskansiota vastaava hakemisto. Eclipse-järjestelmän ohjelmatiedosto on tässä hakemistossa. Sijainti määritetään absoluuttisen polun avulla. |
Kyllä |
| report | Määrittää tulostussijainnin, johon raportit luodaan.
Kun tehtävä on valmis, raportit ovat käytettävissä tässä hakemistossa suodattimen juurihakemiston kaltaisena rakenteena. Järjestelmä luo alikansion kullekin sellaiselle komponentille, jossa on raportoitavia ongelmia. Jokaisessa alikansiossa on tiedosto nimeltä report.xml. Järjestelmä luo tähän kansioon myös erityisen kansion allNonApiBundles, joka sisältää myös tiedoston report.xml. Tiedostossa on luettelo kaikista resurssijoukoista, jotka eivät käytä ohjelmointirajapinnan työkalujen luonnetta. Lisäksi raporttihakemistoon luodaan tiedosto nimeltä "counts.xml", joka sisältää yhteenvedon havaituista ongelmista. Sijainti määritetään absoluuttisen polun avulla. |
Kyllä |
| filters | Määrittää analyysin aikana käytettävien ohjelmointirajapinnan suodattimien juurihakemiston.
Argumentti on niiden .api_filters-tiedostojen juurihakemisto, joita on käytettävä suodatettaessa ohjelmointirajapinnan työkaluanalyysin mahdollisesti luomia ongelmia. Juurihakemisto määritetään absoluuttisen polun avulla. Juurihakemiston on sisällettävä seuraava rakenne:
juuri
|
+-- komponentin nimi (eli org.eclipse.jface)
|
+--- .api_filters
|
Ei |
| excludelist | Määrittää pois suljettavien luettelon sijainnin.
Pois suljettavien luettelon sijainti määrittää tekstitiedoston, joka sisältää luettelon analyysistä pois suljettavista resurssijoukoista. Oletusarvon mukaan kaikki profiilin resurssijoukot analysoidaan. Resurssijoukkoja voidaan valikoivasti sisällyttää ja sulkea pois sisällyttävillä ja pois sulkevilla luettelomääritteillä. Sisällyttävä luettelo määrittää analysoitavat resurssijoukot (jos mitään ehtoa ei ole määritetty, kaikki resurssijoukot otetaan mukaan), ja pois sulkeva luettelo otetaan käyttöön. Tiedoston jokainen rivi määrittää yhden seuraavista:
Sijainti määritetään absoluuttisen polun avulla. Seuraavassa on esimerkki pois sulkevasta luettelosta: # 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\..* ... |
Ei |
| includelist | Määrittää sisällyttävän luettelon sijainnin.
Sisällyttävän luettelon sijainti määrittää tekstitiedoston, joka sisältää luettelon analyysiin sisällytettävistä resurssijoukoista. Oletusarvon mukaan kaikki profiilin resurssijoukot analysoidaan. Resurssijoukkoja voidaan valikoivasti sisällyttää ja sulkea pois sisällyttävillä ja pois sulkevilla luettelomääritteillä. Sisällyttävä luettelo määrittää analysoitavat resurssijoukot (jos mitään ehtoa ei ole määritetty, kaikki resurssijoukot otetaan mukaan), ja pois sulkeva luettelo otetaan käyttöön. Tiedoston jokainen rivi määrittää yhden seuraavista:
Sijainti määritetään absoluuttisen polun avulla. Seuraavassa on esimerkki sisällyttävästä luettelosta: # 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\..* ... |
Ei |
| preferences | Määrittää tehtävän oletusasetukset.
Oletusasetusten avulla määritetään ongelmien vakavuustasot. Ongelmien vakavuustaso voi olla jokin seuraavista: Ignore, Warning ja Error. Löytynyt ongelmajoukko määritetään vastaavilla ongelmien oletusasetusavaimilla ohjelmointirajapinnan työkaluissa. Sijainti määritetään absoluuttisen polun avulla. Jos annettua sijaintia ei ole, oletusasetusten määritys ei onnistu. Järjestelmä ohittaa merkillä # alkavat rivit. Oletusasetustiedoston muoto on seuraavanlainen: #Thu Nov 20 17:35:06 EST 2008 ANNOTATION_ELEMENT_TYPE_ADDED_METHOD_WITHOUT_DEFAULT_VALUE=Ignore ANNOTATION_ELEMENT_TYPE_CHANGED_TYPE_CONVERSION=Ignore ANNOTATION_ELEMENT_TYPE_REMOVED_FIELD=Ignore ANNOTATION_ELEMENT_TYPE_REMOVED_METHOD=Ignore ANNOTATION_ELEMENT_TYPE_REMOVED_TYPE_MEMBER=Warning API_COMPONENT_ELEMENT_TYPE_REMOVED_API_TYPE=Ignore API_COMPONENT_ELEMENT_TYPE_REMOVED_TYPE=Ignore CLASS_ELEMENT_TYPE_ADDED_METHOD=Error CLASS_ELEMENT_TYPE_ADDED_RESTRICTIONS=Ignore CLASS_ELEMENT_TYPE_ADDED_TYPE_PARAMETER=Ignore CLASS_ELEMENT_TYPE_CHANGED_CONTRACTED_SUPERINTERFACES_SET=Ignore ...Avaimet ovat kohdassa org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes. |
Ei |
| debug | Määrittää vianmääritysarvon.
Mahdolliset arvot ovat seuraavat: true, false
Oletusarvo on false.
|
Ei |
| eefile | Määrittää käytettävän toteutusympäristötiedoston.
Oletusarvon mukaan käytössä on JavaSE-1.6-toteutusympäristöä vastaava toteutusympäristötiedosto. Tiedoston muoto on kuvattu tällä wiki-sivulla. Tiedosto määritetään absoluuttisen polun avulla. |
Ei |
<apitooling.analysis baseline="D:\eclipse\3.4.1\eclipse" profile="D:\eclipse-SDK-I20081118-0800-linux-gtk.tar.gz" report="D:\reports\xml" filters="D:\filters" excludelist="D:\exclude_list_external.txt" preferences="D:\tests_api\org.eclipse.pde.api.tools.prefs" debug="true" />
Järjestelmä ajaa tehtävän, joka luo report.xml-tiedostot kansioon D:\reports\xml.
Tehtävä pienentää raportoivien ongelmien määrää käyttämällä pois suljettavien luetteloa sekä kohdissa D:\exclude_list_external.txt ja D:\filters olevia .api_filter-tiedostoja.
Ongelmien vakavuustasot luodaan kohdassa D:\tests_api\org.eclipse.pde.api.tools.prefs määritetyllä tavalla.
Vianmääritys on käytössä, joten vianmäärityksen jäljitystietoja tulee näkyviin Ant-konsoliin.

Ohjelmointirajapinnan jäädytyksen Ant-tehtävä
Tiedostojen luonnin Ant-tehtävä
Ohjelmointirajapinnan käytön Ant-tehtävä
Analyysiraportin muunnon Ant-tehtävä
Ohjelmointirajapinnan jäädytysraportin muunnon Ant-tehtävä
Ohjelmointirajapinnan käyttöraportin muunnon Ant-tehtävä
Ohjelmointirajapinnan vanhentumisen Ant-tehtävä
Ohjelmointirajapinnan vanhentumisraportin muunnon Ant-tehtävä