Ant-oppgave for API-foreldelse

Formål

Denne oppgaven kjører en komplett API-analyse av en API-profil relativt til en basis - den ser bare etter medlemmer (klasser, felt, metoder) som er blitt foreldet / der foreldelse er opphevet. Profilen er den gjeldende tilstanden til et produkt som er under utvikling. Profilen sammenlignes med en API-basis med hensyn til foreldelsesendringer (vanligvis den forrige utgaven av et produkt).

Bruk

Beskrivelse

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

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

Parametere

Attributt Beskrivelse Obligatorisk
baseline Dette attributtet oppgir plasseringen av referansebasisen.

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.

Plasseringen oppgis med en absolutt bane.
Ja
profile Dette attributtet oppgir plasseringen av det gjeldende produktet eller profilen som du vil sammenlikne med referansebasisen.

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.

Plasseringen oppgis med en absolutt bane.
Ja
report Angi utdataplasseringen hvor rapportene skal genereres.

Når du har fullført denne oppgaven, blir rapportene tilgjengelige i denne katalogen i en struktur som likner på filterroten. Det opprettes en undermappe for hver komponent som har problemer som må rapporteres. Hver undermappe inneholder en fil som heter report.xml.

Det opprettes også en spesialmappe som heter allNonApiBundles i denne mappen, og denne mappen inneholder også en fil som heter report.xml. Denne filen inneholder en liste med alle buntene som ikke bruker API-verktøy-naturen.

Plasseringen oppgis med en absolutt bane.
Ja
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. Denne oppgaven støtter dessuten oppføring av medlemmer i inkluderings- og ekskluderingslister. Inkluderingslisten initialiserer settet med bunter og medlemmer som skal analyseres (hvis den er utelatt, blir alle bunter og medlemmer inkludert), og deretter blir ekskluderingslisten brukt. Hver linje i filen oppgir ett av følgende:
  • et bestemt buntnavn
  • et bestemt medlemsnavn
  • et regulært uttrykk som skal sammenliknes med bunt- eller medlemsnavn (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:
 # ECLIPSE MEMBERS
 org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object;
 # DOC BUNDLES
 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
 # NON-ECLIPSE BUNDLES
 com.ibm.icu
 com.jcraft.jsch
 javax.servlet
 javax.servlet.jsp
 ...
Ekskluderingslisten kan inneholde regulære uttrykk hvis linjen begynner med "R:".
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. Denne oppgaven støtter dessuten oppføring av medlemmer i inkluderings- og ekskluderingslister. Inkluderingslisten initialiserer settet med bunter og medlemmer som skal analyseres (hvis den er utelatt, blir alle bunter og medlemmer inkludert), og deretter blir ekskluderingslisten brukt. Hver linje i filen oppgir ett av følgende:
  • et bestemt buntnavn
  • et bestemt medlemsnavn
  • et regulært uttrykk som skal sammenliknes med bunt- eller medlemsnavn (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:
 # ECLIPSE MEMBERS
 org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object;
 # DOC BUNDLES
 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
 # NON-ECLIPSE BUNDLES
 com.ibm.icu
 com.jcraft.jsch
 javax.servlet
 javax.servlet.jsp
 ...
Nei
debug Angi feilsøkingsverdien.

Mulige verdier er true og false
Standardverdien er false.
Nei
eefile Angi utføringsmiljøfilen som skal brukes.

Som standard brukes en utføringsmiljøfil som tilsvarer et JavaSE-1.6-utføringsmiljø.

Formatet til filen er beskrevet på denne wiki-siden.

Filen oppgis med en absolutt bane.
Nei

Eksempler

 <apitooling.apideprecation
  baseline="D:\eclipse\3.4.1\eclipse"
  profile="D:\eclipse-SDK-I20081118-0800-linux-gtk.tar.gz"

  report="D:\reports\xml"
  excludelist="D:\exclude_list_external.txt"
  debug="true"
 />

Dette kjører oppgaven som oppretter report.xml-filer i mappen D:\reports\xml. Den bruker ekskluderingslisten til å redusere antall problemer som rapporteres.

På grunn av at feilsøking er aktivert, vises noe feilsøkingssporing i Ant-konsollen.

Beslektet referanse

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