Ant-Task der API-Tools für Dateigenerierung

Zweck

Diese Task wird ausgeführt, um alle für die API-Tools erforderlichen Dateien in einem binären Produktpaket zu generieren. Die Ausführung dieser Task erfolgt während Eclipse-Builds oder beim Produktpaketexport für alle Projekte mit einer API-Tool-Gattung.

Gegenwärtig wird nur die Datei .api_description erstellt.

Verwendung

Beschreibung

Der Name der Ant-Task ist apitooling.apigeneration. Für ihre Verwendung muss sich die JAR-Datei apitooling-ant.jar im Ant-Klassenpfad befinden.

<apitooling.apigeneration
	projectname="..."
	project="..."
	binary="..."
	target="..."
	debug="..."
/>

Parameter

Attribut Beschreibung Erforderlich
projectname Gibt den Projektnamen an. Ja
project Gibt die Projektposition an.

Dies ist der Ordner, der alle Quellendateien für das angegebene Projekt enthält.

Die Position wird durch einen absoluten Pfad angegeben.
Ja
binary Gibt die binären Positionen an.

Dies ist eine Liste von Ordnern oder JAR-Dateien, die alle Klassendateien (Dateierweiterung '.class') für das angegebene Projekt enthalten. Die Listenelemente werden durch das Pfadtrennzeichen der Plattform getrennt. Jeder Eintrag muss vorhanden sein.

Die einzelnen Angaben müssen jeweils mit absoluten Pfaden erfolgen.
Ja
target Gibt die Zielposition an.

Dies ist der Ordner, in dem die generierten Dateien generiert werden.

Die Position wird durch einen absoluten Pfad angegeben.
Ja
debug Gibt den Wert für die Debugfunktion an.

Folgende Werte sind möglich: true, false
Der Standardwert ist false.
Nein
extraManifests Gibt die Positionen der zusätzlichen Manifestdateien an.

Dies ist eine Liste mit den Positionen von zusätzlichen MANIFEST.MF-Dateien, mit der weitere API-Pakete zum Scannen angegeben werden können. Die Listenelemente werden durch das Pfadtrennzeichen der Plattform getrennt. Jeder Eintrag muss vorhanden sein.

Ist der Pfad nicht absolut, wird er relativ zum aktuellen Arbeitsverzeichnis aufgelöst.

Anstelle einer Datei MANIFEST.MF können JAR-Dateien angegeben werden. Wird eine JAR-Datei angegeben, wird ihre Datei MANIFEST.MF gelesen, sofern vorhanden.
Nein
extraSourceLocations Gibt die Positionen der zusätzlichen Quellen an.

Dies ist eine Liste mit den Positionen von Quellendateien, die gescannt werden. Die Listenelemente werden durch das Pfadtrennzeichen der Plattform getrennt. Jeder Eintrag muss vorhanden sein.

Die einzelnen Angaben müssen jeweils mit absoluten Pfaden erfolgen.
Nein
allowNonapiproject Ermöglicht die Ausführung der Task für Projekte, für die die API-Tools nicht aktiviert sind.

Wenn diese Task für ein Projekt ausgeführt wird, das keine API-Tool-Gattung hat, wird keine Datei 'api_description' erstellt, da angenommen wird, dass das Projekt API-Tools nicht unterstützt. In einigen Fällen besteht die Notwendigkeit, die Beschreibungsdatei für Projekte ohne die Gattung zu generieren. Wenn dieser Parameter auf den Wert 'true' gesetzt wird, führt die Task keine Gattungsüberprüfung aus.
Nein

Beispiele

 <apitooling.apigeneration
  projectname="org.eclipse.jdt.core_3.5.0.v_927"
  project="d:\eclipse\org.eclipse.jdt.core"

  binary="d:\eclipse\org.eclipse.jdt.core\bin;d:\eclipse\org.eclipse.jdt.core\antbin"
  target="d:\plugins\org.eclipse.jdt.core"
  debug="true"
 />

Hierdurch wird auf Grundlage der in d:\eclipse\org.eclipse.jdt.core enthaltenen Quelle und den in d:\eclipse\org.eclipse.jdt.core\bin enthaltenen Klassendateien (Dateierweiterung '.class') eine Datei mit dem Namen .api_description im Ordner d:\plugins\org.eclipse.jdt.core erstellt.

Zugehörige Referenzinformationen

Ant-Task für Analyse
Ant-Task für API-Freeze
Ant-Task für API-Verwendung
Ant-Task für Analyseberichtskonvertierung
Ant-Task für API-Freeze-Berichtskonvertierung
Ant-Task für eingestellte API-Unterstützung
Ant-Task für Konvertierung von Berichten zu eingestellter API-Unterstützung
Ant-Task für API-Verwendungsberichtskonvertierung