Tämä tehtävä ajaa täydellisen ohjelmointirajapinta-analyysin perustasoon liittyvästä ohjelmointirajapinnan profiilista - hakien vain vanhentuneita/ei-vanhentuneita jäseniä (luokat, kentät, metodit). Profiili on kehitettävän tuotteen nykyinen tila. Järjestelmä vertaa profiilia vanhentumismuutosten havaitsemiseksi ohjelmointirajapinnan perustasoon (yleensä tuotteen edellinen versio).
Ant-tehtävän nimi on apitooling.apideprecation. Jar-tiedoston apitooling-ant.jar käyttö edellyttää, että tiedosto on Ant-tehtävän luokkapolussa.
<apitooling.apideprecation
baseline="..."
profile="..."
report="..."
excludelist="..."
includelist="..."
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. Sijainti määritetään absoluuttisen polun avulla. |
Kyllä |
| 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ä. Lisäksi tämä tehtävä tukee jäsenten luetteloimista sisällyttävissä ja pois sulkevissa luetteloissa. Sisällyttävä luettelo määrittää analysoitavat resurssijoukot ja jäsenet (jos mitään ehtoa ei ole määritetty, kaikki resurssijoukot ja jäsenet 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: # ECLIPSE MEMBERS org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object; # 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 javax.servlet javax.servlet.jsp ...Pois sulkeva luettelo voi sisältää säännöllisiä lausekkeita, jos rivi alkaa merkkijonolla "R:". |
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ä. Lisäksi tämä tehtävä tukee jäsenten luetteloimista sisällyttävissä ja pois sulkevissa luetteloissa. Sisällyttävä luettelo määrittää analysoitavat resurssijoukot ja jäsenet (jos mitään ehtoa ei ole määritetty, kaikki resurssijoukot ja jäsenet 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: # ECLIPSE MEMBERS org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object; # 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 javax.servlet javax.servlet.jsp ... |
Ei |
| vianmääritys |
Määrittää vianmääritysarvon.
Mahdolliset arvot ovat seuraavat: true,
falseOletusarvo 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.apideprecation
baseline="D:\eclipse\3.4.1\eclipse"
profile="D:\eclipse-SDK-I20081118-0800-linux-gtk.tar.gz"
report="D:\reports\xml"
excludelist="D:\exclude_list_external.txt"
debug="true"
/>
Järjestelmä ajaa tehtävän, joka luo report.xml-tiedostot kansioon D:\reports\xml.
Tehtävä pienentää raportoitavien ongelmien määrää käyttämällä pois suljettavien luetteloa.
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 vanhentumisraportin muunnon Ant-tehtävä