Ant-taak API-depreciatie

Doel

Deze taak start de volledige API-analyse van een API-profiel in relatie tot een basislijn. Hiertoe behoren alleen leden (klassen, velden, methoden) die gedeprecieerd / niet-gedeprecieerd zijn. Het profiel is de huidige status van een product in ontwikkeling. Het profiel wordt vergeleken met een API-basislijn op depreciëringswijzigingen (meestal de vorige versie van een product).

Gebruik

Description

De naam van de ant-taak is apitooling.apideprecation. Om deze te kunnen gebruiken, moet het jar-bestand apitooling-ant.jar in het Ant-klassenpad staan.

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

Parameters

Attribute Beschrijving Required
baseline Dit kenmerk geeft de locatie van de desbetreffende basislijn aan.

Dit kan een bestand met de extensie zip, jar, tgz of tar.gz zijn, maar ook een directory die correspondeert met de Eclipse-installatiemap. Dit is de directory waarin het uitvoerbare Eclipse-bestand is opgeslagen.

De locatie wordt opgegeven als absoluut pad.
Ja
profile Dit kenmerk geeft de locatie aan van het huidige product of profiel dat u wilt vergelijken met de basislijn.

Dit kan een bestand met de extensie zip, jar, tgz of tar.gz zijn, maar ook een directory die correspondeert met de Eclipse-installatiemap. Dit is de directory waarin het uitvoerbare Eclipse-bestand is opgeslagen.

De locatie wordt opgegeven als absoluut pad.
Ja
rapport Het instellen van de uitvoerlocatie waar de rapporten worden gegenereerd.

Als de taak is voltooid, zijn de rapporten in deze directory beschikbaar in een boomstructuur die lijkt op filterhoofddirectory. Er wordt een submap gemaakt voor alle componenten waarvoor problemen moeten worden gerapporteerd. Elke submap bevat een bestand met de naam "report.xml".

Er wordt ook een speciale map met de naam "allNonApiBundles" gemaakt in deze map. Deze bevat ook een bestand met de naam "report.xml". In dit bestand staan alle bundels die geen gebruik maken van het API-Toolconcept.

De locatie wordt opgegeven als absoluut pad.
Ja
excludelist Instelling van de locatie van de uitsluitingslijst.

The exclude list location specifies a text file listing bundles to be excluded from the analysis. By default all bundles in the profile are analyzed. The include and exclude list attributes can be used to selectively include and exclude bundles. In addition, this task supports listing members in the include and exclude lists. The include list seeds the set of bundles and members to be analyzed (when omitted, all bundles and members are included), and the exclude list is then applied. Each line of the file specifies one of:
  • a specific bundle name
  • a specific member name
  • a regular expression to match against bundle or member names (lines being with "R:")
  • a comment (lines being with '#')

De locatie wordt opgegeven als absoluut pad.
Following is an example exclude list:
 # 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
 ...
The exclude list can contain regular expressions if the line starts with "R:".
Nee
includelist Set the include list location.

The include list location specifies a text file listing bundles to be included in the analysis. By default all bundles in the profile are analyzed. The include and exclude list attributes can be used to selectively include and exclude bundles. In addition, this task supports listing members in the include and exclude lists. The include list seeds the set of bundles and members to be analyzed (when omitted, all bundles and members are included), and the exclude list is then applied. Each line of the file specifies one of:
  • a specific bundle name
  • a specific member name
  • a regular expression to match against bundle or member names (lines being with "R:")
  • a comment (lines being with '#')

De locatie wordt opgegeven als absoluut pad.
Following is an example include list:
 # 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
 ...
Nee
debug Instellen van de foutopsporingswaarde.

De mogelijke waarden zijn true en false.
De standaardwaarde is false.
Nee
eefile Instellen van de uitvoeringsomgeving.

Standaard wordt een uitvoeringsomgevingsbestand gebruikt dat correspondeert met een JavaSE-1.6-uitvoeringsomgeving.

De indeling van het bestand wordt beschreven in deze wikipagina.

Het bestand wordt opgegeven als absoluut pad.
Nee

Voorbeelden

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

Hiermee wordt de taak gestart voor het maken van report.xml-bestanden in de map D:\reports\xml. De uitsluitingslijst wordt gebruikt om het aantal te rapporteren problemen te verminderen.

Omdat de foutopsporing is ingeschakeld, zijn er enige foutopsporingsgegevens te zien in de ant-console.

Verwante onderwerpen

Ant-taak API blokkeren
Ant-taak Bestanden genereren
Ant-taak API-gebruik
Ant-taak Analyserapport converteren
Ant-taak API-blokkeringsrapport converteren
Ant-taak API-gebruiksrapport converteren
Ant-taak API-depreciëringsrapport converteren