Diese Task führt eine vollständige API-Analyse eines API-Profils relativ zu einer Referenzkonfiguration aus und sucht dabei lediglich nach Membern (Klassen, Felder, Methoden), die veraltet sind und daher nicht weiter unterstützt werden. Als Profil dient der aktuelle Status eines Produkts, das sich in der Entwicklung befindet. Das Profil wird mit einer API-Referenzkonfiguration im Hinblick auf Veränderungen bei eingestellter Unterstützung (Veralterung) (in der Regel mit dem Vorgängerrelease eines Produkts) verglichen.
Der Name der Ant-Task ist apitooling.apideprecation. Für ihre Verwendung muss
sich die JAR-Datei apitooling-ant.jar im Ant-Klassenpfad befinden.
<apitooling.apideprecation
baseline="..."
profile="..."
report="..."
excludelist="..."
includelist="..."
debug="..."
eefile="..."
/>
| Attribut | Beschreibung | Erforderlich |
| baseline |
Dieses Attribut gibt die Position der Referenzkonfiguration an. Es kann eine Datei mit der Dateierweiterung '.zip', '.jar', '.tgz' bzw. '.tar.gz' oder ein Verzeichnis angegeben werden, das dem Eclipse-Installationsordner entspricht. Dies ist das Verzeichnis, in dem sich die ausführbare Eclipse-Datei befindet. Die Position wird mit einem absoluten Pfad angegeben. |
Ja |
| profile |
Dieses Attribut gibt die Position des aktuellen Produkts oder Profils an, das mit der Referenzkonfiguration verglichen werden soll. Es kann eine Datei mit der Dateierweiterung '.zip', '.jar', '.tgz' bzw. '.tar.gz' oder ein Verzeichnis angegeben werden, das dem Eclipse-Installationsordner entspricht. Dies ist das Verzeichnis, in dem sich die ausführbare Eclipse-Datei befindet. Die Position wird mit einem absoluten Pfad angegeben. |
Ja |
| report |
Gibt die Ausgabeposition an, in der die Berichte generiert werden. Nach Abschluss der Task sind die Berichte in diesem Verzeichnis verfügbar. Hierbei wird eine Struktur verwendet, die dem Stammverzeichnis des Filters ähnlich ist. Für jede Komponente, für die Probleme bzw. Fehler gemeldet werden müssen, wird ein Unterordner erstellt. Jeder Unterordner enthält eine Datei namens 'report.xml'. Es wird ein besonderer Ordner namens 'allNonApiBundles' in diesem Ordner erstellt, der ebenfalls eine Datei 'report.xml' enthält. In dieser Datei werden alle Produktpakete aufgelistet, die die Gattung der API-Tools nicht verwenden. Die Position wird mit einem absoluten Pfad angegeben. |
Ja |
| excludelist |
Gibt die Position der Ausschlussliste an. Die Position der Ausschlussliste gibt eine Textdatei an, in der Produktpakete aufgelistet sind, die aus der Analyse ausgeschlossen werden sollen. Standardmäßig werden alle Produktpakete im Profil analysiert. Durch die Einschluss- und Ausschlusslistenattribute können Produktpakete selektiv ein- und ausgeschlossen werden. Darüber hinaus unterstützt diese Task das Auflisten von Membern in der Einschluss- und der Ausschlussliste. Die Einschlussliste gibt die Ausgangsgruppe der zu analysierenden Produktpakete an. (Wenn sie nicht angegeben wird, werden alle Produktpakete und Member eingeschlossen.) Anschließend wird die Ausschlussliste auf diese Gruppe angewendet. Jede Zeile der Datei gibt einen der folgenden Informationstypen an:
Die Position wird mit einem absoluten Pfad angegeben. Das folgende Beispiel zeigt eine Ausschlussliste: # 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 ...Die Ausschlussliste kann reguläre Ausdrücke enthalten, wenn die Zeile mit "R:" beginnt. |
Nein |
| includelist |
Gibt die Position der Einschlussliste an. Die Position der Einschlussliste gibt eine Textdatei an, in der Produktpakete aufgelistet sind, die in die Analyse eingeschlossen werden sollen. Standardmäßig werden alle Produktpakete im Profil analysiert. Durch die Einschluss- und Ausschlusslistenattribute können Produktpakete selektiv ein- und ausgeschlossen werden. Darüber hinaus unterstützt diese Task das Auflisten von Membern in der Einschluss- und der Ausschlussliste. Die Einschlussliste gibt die Ausgangsgruppe der zu analysierenden Produktpakete an. (Wenn sie nicht angegeben wird, werden alle Produktpakete und Member eingeschlossen.) Anschließend wird die Ausschlussliste auf diese Gruppe angewendet. Jede Zeile der Datei gibt einen der folgenden Informationstypen an:
Die Position wird mit einem absoluten Pfad angegeben. Das folgende Beispiel zeigt eine Einschlussliste: # 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 ... |
Nein |
| debug |
Gibt den Wert für die Debugfunktion an. Folgende Werte sind möglich: true, falseDer Standardwert ist false.
|
Nein |
| eefile |
Gibt die Ausführungsumgebungsdatei an, die verwendet werden soll. Standardmäßig wird eine Ausführungsumgebungsdatei verwendet, die einer JavaSE-1.6-Ausführungsumgebung entspricht. Das Format der Datei wird auf dieser Wiki-Seite mit Beschreibungen der Ausführungsumgebung erläutert. Die Datei wird mit einem absoluten Pfad angegeben. |
Nein |
<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"
/>
Hierdurch wird die Task ausgeführt, durch die report.xml-Dateien im Ordner D:\reports\xml erstellt werden. Die Task verwendet die Ausschlussliste, um die Anzahl der zu meldenden Probleme bzw. Fehler zu senken.
Da die Debugfunktion aktiviert ist, wird in der Ant-Konsole die Tracefunktion für die Fehlerbehebung angezeigt.
Ant-Task für API-Freeze
Ant-Task für Dateigenerierung
Ant-Task für API-Verwendung
Ant-Task für Analyseberichtskonvertierung
Ant-Task für API-Freeze-Berichtskonvertierung
Ant-Task für API-Verwendungsberichtskonvertierung
Ant-Task für Konvertierung von Berichten zu eingestellter API-Unterstützung