API befagyasztás Ant feladat

Cél

Ez a feladat egy API alapsorhoz képest azonosítja a hozzáadott, módosított vagy eltávolított API-kat. A feladat célja annak érvényesítése, hogy egy API befagyasztása után nem történnek API módosítások.

Használat

Leírás

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

<apitooling.apifreeze
	baseline="..."
	profile="..."
	report="..."
	excludelist="..."
	includelist="..."
	debug="..."
	eefile="..."
/>

Paraméterek

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 az előállítandó jelentésfájl nevét.

A megadáshoz abszolút útvonalat kell használni.
Ez csak egy fájl helye lehet, nem könyvtáré.
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:
  • egy adott köteg neve
  • egy adott tag neve
  • egy reguláris kifejezés a köteg- vagy tagnevek 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:
# ECLIPSE TAGOK
org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object;
# ECLIPSE CSOMAGOK
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_ERROR
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_WARNING
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_ELCL_COLLAPSEALL
# NEM-ECLIPSE CSOMAGOK
com.ibm.icu
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. 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:
  • egy adott köteg neve
  • egy adott tag neve
  • egy reguláris kifejezés a köteg- vagy tagnevek 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:
# ECLIPSE TAGOK
org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object;
# ECLIPSE CSOMAGOK
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_ERROR
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_WARNING
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_ELCL_COLLAPSEALL
# NEM-ECLIPSE CSOMAGOK
com.ibm.icu
R:javax\..*
...
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
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

Példák

	<apitooling.apifreeze
		baseline="D:\eclipse\3.4.1\eclipse"
		profile="D:\eclipse-SDK-I20081118-0800-linux-gtk.tar.gz"
		report="D:\report\report.xml"
		excludelist="D:\exclude_list.txt"
		debug="true"
	/>

Ez lefuttatja a feladatot és létrehozza a report.xml fájt a D:\reports mappában. A jelentendő problémák számának csökkentése érdekében a D:\exclude_list_external.txt fájl által meghatározott 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.

Kapcsolódó leírás

Elemzé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 elavulás Ant feladat
API elavulás jelentés átalakítása Ant feladat
API használat jelentés átalakítása Ant feladat