Ohjelmointirajapinnan käyttöetsinnän ongelmien Ant-tehtävä

Käyttötarkoitus

Tämä tehtävä selvittää ohjelmointirajapinnan käyttöetsinnät perustasoon liittyvässä profiilissa. Se raportoi viittaukset tyyppeihin, metodeihin ja kenttiin, jotka nyt puuttuvat profiilista.

Käyttö

Kuvaus

Ant-tehtävän nimi on apitooling.apiusescanproblems. Jar-tiedoston apitooling-ant.jar käyttö edellyttää, että tiedosto on Ant-tehtävän luokkapolussa.

<apitooling.apiusescanproblems
	profile="..."
	report="..."
	apiusescans="..."
	excludelist="..."
	includelist="..."
	preferences="..."
	debug="..."
/>

Parametrit

Määrite Kuvaus Pakollinen
profile Tämä määrite ilmaisee sen nykyisen tuotteen tai profiilin sijainnin, josta haluat ratkaista ohjelmointirajapinnan käyttöetsinnät.

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. Järjestelmä luo alikansion kullekin sellaiselle komponentille, jossa on raportoitavia ongelmia. Jokaisessa alikansiossa on tiedosto nimeltä report.xml.

Sijainti määritetään absoluuttisen polun avulla.
Kyllä
apiusescans Tämä määrite määrittää pilkuilla erotetun luettelon niistä ohjelmointirajapinnan käyttöetsintöjen sijainneista, joita haluat verrata profiiliin.

Se voi olla .zip-tiedosto tai hakemisto, joka vastaa ohjelmointirajapinnan käyttöetsintöjen raporttia. Käyttöetsinnän XML-kansio on tässä hakemistossa.
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ä. 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:
  • määritetyn resurssijoukon nimen
  • säännöllisen lausekkeen, jota verrataan resurssijoukkojen nimiin (rivit alkavat merkkijonolla "R:")
  • kommentin (rivit alkavat merkillä "#")

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:
  • määritetyn resurssijoukon nimen
  • säännöllisen lausekkeen, jota verrataan resurssijoukkojen nimiin (rivit alkavat merkkijonolla "R:")
  • kommentin (rivit alkavat merkillä "#")

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
 API_USE_SCAN_TYPE_SEVERITY=Error
 API_USE_SCAN_METHOD_SEVERITY=Error
 API_USE_SCAN_FIELD_SEVERITY=Error
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

Esimerkkejä

	<apitooling.apiusescanproblems
		profile="D:\eclipse\3.7\eclipse"
		report="D:\reports\xml"
		apiusescans="D:\APIUseScan\ProductOne,D:\APIUseScan\ProductTwo"
		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. Käyttöetsinnöissä löydetyt tyypit, metodit ja kentät ratkaistaan hakemiston D:\eclipse\3.7\eclipse profiilissa ja puuttuvat raportoidaan. Tehtävä pienentää raportoitavien ongelmien tiedostoryhmien määrää käyttämällä pois suljettavien luetteloa tiedostossa D:\exclude_list_external.txt.

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.

Aiheeseen liittyviä ohjeita

Ohjelmointirajapinnan analyysin Ant-tehtävä
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ä