Ant-oppgave for migrering av API-bruk

Formål

Denne oppgaven tar en gitt skanning av API-bruk, prøver å behandle den på nytt innenfor en gitt kandidatproduktutgave, og rapporterer eventuelle uløste referanser.

Bruk

Beskrivelse

Navnet på Ant-oppgaven er: apitooling.apimigration. Når den skal brukes, må jar-filen apitooling-ant.jar være i Ant-klassebanen.

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

Parametere

Attributt Beskrivelse Obligatorisk
candidate Dette attributtet oppgir produktet du vil bruke som migreringskandidat.

Det kan være en *.zip-, *.jar-, *.tgz- eller *.tar.gz-fil eller en katalog som tilsvarer installeringsmappen til Eclipse. Dette er katalogen hvor du finner den utførbare filen til Eclipse.

Ja
usescan Dette attributtet oppgir produktbruksskanningen du vil sammenlikne med migreringskandidaten.

Bruksskanningen er oppgitt med en absolutt bane til roten for bruksskanningen.
Ja
scopepattern Dette attributtet oppgir mønsteret for regulært uttrykk som brukes til å bygge omfanget av elementer det skal søkes etter referanser fra, på produktstedet.

Mønsteret må være et riktig formatert regulært uttrykk slik det er definert her.
Nei
referencepattern Dette attributtet oppgir mønsteret for regulært uttrykk som brukes til å bygge omfanget av elementer det skal søkes etter referanser til, på produktstedet.

Mønsteret må være et riktig formatert regulært uttrykk slik det er definert her.
Nei
excludelist Velg plasseringen til ekskluderingslisten.

Ekskluderingslisteplasseringen oppgir en tekstfil med en liste over bunter som skal ekskluderes fra analysen. Som standard blir alle bunter i profilen analysert. Attributtene for inkluderings- og ekskluderingsliste kan brukes til å velge bunter som skal inkluderes og ekskluderes. Inkluderingslisten initialiserer settet med bunter som skal analyseres (hvis den er utelatt, blir alle bunter inkludert), og deretter blir ekskluderingslisten brukt. Hver linje i filen oppgir ett av følgende:
  • et bestemt buntnavn
  • et regulært uttrykk som skal sammenliknes med buntnavn (linjer som begynner med "R:")
  • en kommentar (linjer som begynner med '#')

Plasseringen oppgis med en absolutt bane.
Nedenfor finner du et eksempel på en ekskluderingsliste:
# EXCLUDED BUNDLES
R:org\.eclipse\..*\.doc\..*
...
Nei
includelist Angi plasseringen til ekskluderingslisten.

Inkluderingslisteplasseringen oppgir en tekstfil med en liste over bunter som skal inkluderes i analysen. Som standard blir alle bunter i profilen analysert. Attributtene for inkluderings- og ekskluderingsliste kan brukes til å velge bunter som skal inkluderes og ekskluderes. Inkluderingslisten initialiserer settet med bunter som skal analyseres (hvis den er utelatt, blir alle bunter inkludert), og deretter blir ekskluderingslisten brukt. Hver linje i filen oppgir ett av følgende:
  • et bestemt buntnavn
  • et regulært uttrykk som skal sammenliknes med buntnavn (linjer som begynner med "R:")
  • en kommentar (linjer som begynner med '#')

Plasseringen oppgis med en absolutt bane.
Nedenfor finner du et eksempel på en inkluderingsliste:
# INCLUDED BUNDLES
R:org\.eclipse\..*
...
Nei
report Angi utdataplasseringen hvor rapportene skal genereres.

Når du har fullført denne oppgaven, blir rapportene tilgjengelige i en hierarkisk struktur i denne katalogen. Det opprettes en undermappe for hver komponent som blir referert til av en annen bunt. Hver undermappe inneholder en fil som heter [buntnavn].xml. I denne mappen finnes det en annen undermappe (som heter [referansebuntnavn].xml) for hver bunt som refererer til bunten i overmappen. I mappen til referansebunten finnes det en mappe som er én av tre følgende undermapper (API, PRIVATE eller OTHER), og denne mappen inneholder type-, metode- eller feltreferanser av det slaget.

Det skrives to andre spesialfiler til rapportkatalogen. Disse filene heter not_searched.xml og no_apidescription.xml og inneholder henholdsvis informasjon om bunter fra basisen som ikke ble gjennomsøkt etter bruksinformasjon, og de som ikke inneholder *.api_description-filer.

Plasseringen oppgis med en absolutt bane.

Eksempel:
  root
   |
   +-- "not_searched.xml"
   +-- "no_apidescription.xml"
   +-- bundle name with usage
     |
     +--referencing bundle name
      |
      +-- [API or PRIVATE or OTHER]
       |
       +--[type_ or method_ or field_]references.xml
Ja
debug Angi feilsøkingsverdien.

Mulige verdier er true og false
Standardverdien er false.
Nei

Eksempler

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

 />

Dette kjører oppgaven som oppretter *.xml-filer i mappen /eclipse/apimigration/xml. Oppgaven behandler alle referanser med usescan-plasseringen på nytt - definert av det regulære uttrykket .* - mot kandidatproduktet med identifikator som begynner med org.eclipse (definert av det regulære uttrykket org\.eclipse.*). Den bruker ekskluderingslisten D:\exclude_list_external.txt til å redusere antall problemer som rapporteres.

Hvis feilsøking er aktivert, vises feilsøkingssporing i Ant-konsollen.

Beslektet referanse

Ant-oppgave for API-frys
Ant-oppgave for filgenerering
Ant-oppgave for konvertering av analyserapport
Ant-oppgave for konvertering av rapport for API-frys
Ant-oppgave for API-foreldelse
Ant-oppgave for konvertering av rapport for API-foreldelse
Ant-oppgave for konvertering av rapport for API-bruk
Ant-oppgave for konvertering av migreringsrapport for API-bruk