Ant-uppgiften API Deprecation

Ändamål

Uppgiften kör en fullständig API-analys av en API-profil relativ till en basnivå, och söker enbart efter medlemmar (klasser, fält, metoder) som har avvecklats eller återtagits. Profilen är det aktuella läget för en produkt under utveckling. Profilen jämförs med en API-basnivå för avvecklingsändringar (oftast den föregående utgåvan av en produkt).

Användning

Beskrivning

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

<apitooling.apideprecation
	baseline="..."
	profile="..."
	report="..."
	excludelist="..."
	includelist="..."
	debug="..."
	eefile="..."
/>

Parametrar

Attribut Beskrivning Obligatoriskt
baseline Attributet anger platsen för refererad basnivå.

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
profile Attributet anger platsen för aktuell produktprofil som ska jämföras med referensbasnivån.

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 med en struktur som liknar filterroten. En undermapp skapas för varje komponent som har problem som ska rapporteras. Varje undermapp innehåller en fil med namnet report.xml.

En mapp med namnet allNonApiBundles skapas också i den här mappen och den innehåller också filen report.xml. Filen listar alla samlingsplaket som inte är av API-verktygsnatur.

Platsen anges med en absolut sökväg.
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. Dessutom kan uppgiften lista medlemmar i inkluderings- och exkluderingslistor. Inkluderingslistan anger vilka paket och medlemmar som ska analyseras (om den utelämnas tas alla paket och medlemmar med), och sedan tillämpas exkluderingslistan. Varje rad i filen anger antingen:
  • ett specifikt samlingspaketnamn
  • ett specifikt medlemsnamn
  • ett reguljärt uttryck som matchas mot paket- eller medlemsnamnen (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:
 # 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
 ...
Exkluderingslistan kan innehålla reguljära uttryck om raden inleds med "R:".
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. Dessutom kan uppgiften lista medlemmar i inkluderings- och exkluderingslistor. Inkluderingslistan anger vilka paket och medlemmar som ska analyseras (om den utelämnas tas alla paket och medlemmar med), och sedan tillämpas exkluderingslistan. Varje rad i filen anger antingen:
  • ett specifikt samlingspaketnamn
  • ett specifikt medlemsnamn
  • ett reguljärt uttryck som matchas mot paket- eller medlemsnamnen (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:
 # 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
 ...
Nej
debug Felsökningsvärdet

Giltiga värden är: true, false
Standardvärdet är false.
Nej
eefile Den körningsmiljöfil som ska användas

Som standard används en körningsmiljöfil som motsvarar körningsmiljön JavaSE-1.6.

Formatet på filen beskrivs på den här wiki-sidan.

Filen anges med en absolut sökväg.
Nej

Exempel

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

Uppgiften som skapar report.xml-filer i mappen D:\reports\xml körs. Uteslutningslistan används för att minska antalet problem att rapportera.

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

Närliggande referenser

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 Report Conversion