Ant-uppgiften API Use Scan Problems

Ändamål

Uppgiften tolkar API-användningssökningar i förhållande till en basnivå. Den rapporterar referenser till typer, metodeer och fält som nu saknas i profilen.

Användning

Beskrivning

Ant-uppgiftens namn: apitooling.apiusescanproblems. Om den ska kunna användas måste JAR-filen apitooling-ant.jar finnas i Ant-klassökvägen.

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

Parametrar

Attribut Beskrivning Obligatoriskt
profile Attributet anger platsen för aktuell produkt eller produktprofil som API-användningssökningen ska tolkas mot.

Det kan vara en .zip-, .jar-, .tgz-, .tar.gz-fil eller en katalog som motsvarar installationskatalogen för Eclipse. Det är den katalog där alla körbara Eclipse-filer finns.

Platsen anges med en absolut sökväg.
Ja
report Utdataplats där rapporteran skapas.

När uppgiften har slutförts finns rapporterna i den här katalogen. En undermapp skapas för varje komponent som har problem som ska rapporteras. Varje undermapp innehåller en fil med namnet report.xml.

Platsen anges med en absolut sökväg.
Ja
apiusescans Attributet anger en kommaseparerad lista över platser för API-användningssökningar som ska kontrolleras mot profilen.

Det kan vara en zipfil eller en katalog som motsvarar rapporten från API-användningssökningen. Det är den katalog där XML-mappen i användningssökningen finns.
Ja
excludelist Platsen för exkluderingslistan

I exkluderingslistan anges en textfil där de samlingspaket som ska uteslutas från analysen listas. Som standard analyseras alla paket i profilen. Med inkluderings- och exkluderingslistattributen kan du välja vilka paket som ska tas med repektive uteslutas. Inkluderingslistan anger vilka paket som ska analyseras (om den utelämnas tas alla paket med), och sedan tillämpas exkluderingslistan. Varje rad i filen anger antingen:
  • ett specifikt samlingspaketnamn
  • ett reguljärt uttryck som matchas mot paketnamnen (rader som börjar med "R:")
  • en kommentar (rader börjar med #)

Platsen anges med en absolut sökväg.
Följande är ett exempel på en exkluderingslista:
 # 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\..*
 ...
Nej
includelist Platsen för inkluderingsslistan.

I inkluderingslistan anges en textfil där de samlingspaket som ska tas med i analysen listas. Som standard analyseras alla paket i profilen. Med inkluderings- och exkluderingslistattributen kan du välja vilka paket som ska tas med repektive uteslutas. Inkluderingslistan anger vilka paket som ska analyseras (om den utelämnas tas alla paket med), och sedan tillämpas exkluderingslistan. Varje rad i filen anger antingen:
  • ett specifikt samlingspaketnamn
  • ett reguljärt uttryck som matchas mot paketnamnen (rader som börjar med "R:")
  • en kommentar (rader börjar med #)

Platsen anges med en absolut sökväg.
Följande är ett exempel på en inkluderingslista:
 # 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\..*
 ...
Nej
inställningar Ange inställningarna för uppgiften.

Inställningar används till att konfigurera problemallvarlighetsgrader. Problemallvarlighetsgraden kan ha något av följande tre värden: Ignore, Warning eller Error. Vilka problem som upptäcks definieras av motsvarande probleminställningsnycklar i API-verktygen.
Platsen anges med en absolut sökväg. Om platsen inte finns anges inte inställningen.
Rader som börjar med # ignoreras. Formatet på inställningsfilen ser ut så här:
 #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
Nycklarna finns i org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes.
Nej
debug Felsökningsvärdet

Giltiga värden är true och false.
Standardvärdet är false.
Nej

Exempel

	<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"
	/>

Uppgiften som skapar report.xml-filer i mappen D:\reports\xml körs. Typerna, metoderna och fälten från användningssökningarna tolkas i profilen på D:\eclipse\3.7\eclipse och saknade rapporteras. Exkluderingslistan från filen D:\exclude_list_external.txt används till att minska antalet paket för vilka problem rapporteras.

Problemallvarlighetsgraden genereras enligt D:\tests_api\org.eclipse.pde.api.tools.prefs.

Eftersom debug är aktiverat visas vissa felsökningsmeddelanden i Ant-konsolen.

Närliggande referenser

Ant-uppgiften API Analysis
Ant-uppgiften API Freeze
Ant-uppgiften File Generation
Ant-uppgiften API Use
Ant-uppgiften Analysis Report Conversion
Ant-uppgiften API Freeze Report Conversion
Ant-uppgiften API Use Report Conversion
Ant-uppgiften API Deprecation
Ant-uppgiften API Deprecation Report Conversion