Tämä tehtävä hakee annettua perustasoa ja luo raportin ohjelmointirajapinnan käytöstä.
Analyysi ei kata resurssijoukkoja, joissa ohjelmointirajapinnan työkalut eivät ole käytössä.
Ant-tehtävän nimi on apitooling.apiuse. Jar-tiedoston apitooling-ant.jar käyttö edellyttää, että tiedosto on Ant-tehtävän luokkapolussa.
<apitooling.apiuse location="..." scopepattern="..." referencepattern="..." report="..." considerinternal="..." considerapi="..." considerillegaluse="..." apipatterns="..." internalpatterns="..." archivepatterns="..." excludelist="..." includelist="..." debug="..." />
| Määrite | Kuvaus | Pakollinen |
| location |
Tämä määrite ilmaisee sen nykyisen tuotteen sijainnin, josta haluat etsiä ohjelmointirajapinnan käyttötietoja.
Sijainti voi olla .zip-, .jar-, .tgz- tai .tar.gz-tiedosto tai hakemisto, joka sisältää tuotteen tai resurssijoukkojen kokoelman. Sijainti määritetään absoluuttisen polun avulla. |
Kyllä |
| scopepattern |
Tämä määrite määrittää säännöllisen lausekkeen, jolla valitaan kohteen etsittävät resurssijoukot.
Esimerkiksi seuraava lauseke etsii vain Eclipse-resurssijoukkojen ohjelmointirajapinnan käytön: org.eclipse.*Mallin on oltava oikein muotoiltu säännöllinen lauseke, joka on määritetty tässä ohjeessa. |
Ei |
| referencepattern |
Tämä määrite määrittää säännöllisen lausekkeen, jolla suodatetaan hakutuloksia. Vain sellainen ohjelmointirajapinnan käyttö raportoidaan, joka viittaa suodatinta vastaavaan resurssijoukkoon.
Esimerkiksi seuraava lauseke raportoi vain käytön, joka viittaa JDT-koodiin: org.eclipse.jdt.*Mallin on oltava oikein muotoiltu säännöllinen lauseke, joka on määritetty tässä ohjeessa. |
Ei |
| report | Määrittää tulostussijainnin, johon raportit luodaan.
Kun tehtävä on valmis, raportit ovat käytettävissä tässä hakemistossa hierarkkisena rakenteena. Järjestelmä luo alikansion kullekin sellaiselle komponentille, johon jokin toinen resurssijoukko viittaa. Jokaisessa alikansiossa on tiedosto nimeltä [bundlename].xml. Tässä kansiossa on toinen alikansio (nimeltä [viittaavan resurssijoukon nimi].xml) kullekin resurssijoukolle, joka viittaa pääkansion resurssijoukkoon. Viittaavan resurssijoukon kansiossa on yksi kolmesta alikansiosta (API, PRIVATE tai OTHER), joka sisältää kyseisen tyypin laji-, metodi- tai kenttäviittaukset. Järjestelmä kirjoittaa raporttihakemistoon kolme muuta erityistiedostoa (tiedostot "counts.xml", "not_searched.xml" ja "no_apidescription.xml"). Niissä on tietoja löydettyjen viittausten määristä, perustason resurssijoukoista, joista ei ole etsitty käyttötietoja, sekä resurssijoukoista, jotka eivät sisällä .api_description-tiedostoja. Sijainti määritetään absoluuttisen polun avulla. Esimerkki: juuri | +-- "not_searched.xml" +-- "no_apidescription.xml" +-- "counts.xml" +-- käytettävän resurssijoukon nimi | +--viittaava resurssijoukon nimi | +-- [API tai PRIVATE tai OTHER] | +--[type_ tai method_ tai field_]references.xml |
Kyllä |
| considerinternal | Määrittää, otetaanko sisäiset viittaukset haussa huomioon.
Oletusarvo on false. |
Ei |
| considerapi | Määrittää, otetaanko ohjelmointirajapinnan viittaukset haussa huomioon.
Oletusarvo on false. |
Ei |
| considerillegaluse | Määrittää, otetaanko virheelliset ohjelmointirajapinnan käytön viittaukset huomioon haussa.
Oletusarvo on false. |
Ei |
| apipatterns | Pilkuin erotettu luettelo pakettien nimimalleista (säännöllisistä lausekkeista), joita käsitellään ohjelmointirajapinnan paketteina.
Oletusarvon mukaan ohjelmointirajapinnan kuvauksia käytetään etsityissä resurssijoukoissa, mutta ohjelmointirajapinnan paketteja voidaan ohittaa ja lisätä tämän määrityksen avulla. |
Ei |
| internalpatterns | Pilkuin erotettu luettelo pakettien nimimalleista (säännöllisistä lausekkeista), joita käsitellään yksityisinä paketteina.
Oletusarvon mukaan ohjelmointirajapinnan kuvauksia käytetään etsityissä resurssijoukoissa, mutta yksityisiä paketteja voidaan ohittaa ja lisätä tämän määrityksen avulla. |
Ei |
| archivepatterns | Pilkuin erotettu luettelo arkistotunnuksista, jotka ohitetaan etsinnässä.
Arkistotunnuksen muoto on: [resurssijoukon tunnus]:[arkiston polku]. |
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: # EXCLUDED BUNDLES R:org\.eclipse\..*\.doc\..* ... |
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: # INCLUDED BUNDLES R:org\.eclipse\..* ... |
Ei |
| filters | Määrittää haun aikana käytettävien ohjelmointirajapinnan suodattimien juurihakemiston.
Argumentti on niiden .api_filters-tiedostojen juurihakemisto, joita on käytettävä suodatettaessa viittauksia. .api_filters-tiedostot määrittävät tietyt ongelmat ohitettaviksi ohjelmointirajapinnan analyysissä. Ongelmasuodattimet muunnetaan haun aikana luetteloksi viittauksista, jotka suodatetaan käyttöetsinnän tuloksista. Juurihakemisto määritetään absoluuttisen polun avulla. Juurihakemiston on sisällettävä seuraava rakenne:
juuri
|
+-- komponentin nimi (eli org.eclipse.jface)
|
+--- .api_filters
|
Ei |
| debug | Määrittää vianmääritysarvon.
Mahdolliset arvot ovat seuraavat: true, false
Oletusarvo on false. |
Ei |
<apitooling.apiuse location="/eclipse/eclipse.tar.gz" scopepattern=".*" referencepattern="org\.eclipse.*" report="/eclipse/apiuse-both/XML" considerinternal="true" considerapi="true" considerillegaluse="true" archivepatterns="org.eclipse.test.bundle:/libs/contributed.jar" excludelist="D:\exclude_list_external.txt" debug="true" />
Järjestelmä ajaa tehtävän, joka luo *.xml-tiedostot kansioon /eclipse/apiuse-both/XML.
Tehtävä etsii kaikista säännöllisen lausekkeen .* määrittämässä tuotesijainnissa olevista resurssijoukoista kaikki viittaukset resurssijoukkoihin, joiden tunnuksen alku on org.eclipse (määritetään säännöllisellä lausekkeella org\.eclipse.*).
Tehtävä pienentää raportoitavien ongelmien määrää käyttämällä pois suljettavien luetteloa kohteessa D:\exclude_list_external.txt.
Etsintätoiminto ohittaa kaikki /libs/contributed.jar-arkiston resurssijoukon org.eclipse.test.bundle luokkatiedostot.
Jos vianmääritys on käytössä, Ant-konsoliin tulee näkyviin vianmäärityksen jäljitystietoja.

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