API használati elemzés problémák Ant feladat

Cél

Ez a feladat az API használati elemzéseket egy alapsorhoz viszonyított profilban oldja fel. Jelenti a típusokra, metódusokra és mezőkre mutató referenciákat, amelyek a profilból most hiányoznak.

Használat

Leírás

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

<apitooling.apiusescanproblems
	profile="..."
	report="..."
	apiusescans="..."
	excludelist="..."
	includelist="..."
	preferences="..."
	debug="..."
/>

Paraméterek

Attribútum Leírás Kötelező
profile Az attribútum megadja a jelenlegi termék vagy profil helyét, amelyen az API használati elemzést fel szeretné oldani.

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. 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 helyet abszolút útvonalként kell megadni.
Igen
apiusescans Az attribútum a profil ellenőrzéséhez használt API használati elemzések helyeinek vesszővel elválasztott listáját adja meg.

Ez lehet egy .zip fájl vagy egy könyvtár, amely megfelel az API használati elemzés jelentésnek. Ez az a könyvtár, ahol a használati elemzésben az XML mappát megtalálhatja.
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. A tartalmazási lista adja meg az elemezni kívánt kötegek alap készletét (ha nincs megadva, akkor az összes köteg), é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:
  • egy adott köteg neve
  • egy reguláris kifejezés a kötegnevek egyeztetéséhez (az "R:" kifejezéssel kezdődő sorok)
  • egy megjegyzés (a '#' karakterrel kezdődő sorok)

A helyet abszolút útvonalként kell megadni.
Íme egy példa a kizárási listára:
 # 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
 R:javax\..*
 ...
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. A tartalmazási lista adja meg az elemezni kívánt kötegek alap készletét (ha nincs megadva, akkor az összes köteg), é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:
  • egy adott köteg neve
  • egy reguláris kifejezés a kötegnevek egyeztetéséhez (az "R:" kifejezéssel kezdődő sorok)
  • egy megjegyzés (a '#' karakterrel kezdődő sorok)

A helyet abszolút útvonalként kell megadni.
Íme egy példa a tartalmazási listára:
 # DOC CSOMAGOK
 org.eclipse.jdt.doc.isv
 org.eclipse.jdt.doc.user
 org.eclipse.pde.doc.user
 R:org.eclipse.platform.doc.*
 # NEM-ECLIPSE CSOMAGOK
 com.ibm.icu
 com.jcraft.jsch
 R:javax\..*
 ...
Nem
preferences Itt adhatja meg a feladat beállításait.

A beállítások segítségével konfigurálható a problémák súlyossága. A problémák súlyossága három értéket vehet fel: Ignore (figyelmen kívül hagyás), Warning (figyelmeztetés) vagy Error (hiba). Az észlelt problémák meghatározása az API eszközökben lévő probléma beállítási kulcsoknak megfelelően történik.
A helyet abszolút útvonalként kell megadni. Ha a megadott hely nem létezik, akkor a beállítások nem lesznek konfigurálva.
A '#' karakterrel kezdődő sorok figyelmen kívül maradnak. A beállítási fájl formátuma az alábbihoz hasonló:
 #Thu Nov 20 17:35:06 EST 2008
 API_USE_SCAN_TYPE_SEVERITY=Error
 API_USE_SCAN_METHOD_SEVERITY=Error
 API_USE_SCAN_FIELD_SEVERITY=Error
A kulcsok az org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes helyen találhatók.
Nem
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

Példák

	<apitooling.apiusescanproblems
		profile="D:\eclipse\3.7\eclipse"
		report="D:\reports\xml"
		apiusescans="D:\APIUseScan\ProductOne,D:\APIUseScan\ProductTwo"
		excludelist="D:\exclude_list_external.txt"
		preferences="D:\tests_api\org.eclipse.pde.api.tools.prefs"
		debug="true"
	/>

Ez lefuttatja a feladatot és létrehozza a report.xml fájlokat a D:\reports\xml mappában. A használati elemzésekből származó típusok, metódusok és mezők a D:\eclipse\3.7\eclipse helyen található profilban lesznek feloldva, és a hiányzókat a program jelenti. A kötegek számát, amelyhez a problémákat jelenteni kell, a D:\exclude_list_external.txt fájlban szereplő kizárási lista használatával csökkenti.

A problémák súlyossága a D:\tests_api\org.eclipse.pde.api.tools.prefs helyen megadottaknak megfelelően lesz előállítva.

Mivel engedélyezve van a hibakeresés, az Ant konzolon hibakeresési nyomkövetési információk is megjelennek.

Kapcsolódó leírások

API elemzés Ant feladat
API befagyasztás Ant feladat
Fájl előállítása Ant feladat
API használat Ant feladat
Elemzési 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 Ant feladat
API elavulás jelentés átalakítása Ant feladat