Ez a feladat egy teljes API elemzést futtat egy profilon egy adott alapsorhoz képest - csak elavult és nem elavult tagokat (osztályok, mezők metódusok) keres. A profil egy fejlesztés alatt álló termék aktuális állapota. A profil elavulási változásainak összehasonlítása egy API alapsorral (általában a termék előző kiadásával) történik.
Az Ant feladat neve: apitooling.apideprecation. A
használatához az apitooling-ant.jar fájlnak szerepelnie kell
az Ant osztályútvonalon.
<apitooling.apideprecation
baseline="..."
profile="..."
report="..."
excludelist="..."
includelist="..."
debug="..."
eefile="..."
/>
| Attribútum | Leírás | Kötelező |
| baseline |
Ez az attribútum adja meg a referencia alapsor helyét. Ez lehet egy .zip, .jar, .tgz, .tar.gz fájl, vagy egy könyvtár, amely megfelel az Eclipse telepítési könyvtárnak. Ez az a könyvtár, ahol az Eclipse végrehajtható fájl található. A helyet abszolút útvonalként kell megadni. |
Igen |
| profile |
Ez az attribútum adja meg az aktuális termék vagy profil
helyét, amelyet össze kíván hasonlítani a referencia alapsorral. Ez lehet egy .zip, .jar, .tgz, .tar.gz fájl, vagy egy könyvtár, amely megfelel az Eclipse telepítési könyvtárnak. Ez az a könyvtár, ahol az Eclipse végrehajtható fájl található. A helyet abszolút útvonalként kell megadni. |
Igen |
| report |
Itt állíthatja be a kimeneti helyet, ahová a jelentések
elő lesznek állítva. A feladat befejeződése után a jelentések ebben a könyvtárban érhetők el, a szűrő gyökéréhez hasonló szerkezetben. Minden olyan komponenshez létrehozásra kerül egy almappa, amelynek jelentett problémái vannak. Minden almappa tartalmaz egy "report.xml" nevű fájlt. A mappában létrejön egy "allNonApiBundles" nevű speciális mappa is, amely ugyancsak tartalmaz egy "report.xml" fájlt. A fájl felsorolja az összes olyan köteget, amelyek nem használják az API eszközök jelleget. A helyet abszolút útvonalként kell megadni. |
Igen |
| excludelist |
Itt állíthatja be a kizárási lista helyét. A kizárási lista helye egy szövegfájlt ad meg, amely az elemzésből kizárandó kötegek listáját tartalmazza. Alapértelmezésben a profilban lévő összes köteg elemezve lesz. A tartalmazási és kizárási lista attribútumok használatával egyenként megadhatja a tartalmazni és kizárni kívánt kötegeket. Továbbá a feladat támogatja tagok felsorolását is a tartalmazási és kizárási listákban. A tartalmazási lista adja meg az elemezni kívánt kötegek és tagok alap készletét (ha nincs megadva, akkor az összes köteg és tag), és ezután kerül alkalmazásra a kizárási lista. A fájl minden sora a következők egyikét adja meg:
A helyet abszolút útvonalként kell megadni. Íme egy példa a kizárási listára: # ECLIPSE TAGOK org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object; # DOC CSOMAGOK 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 # NEM-ECLIPSE CSOMAGOK com.ibm.icu com.jcraft.jsch javax.servlet javax.servlet.jsp ...Ha a sor az "R:" előtaggal kezdődik, a kizárási lista tartalmazhat reguláris kifejezéseket. |
Nem |
| includelist |
Itt állíthatja be a tartalmazási lista helyét. A tartalmazási lista helye egy szövegfájlt ad meg, amely az elemzésbe belefoglalni kívánt kötegek listáját tartalmazza. Alapértelmezésben a profilban lévő összes köteg elemezve lesz. A tartalmazási és kizárási lista attribútumok használatával egyenként megadhatja a tartalmazni és kizárni kívánt kötegeket. Továbbá a feladat támogatja tagok felsorolását is a tartalmazási és kizárási listákban. A tartalmazási lista adja meg az elemezni kívánt kötegek és tagok alap készletét (ha nincs megadva, akkor az összes köteg és tag), és ezután kerül alkalmazásra a kizárási lista. A fájl minden sora a következők egyikét adja meg:
A helyet abszolút útvonalként kell megadni. Íme egy példa a tartalmazási listára: # ECLIPSE TAGOK org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object; # DOC CSOMAGOK 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 # NEM-ECLIPSE CSOMAGOK com.ibm.icu com.jcraft.jsch javax.servlet javax.servlet.jsp ... |
Nem |
| debug |
Itt állíthatja be a hibakeresési értéket. Lehetséges értékek: true vagy falseAz alapértelmezett érték a false.
|
Nem |
| eefile |
Beállíthatja a használandó végrehajtási környezet fájlt. Alapértelmezésben a JavaSE-1.6 végrehajtási környezetnek megfelelő végrehajtási környezet fájl kerül felhasználásra. A fájl formátumának leírását ez a wiki oldal tartalmazza. A fájlt abszolút útvonallal kell megadni. |
Nem |
<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"
/>
Ez lefuttatja a feladatot és létrehozza a report.xml
fájlokat a D:\reports\xml mappában. A jelentendő problémák számának csökkentése érdekében a
kizárási listát fogja használni.
Mivel engedélyezve van a hibakeresés, az Ant konzolon hibakeresési nyomkövetési információk is megjelennek.
API befagyasztás Ant feladat
Fájl előállítása 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 használat jelentés átalakítása Ant feladat
API elavulás jelentés átalakítása Ant feladat