API használat átállítás Ant feladat

Cél

Ez a feladat egy megadott API használat elemzést fogad és megpróbálja újrafeloldani azt egy megadott termékkiadás jelöltön belül, és jelenti a feloldatlan referenciákat.

Használat

Leírás

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

 <apitooling.apimigration
	candidate="..."
	usescan="..."
	scopepattern="..."
	referencepattern="..."
	excludelist="..."
	includelist="..."
	report="..."
	debug="..."
 />

Paraméterek

Attribútum Leírás Kötelező
candidate Ez az attribútum adja meg az átállítási jelöltként használandó terméket.

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ó.

Igen
usescan Ez az attribútum adja meg a terméket, melynek használati elemzését össze kívánja hasonlítani az átállítási jelölttel.

A usescan attribútum értékét a használati elemzés gyökerének abszolút útvonalaként kell megadni.
Igen
scopepattern Ez az attribútum határozza meg a reguláris kifejezést, amely a termék helyen található elemekből származó referenciák keresésének hatókörét állítja össze.

A mintáknak jól formázott reguláris kifejezéseknek kell lenniük (meghatározás itt).
Nem
referencepattern Beállítja a reguláris kifejezést, amely a termék helyen található elemekre mutató referenciák keresésének hatókörét állítja össze.

A mintáknak jól formázott reguláris kifejezéseknek kell lenniük (meghatározás itt).
Nem
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:
# KIZÁRT KÖTEGEK
R:org\.eclipse\..*\.doc\..*
...
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:
# TARTALMAZOTT KÖTEGEK
R:org\.eclipse\..*
...
Nem
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, egy hierarchikus szerkezetben. Minden olyan komponenshez létrehozásra kerül egy almappa, amelyre egy másik köteg hivatkozik. Minden almappa tartalmaz egy "[kötegnév].xml" nevű fájlt. A mappán belül van egy másik almappa, melynek neve "[hivatkozó köteg neve].xml", minden olyan köteghez, amely hivatkozik a tartalmazó mappa kötegére. A hivatkozó köteg mappáján belül szerepel az API, PRIVATE vagy OTHER almappák egyike, amely az adott fajtájú típus-, metódus- vagy mezőhivatkozásokat tartalmazza.

A jelentés könyvtárba két másik speciális fájl is kerül (a "not_searched.xml" és a "no_apidescription.xml"), amelyek az alapsorban szereplő azon kötegek információit tartalmazzák, amelyeken az Ant feladat nem végzett használati információkra vonatkozó keresést, valamint azokat, amelyekben nem található .api_description fájl.

A helyet abszolút útvonalként kell megadni.

Például:
  gyökér
   |
   +-- "not_searched.xml"
   +-- "no_apidescription.xml"
   +-- kötegnév használattal
     |
     +--hivatkozó köteg neve
      |
      +-- [API vagy PRIVATE vagy OTHER]
       |
       +--[type_ vagy method_ vagy field_]references.xml
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

Példák

 <apitooling.apimigration
  candidate="/eclipse/sdk3.5"
  usescan="/eclipse/scans/sdk3.4"

  scopepattern=".*"
  referencepattern="org\.eclipse.*"
  excludelist="D:\exclude_list_external.txt"
  report="/eclipse/apimigration/xml"
  debug="true"

 />

Ez lefuttatja a feladatot és az /eclipse/apimigration/xml mappán belül létrehozza a *.xml fájlokat. A feladat újra fel fogja oldani a usescan attribútumban szereplő helyen - a .* reguláris kifejezés határozza meg - található összes referenciát az org.eclipse kezdetű (az org\.eclipse.* reguláris kifejezés határozza meg) azonosítójú jelölt termékekhez képest. 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.

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