API eszközök - Fájl előállítása Ant feladat

Cél

A feladat futtatásával előállíthatja az API eszközök által igényelt összes fájlt egy bináris kötegen belül. A feladat az Eclipse összeépítések futtatásakor vagy a köteg exportálásakor minden olyan projekthez lefut, amelyhez be van állítva az API eszközök jelleg.

Jelenleg csak az .api_description fájl kerül létrehozásra.

Használat

Leírás

Az Ant feladat neve: apitooling.apigeneration. A használatához az apitooling-ant.jar fájlnak szerepelnie kell az Ant osztályútvonalon.

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

Paraméterek

Attribútum Leírás Kötelező
projectname Beállítja a projekt nevét Igen
projekt Beállítja a projekt helyét

Ez a mappa tartalmazza az adott projekt összes forrásfájlját.

A helyet abszolút útvonal használatával kell megadni.
Igen
bináris Binárisok helyének beállítása.

Megadja az adott projekt összes .class fájlokat tartalmazó mappáinak és jar fájljainak listáját. Ezeket a platformra jellemző útvonal elválasztó választja el egymástól. Minden bejegyzésnek léteznie kell.

Valamennyit abszolút útvonallal kell megadni.
Igen
cél Beállítja a cél helyet.

Ez az a mappa, ahová az előállított fájlok kerülnek.

A helyet abszolút útvonal használatával kell megadni.
Igen
debug Itt állíthatja be a hibakeresési értéket.

Lehetséges értékek: true vagy false
Az alapértelmezett érték a false.
Nem
extraManifests Beállíthatja további leírófájlok helyét.

Ez olyan további MANIFEST.MF fájlok helyét sorolja fel, amelyek további elemzendő API csomagok megadásához állíthatók be. Ezeket a platformra jellemző útvonal elválasztó választja el egymástól. Minden bejegyzésnek léteznie kell.

Ha az útvonal nem abszolút, akkor az aktuális munkakönyvtárhoz képest relatív útvonalként lesz feloldva.

A MANIFEST.MF fájl helyett megadhatók jar fájlok is. Jar fájl megadása esetén a hozzá tartozó MANIFEST.MF fájl be lesz olvasva (ha van ilyen).
Nem
extraSourceLocations További források helyének beállítása.

A lista további elemzendő forrásfájlok helyét tartalmazza. Ezeket a platformra jellemző útvonal elválasztó választja el egymástól. Minden bejegyzésnek léteznie kell.

Valamennyit abszolút útvonallal kell megadni.
Nem
allowNonapiproject Lehetővé teszi a feladat futtatását olyan projekteken is, amelyek nincsenek felkészítve az API eszközök használatára.

Ha a feladatot egy olyan projekten futtatja, amely nem rendelkezik az API eszközök jelleggel, akkor nem kerül előállításra api_description fájl, mivel a rendszer azt feltételezi, hogy a projekt nem támogatja az API eszközöket. Bizonyos esetekben a jelleggel nem rendelkező projektekhez is szükséges lehet a leírásfájl előállítása. A paraméter beállítása true értékre azt eredményezi, hogy a feladat nem ellenőrzi a jelleget.
Nem

Példák

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

Ez létrehoz egy .api_description nevű a d:\plugins\org.eclipse.jdt.core könyvtárban, a d:\eclipse\org.eclipse.jdt.core helyen található forrás és a d:\eclipse\org.eclipse.jdt.core\bin könyvtárban található .class fájlok alapján.

Kapcsolódó leírások

Elemzés Ant feladat
API befagyasztás Ant feladat
API használat Ant feladat
Elemzés jelentés átalakítása Ant feladat
API befagyasztási jelentés átalakítása Ant feladat
API elavulás Ant feladat
API elavulás jelentés átalakítása Ant feladat
API használat jelentés átalakítása Ant feladat