Denne oppgaven kontrollerer API-bruksskanninger i en profil relativt til en basis. Den rapporterer referansene til typer, metoder og felt som nå mangler i profilen.
Navnet på Ant-oppgaven er: apitooling.apiusescanproblems. Når den skal brukes, må jar-filen apitooling-ant.jar være i Ant-klassebanen.
<apitooling.apiusescanproblems profile="..." report="..." apiusescans="..." excludelist="..." includelist="..." preferences="..." debug="..." />
| Attributt | Beskrivelse | Obligatorisk |
| profile | Dette attributtet oppgir plasseringen av det gjeldende produktet eller profilen som du vil at API-bruksskanningene skal kontrolleres mot.
Det kan være en *.zip-, *.jar-, *.tgz- eller *.tar.gz-fil eller en katalog som tilsvarer installeringsmappen til Eclipse. Dette er katalogen hvor du finner den utførbare filen til Eclipse. Plasseringen oppgis med en absolutt bane. |
Ja |
| report | Angi utdataplasseringen hvor rapportene skal genereres.
Når du har fullført denne oppgaven, blir rapportene tilgjengelige i denne katalogen. Det opprettes en undermappe for hver komponent som har problemer som må rapporteres. Hver undermappe inneholder en fil som heter report.xml. Plasseringen oppgis med en absolutt bane. |
Ja |
| apiusescans | Dette attributtet oppgir en kommadelt liste over plasseringer av API-bruksskanninger som du vil kontrollere mot profilen.
Det kan være en *.zip-fil eller en katalog som tilsvarer API-bruksskanningsrapporten. Dette er katalogen hvor du finner XML-mappen i bruksskanningen. |
Ja |
| excludelist | Velg plasseringen til ekskluderingslisten.
Ekskluderingslisteplasseringen oppgir en tekstfil med en liste over bunter som skal ekskluderes fra analysen. Som standard blir alle bunter i profilen analysert. Attributtene for inkluderings- og ekskluderingsliste kan brukes til å velge bunter som skal inkluderes og ekskluderes. Inkluderingslisten initialiserer settet med bunter som skal analyseres (hvis den er utelatt, blir alle bunter inkludert), og deretter blir ekskluderingslisten brukt. Hver linje i filen oppgir ett av følgende:
Plasseringen oppgis med en absolutt bane. Nedenfor finner du et eksempel på en ekskluderingsliste: # 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\..* ... |
Nei |
| includelist | Angi plasseringen til ekskluderingslisten.
Inkluderingslisteplasseringen oppgir en tekstfil med en liste over bunter som skal inkluderes i analysen. Som standard blir alle bunter i profilen analysert. Attributtene for inkluderings- og ekskluderingsliste kan brukes til å velge bunter som skal inkluderes og ekskluderes. Inkluderingslisten initialiserer settet med bunter som skal analyseres (hvis den er utelatt, blir alle bunter inkludert), og deretter blir ekskluderingslisten brukt. Hver linje i filen oppgir ett av følgende:
Plasseringen oppgis med en absolutt bane. Nedenfor finner du et eksempel på en inkluderingsliste: # 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\..* ... |
Nei |
| preferences | Definer preferansene for oppgaven.
Preferansene brukes til å konfigurere alvorsgraden til problemene. Alvorsgraden til problemene har tre mulige verdier: Ignorer, Advarsel eller Feil. Settet med problemer som blir funnet, defineres av tilhørende problempreferansenøkler i API-verktøy. Plasseringen oppgis med en absolutt bane. Hvis den angitte plasseringen ikke eksisterer, blir ikke preferansene definert. Linjer som begynner med #, blir ignorert. Formatet på preferansefilen er slik: #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=ErrorDu finner nøklene i org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes. |
Nei |
| debug | Angi feilsøkingsverdien.
Mulige verdier er true og false
Standardverdien er false.
|
Nei |
<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" />
Dette kjører oppgaven som oppretter report.xml-filer i mappen D:\reports\xml. Typene, metodene og feltene fra bruksskanningene blir
kontrollert i profilen på D:\eclipse\3.7\eclipse, og de som mangler blir rapportert.
Oppgaven bruker ekskluderingslisten fra filen D:\exclude_list_external.txt til å redusere antall bunter som den skal rapportere problemer for.
Alvorsgradene til problemene genereres slik det er oppgitt i D:\tests_api\org.eclipse.pde.api.tools.prefs.
På grunn av at feilsøking er aktivert, vises noe feilsøkingssporing i Ant-konsollen.

Ant-oppgave for API-analyse
Ant-oppgave for API-frys
Ant-oppgave for filgenerering
Ant-oppgave for API-bruk
Ant-oppgave for konvertering av analyserapport
Ant-oppgave for konvertering av rapport for API-frys
Ant-oppgave for konvertering av rapport for API-bruk
Ant-oppgave for API-foreldelse
Ant-oppgave for konvertering av rapport for API-foreldelse