Ohjelmointirajapinnan käytön siirron Ant-tehtävä

Käyttötarkoitus

Tämä tehtävä ottaa ohjelmointirajapinnan määrätyn käyttöetsinnän, yrittää uudelleenselvittää sen käyttäen määrättyä tuotejulkaisuehdokasta ja ilmoittaa viitteet, joiden selvittäminen ei onnistu.

Käyttö

Kuvaus

Ant-tehtävän nimi on apitooling.apimigration. Jar-tiedoston apitooling-ant.jar käyttö edellyttää, että tiedosto on Ant-tehtävän luokkapolussa.

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

Parametrit

Määrite Kuvaus Pakollinen
candidate Tämä määrite määrittää siirtoehdokkaana käytettävän tuotteen.

Sijainti voi olla .zip-, .jar-, .tgz- tai .tar.gz-tiedosto tai Eclipse-järjestelmän asennuskansiota vastaava hakemisto. Eclipse-järjestelmän ohjelmatiedosto on tässä hakemistossa.

Kyllä
usescan Tämä määrite määrittää tuotteen käyttöetsinnän, jota halutaan verrata siirtoehdokkaaseen.

Käyttöetsintä määritetään käyttäen käyttöetsinnän juuren absoluuttista polkua.
Kyllä
scopepattern Tämä määrite määrittää säännöllisen lausekkeen, jolla avulla tuotesijainnista etsittävien viitteiden elementtialue koostetaan.

Mallin on oltava oikein muotoiltu säännöllinen lauseke, joka on määritetty tässä ohjeessa.
Ei
referencepattern Tämä määrite määrittää säännöllisen lausekkeen, jolla etsittävien tuotesijaintiin kohdistuvien viitteiden elementtialue koostetaan.

Mallin on oltava oikein muotoiltu säännöllinen lauseke, joka on määritetty tässä ohjeessa.
Ei
excludelist Määrittää pois suljettavien luettelon sijainnin.

Pois suljettavien luettelon sijainti määrittää tekstitiedoston, joka sisältää luettelon analyysistä pois suljettavista resurssijoukoista. Oletusarvon mukaan kaikki profiilin resurssijoukot analysoidaan. Resurssijoukkoja voidaan valikoivasti sisällyttää ja sulkea pois sisällyttävillä ja pois sulkevilla luettelomääritteillä. Sisällyttävä luettelo määrittää analysoitavat resurssijoukot (jos mitään ehtoa ei ole määritetty, kaikki resurssijoukot otetaan mukaan), ja pois sulkeva luettelo otetaan käyttöön. Tiedoston jokainen rivi määrittää yhden seuraavista:
  • määritetyn resurssijoukon nimen
  • säännöllisen lausekkeen, jota verrataan resurssijoukkojen nimiin (rivit alkavat merkkijonolla "R:")
  • kommentin (rivit alkavat merkillä "#")

Sijainti määritetään absoluuttisen polun avulla.
Seuraavassa on esimerkki pois sulkevasta luettelosta:
# EXCLUDED BUNDLES
R:org\.eclipse\..*\.doc\..*
...
Ei
includelist Määrittää sisällyttävän luettelon sijainnin.

Sisällyttävän luettelon sijainti määrittää tekstitiedoston, joka sisältää luettelon analyysiin sisällytettävistä resurssijoukoista. Oletusarvon mukaan kaikki profiilin resurssijoukot analysoidaan. Resurssijoukkoja voidaan valikoivasti sisällyttää ja sulkea pois sisällyttävillä ja pois sulkevilla luettelomääritteillä. Sisällyttävä luettelo määrittää analysoitavat resurssijoukot (jos mitään ehtoa ei ole määritetty, kaikki resurssijoukot otetaan mukaan), ja pois sulkeva luettelo otetaan käyttöön. Tiedoston jokainen rivi määrittää yhden seuraavista:
  • määritetyn resurssijoukon nimen
  • säännöllisen lausekkeen, jota verrataan resurssijoukkojen nimiin (rivit alkavat merkkijonolla "R:")
  • kommentin (rivit alkavat merkillä "#")

Sijainti määritetään absoluuttisen polun avulla.
Seuraavassa on esimerkki sisällyttävästä luettelosta:
# INCLUDED BUNDLES
R:org\.eclipse\..*
...
Ei
report Määrittää tulostussijainnin, johon raportit luodaan.

Kun tehtävä on valmis, raportit ovat käytettävissä tässä hakemistossa hierarkkisena rakenteena. Järjestelmä luo alikansion kullekin sellaiselle komponentille, johon jokin toinen resurssijoukko viittaa. Jokaisessa alikansiossa on tiedosto nimeltä [bundlename].xml. Tässä kansiossa on toinen alikansio (nimeltä [viittaavan resurssijoukon nimi].xml) kullekin resurssijoukolle, joka viittaa pääkansion resurssijoukkoon. Viittaavan resurssijoukon kansiossa on yksi kolmesta alikansiosta (API, PRIVATE tai OTHER), joka sisältää kyseisen tyypin laji-, metodi- tai kenttäviittaukset.

Järjestelmä kirjoittaa raporttihakemistoon kaksi muuta erityistiedostoa (tiedostot not_searched.xml ja no_apidescription.xml). Niissä on tietoja perustason resurssijoukoista, joista ei ole etsitty käyttötietoja, sekä resurssijoukoista, jotka eivät sisällä .api_description-tiedostoja.

Sijainti määritetään absoluuttisen polun avulla.

Esimerkki:
  juuri
   |
   +-- "not_searched.xml"
   +-- "no_apidescription.xml"
   +-- käytettävän resurssijoukon nimi
     |
     +--viittaava resurssijoukon nimi
      |
      +-- [API tai PRIVATE tai OTHER]
       |
       +--[type_ tai method_ tai field_]references.xml
Kyllä
vianmääritys Määrittää vianmääritysarvon.

Mahdolliset arvot ovat seuraavat: true, false
Oletusarvo on false.
Ei

Esimerkit

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

 />

Järjestelmä ajaa tehtävän, joka luo *.xml-tiedostot kansioon /eclipse/apimigration/xml. Tehtävä uudelleenselvittää kaikista säännöllisen lausekkeen .* määrittämässä usescan-sijainnissa olevista viitteistä kaikki viittaukset käyttäen tuote-ehdokasta, jonka tunnuksen alku on org.eclipse (määritetään säännöllisellä lausekkeella org\.eclipse.*). Tehtävä pienentää raportoitavien ongelmien määrää käyttämällä pois suljettavien luetteloa D:\exclude_list_external.txt.

Jos vianmääritys on käytössä, Ant-konsoliin tulee näkyviin vianmäärityksen jäljitystietoja.

Aiheeseen liittyviä ohjeita

Ohjelmointirajapinnan jäädytyksen Ant-tehtävä
Tiedostojen luonnin Ant-tehtävä
Analyysiraportin muunnon Ant-tehtävä
Ohjelmointirajapinnan jäädytysraportin muunnon Ant-tehtävä
Ohjelmointirajapinnan vanhentumisen Ant-tehtävä
Ohjelmointirajapinnan vanhentumisraportin muunnon Ant-tehtävä
Ohjelmointirajapinnan käyttöraportin muunnon Ant-tehtävä
Ohjelmointirajapinnan käytön siirtoraportin muunnon Ant-tehtävä